ctools
2.0.0
|
Base class for likelihood tools. More...
#include <ctlikelihood.hpp>
Public Member Functions | |
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... | |
ctlikelihood & | operator= (const ctlikelihood &app) |
Assignment operator. More... | |
virtual void | clear (void)=0 |
virtual void | process (void)=0 |
virtual void | save (void)=0 |
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... | |
ctobservation & | operator= (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... | |
ctool & | operator= (const ctool &app) |
Assignment operator. More... | |
virtual void | run (void) |
Run ctool. More... | |
virtual void | execute (void) |
Execute ctool. More... | |
Protected Member Functions | |
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 >iname, 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 | |
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... | |
Base class for likelihood tools.
Definition at line 41 of file ctlikelihood.hpp.
ctlikelihood::ctlikelihood | ( | const std::string & | name, |
const std::string & | version | ||
) |
Name constructor.
[in] | name | Likelihood tool name. |
[in] | version | Likelihood tool version. |
Constructs a likelihood tool from the name
and version
. See the equivalent ctool constructor for details.
Definition at line 59 of file ctlikelihood.cpp.
References init_members().
ctlikelihood::ctlikelihood | ( | const std::string & | name, |
const std::string & | version, | ||
const GApplicationPars & | pars | ||
) |
Application parameters constructor.
[in] | name | Observation tool name. |
[in] | version | Observation tool version. |
[in] | pars | Application parameters. |
Constructs a likelihood tool from the name
, version
and the application parameters pars
. See the equivalent ctool constructor for details.
Definition at line 82 of file ctlikelihood.cpp.
References init_members().
ctlikelihood::ctlikelihood | ( | const std::string & | name, |
const std::string & | version, | ||
int | argc, | ||
char * | argv[] | ||
) |
Command line constructor.
[in] | name | Likelihood tool name. |
[in] | version | Likelihood tool version. |
[in] | argc | Number of arguments in command line. |
[in] | argv | Array of command line arguments. |
Constructs a likelihood tool from the name
, version
and command line arguments. See the equivalent ctool constructor for details.
Definition at line 106 of file ctlikelihood.cpp.
References init_members().
ctlikelihood::ctlikelihood | ( | const std::string & | name, |
const std::string & | version, | ||
const GObservations & | obs | ||
) |
Observations constructor.
[in] | name | Likelihood tool name. |
[in] | version | Likelihood tool version. |
[in] | obs | Observation container. |
Constructs a likelihood tool from the name
, version
and an observation container.
Definition at line 130 of file ctlikelihood.cpp.
References init_members().
ctlikelihood::ctlikelihood | ( | const ctlikelihood & | app | ) |
Copy constructor.
[in] | app | Likelihood tool. |
Constructs an instance of a likelihood tool by copying information from another likelihood tool.
Definition at line 151 of file ctlikelihood.cpp.
References copy_members(), and init_members().
|
virtual |
Destructor.
Destructs the likelihood tool.
Definition at line 169 of file ctlikelihood.cpp.
References free_members().
|
pure virtual |
Implements ctobservation.
Implemented in ctbutterfly, cttsmap, ctulimit, ctool_like, cterror, and ctlike.
|
protected |
Copy class members.
[in] | app | Likelihood tool. |
Definition at line 351 of file ctlikelihood.cpp.
References m_opt.
Referenced by ctlikelihood(), and operator=().
|
protected |
Evaluates the log-likelihood function.
[in] | par | Model parameter |
[in] | value | Model parameter factor value |
Evaluates the log-likelihood function at a given value
.
Definition at line 271 of file ctlikelihood.cpp.
References G_EVALUATE, ctobservation::m_obs, and m_opt.
Referenced by cterror::error_bisection(), ctulimit::get_parameter_brackets(), and ctulimit::ulimit_bisection().
|
protected |
Delete class members.
Definition at line 364 of file ctlikelihood.cpp.
Referenced by cterror::clear(), ctlike::clear(), ctool_like::clear(), ctulimit::clear(), ctbutterfly::clear(), cttsmap::clear(), operator=(), and ~ctlikelihood().
|
protected |
Initialise class members.
Definition at line 323 of file ctlikelihood.cpp.
References m_opt.
Referenced by cterror::clear(), ctlike::clear(), ctool_like::clear(), ctulimit::clear(), ctbutterfly::clear(), cttsmap::clear(), ctlikelihood(), and operator=().
ctlikelihood & ctlikelihood::operator= | ( | const ctlikelihood & | app | ) |
Assignment operator.
[in] | app | Likelihood tool. |
Assigns a likelihood tool.
Definition at line 193 of file ctlikelihood.cpp.
References copy_members(), free_members(), init_members(), and ctobservation::operator=().
Referenced by cterror::operator=(), ctlike::operator=(), ctool_like::operator=(), ctulimit::operator=(), ctbutterfly::operator=(), and cttsmap::operator=().
void ctlikelihood::opt | ( | const GOptimizer * | opt | ) |
Set optimizer.
[in] | opt | Pointer to optimizer. |
GException::invalid_argument | Specified optimizer is not of type GOptimizerLM. |
Sets the optimizer. So far only optimizers of type GOptimizerLM are supported. If a different optimizer is specified the method throws an exception.
Definition at line 235 of file ctlikelihood.cpp.
References G_OPT, m_opt, and opt().
Referenced by cscripts.cstsmapsplit.cstsmapsplit::_compute_null_hypothesis().
|
inline |
Return optimizer.
Returns a pointer to the optimizer.
Definition at line 97 of file ctlikelihood.hpp.
References m_opt.
Referenced by cscripts.cstsmapsplit.cstsmapsplit::_compute_null_hypothesis(), opt(), and ctlike::reoptimize_lm().
|
pure virtual |
Implements ctobservation.
Implemented in ctbutterfly, cttsmap, ctulimit, ctool_like, cterror, and ctlike.
|
pure virtual |
Implements ctobservation.
Implemented in ctbutterfly, cttsmap, ctulimit, ctool_like, cterror, and ctlike.
|
protected |
Optimizer.
Definition at line 85 of file ctlikelihood.hpp.
Referenced by copy_members(), evaluate(), cterror::get_parameters(), ctlike::get_parameters(), ctulimit::get_parameters(), ctbutterfly::get_parameters(), init_members(), opt(), ctlike::optimize_lm(), cterror::process(), ctlike::process(), ctulimit::process(), cttsmap::process(), ctbutterfly::process(), ctlike::reoptimize_lm(), and ctlike::xml_result().