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

TS map calculation tool. More...

#include <cttsmap.hpp>

Inheritance diagram for cttsmap:
ctlikelihood ctobservation ctool GApplication

Public Member Functions

 cttsmap (void)
 Void constructor. More...
 
 cttsmap (const GObservations &obs)
 Observations constructor. More...
 
 cttsmap (int argc, char *argv[])
 Command line constructor. More...
 
 cttsmap (const cttsmap &app)
 Copy constructor. More...
 
virtual ~cttsmap (void)
 Destructor. More...
 
cttsmapoperator= (const cttsmap &app)
 Assignment operator. More...
 
void clear (void)
 Clear instance. More...
 
void process (void)
 Computes the TS maps. More...
 
void save (void)
 Save maps. More...
 
void publish (const std::string &name="")
 Publish TS map. More...
 
const GSkyMap & tsmap (void) const
 Return TS skymap. More...
 
- Public Member Functions inherited from ctlikelihood
 ctlikelihood (const std::string &name, const std::string &version)
 Name constructor. More...
 
 ctlikelihood (const std::string &name, const std::string &version, const GApplicationPars &pars)
 Application parameters constructor. More...
 
 ctlikelihood (const std::string &name, const std::string &version, int argc, char *argv[])
 Command line constructor. More...
 
 ctlikelihood (const std::string &name, const std::string &version, const GObservations &obs)
 Observations constructor. More...
 
 ctlikelihood (const ctlikelihood &app)
 Copy constructor. More...
 
virtual ~ctlikelihood (void)
 Destructor. More...
 
ctlikelihoodoperator= (const ctlikelihood &app)
 Assignment operator. More...
 
void opt (const GOptimizer *opt)
 Set optimizer. More...
 
const GOptimizer * opt (void) const
 Return optimizer. 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 cttsmap &app)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void get_parameters (void)
 Get application parameters. More...
 
void init_maps (const GSkyMap &map)
 Initialise skymaps. More...
 
- Protected Member Functions inherited from ctlikelihood
double evaluate (GModelPar &par, const double &value)
 Evaluates the log-likelihood function. More...
 
void init_members (void)
 Initialise class members. More...
 
void copy_members (const ctlikelihood &app)
 Copy class members. More...
 
void free_members (void)
 Delete class members. 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

std::string m_srcname
 Name of source which is moved around. More...
 
GFilename m_outmap
 Output TS map file name. More...
 
bool m_apply_edisp
 Apply energy dispersion? More...
 
bool m_publish
 Publish TS map? More...
 
bool m_errors
 Compute and store parameter errors? More...
 
int m_binmin
 Map bin number from which computation should start. More...
 
int m_binmax
 Map bin number where map computation should end. More...
 
double m_logL0
 Likelihood value of null hypothesis. More...
 
GSkyMap m_tsmap
 TS map. More...
 
GSkyMap m_statusmap
 Map of optimizer fit status. More...
 
std::vector< std::string > m_mapnames
 Names of free parameters. More...
 
std::vector< GSkyMap > m_maps
 Sky maps for each free parameter. More...
 
GModel * m_testsource
 Pointer to test source for TS computation. More...
 
- Protected Attributes inherited from ctlikelihood
GOptimizerLM m_opt
 Optimizer. 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

TS map calculation tool.

This class computes a set of maps from any kind of observations:

 - TS map
 - Flux map
 - Map of spectral index

The class operates on predefined observation containers, an individual event list or an observation definition XML file.

During the computation a putative point-like source is moved along a grid of coordinates. The best fit results (TS, flux, index) are stored in maps which are saved in the output FITS files.

Definition at line 55 of file cttsmap.hpp.

Constructor & Destructor Documentation

cttsmap::cttsmap ( void  )

Void constructor.

Constructs an empty cttsmap tool.

Definition at line 54 of file cttsmap.cpp.

References init_members().

cttsmap::cttsmap ( const GObservations &  obs)
explicit

Observations constructor.

param[in] obs Observation container.

Constructs cttsmap tool from an observations container.

Definition at line 71 of file cttsmap.cpp.

References init_members().

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

Command line constructor.

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

Constructs an instance of the cttsmap tool that will parse user parameters that are provided as command line arguments.

Definition at line 91 of file cttsmap.cpp.

References init_members().

cttsmap::cttsmap ( const cttsmap app)

Copy constructor.

Parameters
[in]appApplication.

Definition at line 107 of file cttsmap.cpp.

References copy_members(), and init_members().

cttsmap::~cttsmap ( void  )
virtual

Destructor.

Definition at line 123 of file cttsmap.cpp.

References free_members().

Member Function Documentation

void cttsmap::copy_members ( const cttsmap app)
protected

Copy class members.

Parameters
[in]appApplication.

Definition at line 502 of file cttsmap.cpp.

References m_apply_edisp, m_binmax, m_binmin, m_errors, m_logL0, m_mapnames, m_maps, m_outmap, m_publish, m_srcname, m_statusmap, m_testsource, and m_tsmap.

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

