ctools  2.0.0
 All Classes Namespaces Files Functions Variables Macros Pages
ctpsfcube Class Reference

PSF cube generation tool. More...

#include <ctpsfcube.hpp>

Inheritance diagram for ctpsfcube:
ctobservation ctool GApplication

Public Member Functions

 ctpsfcube (void)
 Void constructor. More...
 
 ctpsfcube (const GObservations &obs)
 Observations constructor. More...
 
 ctpsfcube (int argc, char *argv[])
 Command line constructor. More...
 
 ctpsfcube (const ctpsfcube &app)
 Copy constructor. More...
 
virtual ~ctpsfcube (void)
 Destructor. More...
 
ctpsfcubeoperator= (const ctpsfcube &app)
 Assignment operator. More...
 
void clear (void)
 Clear ctpsfcube tool. More...
 
void process (void)
 Generate the model map(s) More...
 
void save (void)
 Save PSF cube. More...
 
const GCTACubePsf & psfcube (void) const
 Return PSF cube. More...
 
- Public Member Functions inherited from ctobservation
 ctobservation (const std::string &name, const std::string &version)
 Name constructor. More...
 
 ctobservation (const std::string &name, const std::string &version, const GApplicationPars &pars)
 Application parameters constructor. More...
 
 ctobservation (const std::string &name, const std::string &version, int argc, char *argv[])
 Command line constructor. More...
 
 ctobservation (const std::string &name, const std::string &version, const GObservations &obs)
 Observations constructor. More...
 
 ctobservation (const ctobservation &app)
 Copy constructor. More...
 
virtual ~ctobservation (void)
 Destructor. More...
 
ctobservationoperator= (const ctobservation &app)
 Assignment operator. More...
 
void obs (const GObservations &obs)
 Set observation container. More...
 
const GObservations & obs (void) const
 Return observation container. More...
 
- Public Member Functions inherited from ctool
 ctool (const std::string &name, const std::string &version)
 Name constructor. More...
 
 ctool (const std::string &name, const std::string &version, const GApplicationPars &pars)
 Application parameter constructor. More...
 
 ctool (const std::string &name, const std::string &version, int argc, char *argv[])
 Command line constructor. More...
 
 ctool (const ctool &app)
 Copy constructor. More...
 
virtual ~ctool (void)
 Destructor. More...
 
ctooloperator= (const ctool &app)
 Assignment operator. More...
 
virtual void run (void)
 Run ctool. More...
 
virtual void execute (void)
 Execute ctool. More...
 

Protected Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const ctpsfcube &app)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void get_parameters (void)
 Get application parameters. More...
 
void init_cube (void)
 Initialise PSF cube. More...
 
- Protected Member Functions inherited from ctobservation
GCTAObservation * first_unbinned_observation (void)
 Return first unbinned CTA observation. More...
 
GCTAObservation * next_unbinned_observation (void)
 Return next unbinned CTA observation. More...
 
const GCTAObservation * first_unbinned_observation (void) const
 Return first unbinned CTA observation (const version) More...
 
const GCTAObservation * next_unbinned_observation (void) const
 Return next unbinned CTA observation (const version) More...
 
void read_ogip_keywords (GFitsHDU *hdu) const
 Read OGIP keywords from FITS HDU. More...
 
void write_ogip_keywords (GFitsHDU *hdu) const
 Write OGIP keywords in FITS HDU. More...
 
void set_obs_statistic (const std::string &statistic)
 Set fit statistic for CTA observations. More...
 
void set_obs_bounds ()
 Set observation boundaries for CTA observations. More...
 
void save_events_fits (void)
 Save event list in FITS format. More...
 
void save_events_xml (void)
 Save event list(s) in XML format. More...
 
void init_members (void)
 Initialise class members. More...
 
void copy_members (const ctobservation &app)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
- Protected Member Functions inherited from ctool
void init_members (void)
 Initialise class members. More...
 
void copy_members (const ctool &app)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void sync_pfiles (void)
 Synchronise parameter files. More...
 
const bool & read_ahead (void) const
 Signal whether parameters should be read ahead. More...
 
void setup_observations (GObservations &obs, const bool &response=true, const bool &list=true, const bool &cube=true)
 Setup observation container. More...
 
void setup_models (GObservations &obs, const std::string &name="")
 Setup model container. More...
 
GEbounds create_ebounds (void)
 Create energy boundaries from user parameters. More...
 
GEnergies create_energies (void)
 Create energies from user parameters. More...
 
GSkyMap create_map (const GObservations &obs)
 Create a skymap from user parameters. More...
 
