GammaLib
2.0.0.dev
|
COMPTEL DRB model fitting class. More...
#include <GCOMModelDRBFitting.hpp>
Public Member Functions | |
GCOMModelDRBFitting (void) | |
Void constructor. More... | |
GCOMModelDRBFitting (const GXmlElement &xml) | |
XML constructor. More... | |
GCOMModelDRBFitting (const GCOMModelDRBFitting &model) | |
Copy constructor. More... | |
virtual | ~GCOMModelDRBFitting (void) |
Destructor. More... | |
virtual GCOMModelDRBFitting & | operator= (const GCOMModelDRBFitting &model) |
Assignment operator. More... | |
virtual void | clear (void) |
Clear instance. More... | |
virtual GCOMModelDRBFitting * | clone (void) const |
Clone instance. More... | |
virtual std::string | classname (void) const |
Return class name. More... | |
virtual std::string | type (void) const |
Return model type. More... | |
virtual bool | is_constant (void) const |
Signals if model is temporally constant. More... | |
virtual double | eval (const GEvent &event, const GObservation &obs, const bool &gradients=false) const |
Evaluate function. More... | |
virtual double | npred (const GEnergy &obsEng, const GTime &obsTime, const GObservation &obs) const |
Return spatially integrated data model. More... | |
virtual GCOMEventCube * | mc (const GObservation &obs, GRan &ran) const |
Return simulated list of events. More... | |
virtual void | read (const GXmlElement &xml) |
Read model from XML element. More... | |
virtual void | write (GXmlElement &xml) const |
Write model into XML element. More... | |
virtual std::string | print (const GChatter &chatter=NORMAL) const |
Print model information. More... | |
Public Member Functions inherited from GModelData | |
GModelData (void) | |
Void constructor. More... | |
GModelData (const GXmlElement &xml) | |
XML constructor. More... | |
GModelData (const GModelData &model) | |
Copy constructor. More... | |
virtual | ~GModelData (void) |
Destructor. More... | |
virtual GModelData & | operator= (const GModelData &model) |
Assignment operator. More... | |
virtual GVector | eval (const GObservation &obs, GMatrixSparse *gradients=NULL) const |
Return model values and gradients. More... | |
Public Member Functions inherited from GModel | |
GModel (void) | |
Void constructor. More... | |
GModel (const GXmlElement &xml) | |
XML constructor. More... | |
GModel (const GModel &model) | |
Copy constructor. More... | |
virtual | ~GModel (void) |
Destructor. More... | |
virtual GModel & | operator= (const GModel &model) |
Assignment operator. More... | |
virtual GModelPar & | operator[] (const int &index) |
Returns reference to model parameter by index. More... | |
virtual const GModelPar & | operator[] (const int &index) const |
Returns reference to model parameter by index (const version) More... | |
virtual GModelPar & | operator[] (const std::string &name) |
Returns reference to model parameter by name. More... | |
virtual const GModelPar & | operator[] (const std::string &name) const |
Returns reference to model parameter by name const version) More... | |
int | size (void) const |
Return number of parameters in model. More... | |
int | scales (void) const |
Return number of scale parameters in model. More... | |
GModelPar & | at (const int &index) |
Returns reference to model parameter by index. More... | |
const GModelPar & | at (const int &index) const |
Returns reference to model parameter by index (const version) More... | |
bool | has_par (const std::string &name) const |
Checks if parameter name exists. More... | |
bool | has_scales (void) const |
Signals that model has scales. More... | |
const std::string & | name (void) const |
Return parameter name. More... | |
void | name (const std::string &name) |
Set parameter name. More... | |
const double & | ts (void) const |
Return Test Statistic value. More... | |
void | ts (const double &ts) |
Set Test Statistic value. More... | |
const bool & | tscalc (void) const |
Return Test Statistic computation flag. More... | |
void | tscalc (const bool &tscalc) |
Set Test Statistic computation flag. More... | |
const bool & | has_ts (void) const |
Signals that model has Test Statistics value. More... | |
std::string | instruments (void) const |
Returns instruments to which model applies. More... | |
void | instruments (const std::string &instruments) |
Set instruments to which model applies. More... | |
GModelPar & | scale (const int &index) |
Returns reference to scale parameter by index. More... | |
const GModelPar & | scale (const int &index) const |
Returns reference to scale parameter by index (const version) More... | |
GModelPar | scale (const std::string &instrument) const |
Returns model scale factor for a given instrument. More... | |
void | scale (const GModelPar &par) |
Set model scale factor for a given instrument. More... | |
std::string | ids (void) const |
Returns observation identifiers to which model applies. More... | |
void | ids (const std::string &ids) |
Set observation identifiers to which model applies. More... | |
bool | is_valid (const std::string &instruments, const std::string &ids) const |
Verifies if model is valid for a given instrument and identifier. More... | |
const GModelAssociations & | associations (void) const |
Return model associations. More... | |
void | associations (const GModelAssociations &associations) |
Set model associations. More... | |
const bool & | has_eval_indices (void) const |
Signals that parameter indices updated by eval() method were set. More... | |
const std::vector< int > & | eval_indices (void) const |
Return vector of parameter indices updated by eval() method. More... | |
Public Member Functions inherited from GBase | |
virtual | ~GBase (void) |
Destructor. More... | |
Protected Member Functions | |
void | init_members (void) |
Initialise class members. More... | |
void | copy_members (const GCOMModelDRBFitting &model) |
Copy class members. More... | |
void | free_members (void) |
Delete class members. More... | |
void | set_pointers (void) |
Set pointers. More... | |
void | set_cache (void) const |
Set evaluation cache. More... | |
void | update_cache (void) const |
Update evaluation cache. More... | |
Protected Member Functions inherited from GModelData | |
void | init_members (void) |
Initialise class members. More... | |
void | copy_members (const GModelData &model) |
Copy class members. More... | |
void | free_members (void) |
Delete class members. More... | |
Protected Member Functions inherited from GModel | |
void | init_members (void) |
Initialise class members. More... | |
void | copy_members (const GModel &model) |
Copy class members. More... | |
void | free_members (void) |
Delete class members. More... | |
void | read_attributes (const GXmlElement &xml) |
Read model attributes. More... | |
void | write_attributes (GXmlElement &xml) const |
Write model attributes. More... | |
std::string | print_attributes (void) const |
Print model attributes. More... | |
void | read_scales (const GXmlElement &xml) |
Read instrument scales from XML element. More... | |
void | write_scales (GXmlElement &xml) const |
Write instrument scales into XML element. More... | |
Protected Attributes | |
std::vector< GModelPar > | m_phibars |
Node Phibar values. More... | |
std::vector< GModelPar > | m_values |
Node values. More... | |
bool | m_scale |
Model is a scale factor. More... | |
bool | m_fixed |
All Phibar values are fixed. More... | |
std::vector< double > | m_old_phibars |
Old Phibar values. More... | |
GNodeArray | m_nodes |
Phibar node values. More... | |
Protected Attributes inherited from GModel | |
std::string | m_name |
Model name. More... | |
std::vector< std::string > | m_instruments |
Instruments to which model applies. More... | |
std::vector< GModelPar > | m_scales |
Model instrument scale factors. More... | |
std::vector< std::string > | m_ids |
Identifiers to which model applies. More... | |
std::vector< GModelPar * > | m_pars |
Pointers to all model parameters. More... | |
GModelAssociations | m_associations |
Model associations. More... | |
bool | m_has_ts |
Signals if TS is available. More... | |
bool | m_has_tscalc |
Signals if tscalc attribute is available. More... | |
bool | m_tscalc |
Signals if TS should be computed. More... | |
double | m_ts |
Test Statistic of the model. More... | |
bool | m_has_eval_inx |
std::vector< int > | m_eval_inx |
COMPTEL DRB model fitting class.
This class implements a COMPTEL background model that is based on fitting of a DRB model. The model parameters are a set of normalization parameters defined for a given Phibar value, and linear interpolations are performed between these values.
Definition at line 51 of file GCOMModelDRBFitting.hpp.
GCOMModelDRBFitting::GCOMModelDRBFitting | ( | void | ) |
Void constructor.
Constructs an empty COMPTEL DRB fitting model.
Definition at line 70 of file GCOMModelDRBFitting.cpp.
References init_members().
Referenced by clone().
|
explicit |
XML constructor.
[in] | xml | XML element. |
Constructs a COMPTEL DRB fitting model from the information that is found in an XML element. Please refer to the method GCOMModelDRBFitting::read to learn more about the information that is expected in the XML element.
Definition at line 89 of file GCOMModelDRBFitting.cpp.
References init_members(), and read().
GCOMModelDRBFitting::GCOMModelDRBFitting | ( | const GCOMModelDRBFitting & | model | ) |
Copy constructor.
[in] | model | COMPTEL DRB fitting model. |
Constructs a COMPTEL DRB fitting model by copying information from an existing model. Note that the copy is a deep copy, so the original object can be destroyed after the copy without any loss of information.
Definition at line 112 of file GCOMModelDRBFitting.cpp.
References copy_members(), and init_members().
|
virtual |
Destructor.
Destroys a COMPTEL DRB fitting model.
Definition at line 131 of file GCOMModelDRBFitting.cpp.
References free_members().
|
inlinevirtual |
Return class name.
Implements GModelData.
Definition at line 106 of file GCOMModelDRBFitting.hpp.
|
virtual |
Clear instance.
Resets the object to a clean initial state. All information that resided in the object will be lost.
Implements GModelData.
Definition at line 194 of file GCOMModelDRBFitting.cpp.
References free_members(), GModelData::free_members(), GModel::free_members(), init_members(), GModelData::init_members(), and GModel::init_members().
|
virtual |
Clone instance.
Clone a COMPTEL DRB fitting model. Cloning performs a deep copy of the information, so the original object can be destroyed after cloning without any loss of information.
Implements GModelData.
Definition at line 220 of file GCOMModelDRBFitting.cpp.
References GCOMModelDRBFitting().
|
protected |
Copy class members.
[in] | model | Model. |
Definition at line 704 of file GCOMModelDRBFitting.cpp.
References m_fixed, m_nodes, m_old_phibars, m_phibars, m_scale, m_values, and set_pointers().
Referenced by GCOMModelDRBFitting(), and operator=().
|
virtual |
Evaluate function.
[in] | event | Observed event. |
[in] | obs | Observation. |
[in] | gradients | Compute gradients? |
GException::invalid_argument | Observation is not a COMPTEL observation. Event is not a COMPTEL event bin. |
Evaluates the COMPTEL DRB fitting model.
Implements GModelData.
Definition at line 240 of file GCOMModelDRBFitting.cpp.
References GCOMEventBin::dir(), GCOMObservation::drb(), G_EVAL, GCOMEventBin::index(), GNodeArray::inx_left(), GNodeArray::inx_right(), gammalib::is_infinite(), gammalib::is_notanumber(), m_nodes, m_scale, m_values, GCOMDri::map(), GModel::name(), GCOMInstDir::phibar(), GSkyMap::pixels(), GModel::scale(), GNodeArray::set_value(), GCOMEventBin::size(), GModel::size(), update_cache(), GNodeArray::wgt_left(), and GNodeArray::wgt_right().
|
protected |
Delete class members.
Definition at line 727 of file GCOMModelDRBFitting.cpp.
Referenced by clear(), operator=(), and ~GCOMModelDRBFitting().
|
protected |
Initialise class members.
Definition at line 682 of file GCOMModelDRBFitting.cpp.
References GNodeArray::clear(), m_fixed, m_nodes, m_old_phibars, m_phibars, m_scale, and m_values.
Referenced by clear(), GCOMModelDRBFitting(), and operator=().
|
inlinevirtual |
Signals if model is temporally constant.
Signals if the model is temporally constant. By definition, a DRB fitting model is always temporally constant.
Implements GModelData.
Definition at line 136 of file GCOMModelDRBFitting.hpp.
|
virtual |
Return simulated list of events.
[in] | obs | Observation. |
[in] | ran | Random number generator. |
GException::feature_not_implemented | Method is not implemented. |
Draws a sample of events from the COMPTEL DRB fitting model using a Monte Carlo simulation.
Implements GModelData.
Definition at line 419 of file GCOMModelDRBFitting.cpp.
References G_MC.
|
virtual |
Return spatially integrated data model.
[in] | obsEng | Measured event energy. |
[in] | obsTime | Measured event time. |
[in] | obs | Observation. |
GException::feature_not_implemented | Method is not implemented. |
Spatially integrates the data model for a given measured event energy and event time.
Implements GModelData.
Definition at line 388 of file GCOMModelDRBFitting.cpp.
References G_NRED.
|
virtual |
Assignment operator.
[in] | model | COMPTEL DRB fitting model. |
Assigns the information from a COMPTEL DRB fitting model to the actual object. Note that a deep copy of the information is performed, so the original object can be destroyed after the assignment without any loss of information.
Definition at line 158 of file GCOMModelDRBFitting.cpp.
References copy_members(), free_members(), init_members(), and GModelData::operator=().
Print model information.
[in] | chatter | Chattiness (defaults to NORMAL). |
Implements GModelData.
Definition at line 643 of file GCOMModelDRBFitting.cpp.
References GModel::m_pars, m_phibars, gammalib::parformat(), GModel::print_attributes(), SILENT, GModel::size(), and gammalib::str().
|
virtual |
Read model from XML element.
[in] | xml | XML element. |
GException::invalid_value | Model definition requires at least one node. |
Read the COMPTEL DRB fitting model from an XML element.
The model is composed of nodes that define the normalization value as function of Phibar value. The following XML file syntax is expected:
<source name="Background" type="DRBFitting" instrument="COM"> <node> <parameter name="Phibar" .../> <parameter name="Normalization" .../> </node> ... <node> <parameter name="Phibar" .../> <parameter name="Normalization" .../> </node> </source>
Implements GModelData.
Definition at line 459 of file GCOMModelDRBFitting.cpp.
References GXmlNode::element(), GXmlNode::elements(), G_READ, GOptimizerPar::has_grad(), m_phibars, m_values, GOptimizerPar::name(), GModelPar::read(), GModel::read_attributes(), set_cache(), set_pointers(), gammalib::str(), GOptimizerPar::unit(), and gammalib::xml_get_par().
Referenced by GCOMModelDRBFitting().
|
protected |
Set evaluation cache.
Set the evaluation cache for fast computations. The evaluation cache consists of the Phibar values stored in a node array. The evaluation cache is only filled if at least 2 nodes are available. If only a single node is available, the model is considered as a simple scaling factor.
Definition at line 776 of file GCOMModelDRBFitting.cpp.
References GNodeArray::append(), GNodeArray::clear(), m_fixed, m_nodes, m_old_phibars, m_phibars, and m_scale.
Referenced by read().
|
protected |
Set pointers.
Set pointers to all model parameters. The pointers are stored in a vector that is member of the GModel base class.
Definition at line 740 of file GCOMModelDRBFitting.cpp.
References GModel::m_pars, m_phibars, and m_values.
Referenced by copy_members(), and read().
|
inlinevirtual |
Return model type.
Returns the type of the model. The type for a DRB fitting model is "DRBFitting".
Implements GModelData.
Definition at line 121 of file GCOMModelDRBFitting.hpp.
Referenced by write().
|
protected |
Update evaluation cache.
Updates the evaluation cache by computing the changed.
Definition at line 816 of file GCOMModelDRBFitting.cpp.
References m_nodes, m_old_phibars, and m_phibars.
Referenced by eval().
|
virtual |
Write model into XML element.
[in] | xml | XML element. |
GException::model_invalid_spectral | Existing XML element is not of required type |
GException::model_invalid_parnum | Invalid number of model parameters or nodes found in XML element. |
GException::model_invalid_parnames | Invalid model parameter names found in XML element. |
Write the COMPTEL DRB fitting model into an XML element.
The model is composed of nodes that define the normalization value as function of Phibar value. The following XML file syntax is expected:
<source name="Background" type="DRBFitting" instrument="COM"> <node> <parameter name="Phibar" .../> <parameter name="Normalization" .../> </node> ... <node> <parameter name="Phibar" .../> <parameter name="Normalization" .../> </node> </source>
Implements GModelData.
Definition at line 556 of file GCOMModelDRBFitting.cpp.
References GXmlNode::append(), GXmlElement::attribute(), GXmlNode::element(), GXmlNode::elements(), G_WRITE, GModel::instruments(), m_phibars, m_values, GModel::name(), GOptimizerPar::name(), gammalib::str(), type(), GModelPar::write(), GModel::write_attributes(), and gammalib::xml_need_par().
|
mutableprotected |
All Phibar values are fixed.
Definition at line 94 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), init_members(), and set_cache().
|
mutableprotected |
Phibar node values.
Definition at line 96 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), eval(), init_members(), set_cache(), and update_cache().
|
mutableprotected |
Old Phibar values.
Definition at line 95 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), init_members(), set_cache(), and update_cache().
|
protected |
Node Phibar values.
Definition at line 89 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), init_members(), print(), read(), set_cache(), set_pointers(), update_cache(), and write().
|
mutableprotected |
Model is a scale factor.
Definition at line 93 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), eval(), init_members(), and set_cache().
|
protected |
Node values.
Definition at line 90 of file GCOMModelDRBFitting.hpp.
Referenced by copy_members(), eval(), init_members(), read(), set_pointers(), and write().