void cttsmap::free_members ( void  )
protected

Delete class members.

Definition at line 532 of file cttsmap.cpp.

References m_testsource.

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

void cttsmap::get_parameters ( void  )
protected

Get application parameters.

Exceptions
GException::invalid_valueTest source has no RA/DEC parameters.

Get all task parameters from parameter file.

Definition at line 553 of file cttsmap.cpp.

References ctool::create_map(), G_GET_PARAMETERS, init_maps(), ctool::log_parameters(), m_apply_edisp, m_binmax, m_binmin, m_errors, m_logL0, ctobservation::m_obs, m_publish, m_srcname, m_testsource, ctool::read_ahead(), ctobservation::set_obs_statistic(), ctool::setup_models(), and ctool::setup_observations().

Referenced by process().

void cttsmap::init_maps ( const GSkyMap &  map)
protected

Initialise skymaps.

Initialises skymaps that will contain map information.

Definition at line 625 of file cttsmap.cpp.

References m_errors, m_mapnames, m_maps, m_statusmap, m_testsource, and m_tsmap.

Referenced by get_parameters().

void cttsmap::init_members ( void  )
protected

Initialise class members.

Definition at line 473 of file cttsmap.cpp.

References m_apply_edisp, m_binmax, m_binmin, m_errors, m_logL0, m_mapnames, m_maps, m_outmap, m_publish, m_srcname, m_statusmap, m_testsource, and m_tsmap.

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

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

Assignment operator.

Parameters
[in]appApplication.
Returns
Application.

Definition at line 145 of file cttsmap.cpp.

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

void cttsmap::process ( void  )
virtual

Computes the TS maps.

This method moves a source along a grid of coordinates and refits the given models including this additional source. The fit parameters of the source and its TS values are filled into respective position in the map.

Implements ctlikelihood.

Definition at line 207 of file cttsmap.cpp.

References get_parameters(), ctool::log_observations(), m_apply_edisp, m_binmax, m_binmin, m_errors, m_logL0, m_mapnames, m_maps, ctobservation::m_obs, ctlikelihood::m_opt, m_publish, m_srcname, m_statusmap, m_testsource, m_tsmap, publish(), ctool::restore_edisp(), and ctool::set_edisp().

void cttsmap::publish ( const std::string &  name = "")

Publish TS map.

Parameters
[in]nameTS map name.

Definition at line 442 of file cttsmap.cpp.

References CTTSMAP_NAME, and m_tsmap.

Referenced by process().

void cttsmap::save ( void  )
virtual

Save maps.

This method saves the TS map and additional maps into a FITS file.

Implements ctlikelihood.

Definition at line 388 of file cttsmap.cpp.

References m_mapnames, m_maps, m_outmap, m_statusmap, and m_tsmap.

const GSkyMap & cttsmap::tsmap ( void  ) const
inline

Return TS skymap.

Returns
Reference to TS skymap

Definition at line 110 of file cttsmap.hpp.

References m_tsmap.

Member Data Documentation

bool cttsmap::m_apply_edisp
protected

Apply energy dispersion?

Definition at line 86 of file cttsmap.hpp.

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

int cttsmap::m_binmax
protected

Map bin number where map computation should end.

Definition at line 92 of file cttsmap.hpp.

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

int cttsmap::m_binmin
protected

Map bin number from which computation should start.

Definition at line 91 of file cttsmap.hpp.

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

bool cttsmap::m_errors
protected

Compute and store parameter errors?

Definition at line 88 of file cttsmap.hpp.

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

double cttsmap::m_logL0
protected

Likelihood value of null hypothesis.

Definition at line 93 of file cttsmap.hpp.

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

std::vector<std::string> cttsmap::m_mapnames
protected

Names of free parameters.

Definition at line 98 of file cttsmap.hpp.

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

std::vector<GSkyMap> cttsmap::m_maps
protected

Sky maps for each free parameter.

Definition at line 99 of file cttsmap.hpp.

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

GFilename cttsmap::m_outmap
protected

Output TS map file name.

Definition at line 85 of file cttsmap.hpp.

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

bool cttsmap::m_publish
protected

Publish TS map?

Definition at line 87 of file cttsmap.hpp.

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

std::string cttsmap::m_srcname
protected

Name of source which is moved around.

Definition at line 84 of file cttsmap.hpp.

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

GSkyMap cttsmap::m_statusmap
protected

Map of optimizer fit status.

Definition at line 97 of file cttsmap.hpp.

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

GModel* cttsmap::m_testsource
protected

Pointer to test source for TS computation.

Definition at line 100 of file cttsmap.hpp.

Referenced by copy_members(), free_members(), get_parameters(), init_maps(), init_members(), and process().

GSkyMap cttsmap::m_tsmap
protected

TS map.

Definition at line 96 of file cttsmap.hpp.

Referenced by copy_members(), init_maps(), init_members(), process(), publish(), save(), and tsmap().


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