GCTAEventCube create_cube (const GObservations &obs)
 Create a CTA event cube from user parameters. More...
 
GCTAObservation create_cta_obs (void)
 Create a CTA observation from User parameters. More...
 
void require_inobs (const std::string &method)
 Throws exception if inobs parameter is not valid. More...
 
void require_inobs_nolist (const std::string &method)
 
void require_inobs_nocube (const std::string &method)
 Throws exception if inobs parameter is a counts cube. More...
 
GCTARoi get_roi (const GCTAPointing &pnt=GCTAPointing())
 Return RoI from User parameters. More...
 
GEbounds get_ebounds (void)
 Return energy boundaries from User parameters. More...
 
GGti get_gti (const GTimeReference &ref)
 Return Good Time Intervals from User parameter. More...
 
GCTAPointing get_pointing (void)
 Return CTA pointing from User parameters. More...
 
GSkyDir get_skydir (void)
 Return sky direction from User parameters. More...
 
std::string set_outfile_name (const std::string &filename)
 Set output file name. More...
 
bool is_stacked (void)
 Query user parameters for stacked analysis. More...
 
bool is_onoff (void)
 Query user parameters for On/Off analysis. More...
 
void log_parameters (const GChatter &chatter)
 Log application parameters. More...
 
void log_observations (const GChatter &chatter, const GObservations &obs, const std::string &what="Observation")
 Log observation container. More...
 
void log_models (const GChatter &chatter, const GModels &models, const std::string &what="Model")
 Log model container. More...
 
void set_response (GObservations &obs)
 Set response for all CTA observations in container. More...
 
std::vector< bool > set_edisp (GObservations &obs, const bool &edisp) const
 Set energy dispersion to CTA observations. More...
 
void restore_edisp (GObservations &obs, const std::vector< bool > &edisp) const
 Restore energy dispersion flags of CTA observations. More...
 
void set_obs_response (GCTAObservation *obs)
 Set response for CTA observation. More...
 
GObservations get_observations (const bool &get_response=true)
 Get observation container. More...
 
GSkyDir get_mean_pointing (const GObservations &obs)
 Derives mean pointing from CTA observations. More...
 
size_t get_current_rss (void)
 Get current resident set size (physical memory use) in Bytes. More...
 
std::string get_obs_header (const GObservation *obs) const
 Return observation header string. More...
 
GEnergies insert_energy_boundaries (const GEnergies &energies, const GCTAObservation &obs)
 Insert observation energy boundaries into list of energies. More...
 
std::vector< bool > cube_layer_usage (const GEbounds &cube_ebounds, const GEbounds &list_ebounds) const
 Determine the counts cube layer usage. More...
 
std::string get_gtiname (const std::string &filename, const std::string &evtname) const
 Get Good Time Intervals extension name. More...
 
void save_event_list (const GCTAObservation *obs, const std::string &infile, const std::string &evtname, const std::string &gtiname, const std::string &outfile) const
 Save event list into FITS file. More...
 
std::string warn_too_few_energies (const GEnergies &energies) const
 Set warning string if there are too few energies. More...
 
std::string warn_xml_suffix (const GFilename &filename) const
 Set warning string if file has no .xml suffix. More...
 
void provide_help (void) const
 Dump help text in the console. More...
 

Protected Attributes

GFilename m_outcube
 Output PSF cube file name. More...
 
bool m_addbounds
 Add energies at boundaries? More...
 
GChatter m_chatter
 Chattiness. More...
 
GCTACubePsf m_psfcube
 PSF cube. More...
 
- Protected Attributes inherited from ctobservation
GObservations m_obs
 Observation container. More...
 
- Protected Attributes inherited from ctool
bool m_read_ahead
 Read ahead output parameters. More...
 
bool m_use_xml
 Use XML file instead of FITS file for observations. More...
 

Detailed Description

PSF cube generation tool.

Definition at line 44 of file ctpsfcube.hpp.

Constructor & Destructor Documentation

ctpsfcube::ctpsfcube ( void  )

Void constructor.

Definition at line 52 of file ctpsfcube.cpp.

References init_members().

ctpsfcube::ctpsfcube ( const GObservations &  obs)
explicit

Observations constructor.

Parameters
[in]obsObservation container.

This method creates an instance of the class by copying an existing observations container.

Definition at line 70 of file ctpsfcube.cpp.

References init_members().

ctpsfcube::ctpsfcube ( int  argc,
char *  argv[] 
)

Command line constructor.

Parameters
[in]argcNumber of arguments in command line.
[in]argvArray of command line arguments.

Definition at line 88 of file ctpsfcube.cpp.

References init_members().

ctpsfcube::ctpsfcube ( const ctpsfcube app)

Copy constructor.

Parameters
[in]appApplication.

Definition at line 104 of file ctpsfcube.cpp.

References copy_members(), and init_members().

ctpsfcube::~ctpsfcube ( void  )
virtual

Destructor.

Definition at line 120 of file ctpsfcube.cpp.

References free_members().

Member Function Documentation

void ctpsfcube::clear ( void  )
virtual

Clear ctpsfcube tool.

Clears ctpsfcube tool.

Implements ctobservation.

Definition at line 177 of file ctpsfcube.cpp.

References free_members(), ctool::free_members(), ctobservation::free_members(), init_members(), ctool::init_members(), and ctobservation::init_members().

void ctpsfcube::copy_members ( const ctpsfcube app)
protected

Copy class members.

Parameters
[in]appApplication.

Definition at line 301 of file ctpsfcube.cpp.

References m_addbounds, m_chatter, m_outcube, and m_psfcube.

Referenced by ctpsfcube(), and operator=().

void ctpsfcube::free_members ( void  )
protected

Delete class members.

Definition at line 319 of file ctpsfcube.cpp.

Referenced by clear(), operator=(), and ~ctpsfcube().

void ctpsfcube::get_parameters ( void  )
protected

Get application parameters.

Get all task parameters from parameter file or (if required) by querying the user. The parameters are read in the correct order.

Definition at line 332 of file ctpsfcube.cpp.

References ctool::create_cube(), ctool::log_parameters(), m_addbounds, m_chatter, ctobservation::m_obs, m_psfcube, ctool::read_ahead(), and ctool::setup_observations().

Referenced by process().

void ctpsfcube::init_cube ( void  )
protected

Initialise PSF cube.

Initialise the PSF cube.

Definition at line 372 of file ctpsfcube.cpp.

References ctool::insert_energy_boundaries(), m_addbounds, m_chatter, ctobservation::m_obs, and m_psfcube.

Referenced by process().

void ctpsfcube::init_members ( void  )
protected

Initialise class members.

Definition at line 281 of file ctpsfcube.cpp.

References m_addbounds, m_chatter, m_outcube, and m_psfcube.

Referenced by clear(), ctpsfcube(), and operator=().

ctpsfcube & ctpsfcube::operator= ( const ctpsfcube app)

Assignment operator.

Parameters
[in]appApplication.
Returns
Application.

Definition at line 142 of file ctpsfcube.cpp.

References copy_members(), free_members(), init_members(), and ctobservation::operator=().

void ctpsfcube::process ( void  )
virtual

Generate the model map(s)

This method reads the task parameters from the parfile, sets up the observation container, loops over all CTA observations in the container and generates a PSF cube from the CTA observations.

Implements ctobservation.

Definition at line 207 of file ctpsfcube.cpp.

References get_parameters(), init_cube(), ctool::log_observations(), m_chatter, ctobservation::m_obs, and m_psfcube.

const GCTACubePsf & ctpsfcube::psfcube ( void  ) const
inline

Return PSF cube.

Returns
PSF cube

Definition at line 87 of file ctpsfcube.hpp.

References m_psfcube.

void ctpsfcube::save ( void  )
virtual

Save PSF cube.

Saves the PSF cube into a FITS file. A file is only created if the "outcube" parameter is not empty and if a PSF cube has been computed.

Implements ctobservation.

Definition at line 241 of file ctpsfcube.cpp.

References m_outcube, and m_psfcube.

Member Data Documentation

bool ctpsfcube::m_addbounds
protected

Add energies at boundaries?

Definition at line 73 of file ctpsfcube.hpp.

Referenced by copy_members(), get_parameters(), init_cube(), and init_members().

GChatter ctpsfcube::m_chatter
protected

Chattiness.

Definition at line 74 of file ctpsfcube.hpp.

Referenced by copy_members(), get_parameters(), init_cube(), init_members(), and process().

GFilename ctpsfcube::m_outcube
protected

Output PSF cube file name.

Definition at line 72 of file ctpsfcube.hpp.

Referenced by copy_members(), init_members(), and save().

GCTACubePsf ctpsfcube::m_psfcube
protected

PSF cube.

Definition at line 77 of file ctpsfcube.hpp.

Referenced by copy_members(), get_parameters(), init_cube(), init_members(), process(), psfcube(), and save().


The documentation for this class was generated from the following files: