GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GCTAModelCubeBackground Class Reference

CTA cube background model class. More...

#include <GCTAModelCubeBackground.hpp>

Inheritance diagram for GCTAModelCubeBackground:
GModelData GModel GBase

Public Member Functions

 GCTAModelCubeBackground (void)
 Void constructor. More...
 
 GCTAModelCubeBackground (const GXmlElement &xml)
 XML constructor. More...
 
 GCTAModelCubeBackground (const GModelSpectral &spectral)
 Construct from spectral component. More...
 
 GCTAModelCubeBackground (const GModelSpectral &spectral, const GModelTemporal &temporal)
 Construct from model components. More...
 
 GCTAModelCubeBackground (const GCTAModelCubeBackground &bgd)
 Copy constructor. More...
 
virtual ~GCTAModelCubeBackground (void)
 Destructor. More...
 
virtual GCTAModelCubeBackgroundoperator= (const GCTAModelCubeBackground &model)
 Assignment operator. More...
 
virtual void clear (void)
 Clear CTA cube background model. More...
 
virtual GCTAModelCubeBackgroundclone (void) const
 Clone CTA cube background model. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
virtual std::string type (void) const
 Return data model type. More...
 
virtual bool is_constant (void) const
 Signals if sky model is temporally constant. More...
 
virtual double eval (const GEvent &event, const GObservation &obs, const bool &gradients=false) const
 Return background rate in units of events MeV \(^{-1}\) s \(^{-1}\) sr \(^{-1}\). More...
 
virtual double npred (const GEnergy &obsEng, const GTime &obsTime, const GObservation &obs) const
 Return spatially integrated background rate in units of events MeV \(^{-1}\) s \(^{-1}\). More...
 
virtual GCTAEventListmc (const GObservation &obs, GRan &ran) const
 Return simulated list of events. More...
 
virtual void read (const GXmlElement &xml)
 Read CTA cube background model from XML element. More...
 
virtual void write (GXmlElement &xml) const
 Write CTA cube background model into XML element. More...
 
virtual std::string print (const GChatter &chatter=NORMAL) const
 Print CTA cube background model information. More...
 
GModelSpectralspectral (void) const
 Return spectral model component. More...
 
GModelTemporaltemporal (void) const
 Return temporal model component. More...
 
void spectral (const GModelSpectral *spectral)
 Set spectral model component. More...
 
void temporal (const GModelTemporal *temporal)
 Set temporal model component. 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 GModelDataoperator= (const GModelData &model)
 Assignment operator. 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 GModeloperator= (const GModel &model)
 Assignment operator. More...
 
virtual GModelParoperator[] (const int &index)
 Returns reference to model parameter by index. More...
 
virtual const GModelParoperator[] (const int &index) const
 Returns reference to model parameter by index (const version) More...
 
virtual GModelParoperator[] (const std::string &name)
 Returns reference to model parameter by name. More...
 
virtual const GModelParoperator[] (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...
 
GModelParat (const int &index)
 Returns reference to model parameter by index. More...
 
const GModelParat (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...
 
GModelParscale (const int &index)
 Returns reference to scale parameter by index. More...
 
const GModelParscale (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...
 
- 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 GCTAModelCubeBackground &bgd)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
void set_pointers (void)
 Set pointers. More...
 
bool valid_model (void) const
 Verifies if model has all components. More...
 
GModelSpectralxml_spectral (const GXmlElement &spectral) const
 Return pointer to spectral model from XML element. More...
 
GModelTemporalxml_temporal (const GXmlElement &temporal) const
 Return pointer to temporal model from XML element. 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

GModelSpectralm_spectral
 Spectral model. More...
 
GModelTemporalm_temporal
 Temporal model. More...
 
std::vector< std::string > m_npred_names
 Model names. More...
 
std::vector< GEnergym_npred_energies
 Model energy. More...
 
std::vector< GTimem_npred_times
 Model time. More...
 
std::vector< double > m_npred_values
 Model 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< GModelParm_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...
 
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...
 

Detailed Description

CTA cube background model class.

This class implements a cube background model for CTA.

Definition at line 52 of file GCTAModelCubeBackground.hpp.

Constructor & Destructor Documentation

GCTAModelCubeBackground::GCTAModelCubeBackground ( void  )

Void constructor.

Definition at line 76 of file GCTAModelCubeBackground.cpp.

References init_members().

Referenced by clone().

GCTAModelCubeBackground::GCTAModelCubeBackground ( const GXmlElement xml)
explicit

XML constructor.

Parameters
[in]xmlXML element.

Constructs a CTA cube background model from the information provided by an XML elements (see GCTAModelCubeBackground::read method).

Definition at line 94 of file GCTAModelCubeBackground.cpp.

References init_members(), read(), and set_pointers().

GCTAModelCubeBackground::GCTAModelCubeBackground ( const GModelSpectral spectral)
explicit

Construct from spectral component.

Parameters
[in]spectralSpectral model component.

Constructs a CTA cube background model from a spectral model component. The temporal component is assumed to be constant.

Definition at line 119 of file GCTAModelCubeBackground.cpp.

References GModelTemporalConst::clone(), GModelSpectral::clone(), init_members(), m_spectral, m_temporal, set_pointers(), and temporal().

GCTAModelCubeBackground::GCTAModelCubeBackground ( const GModelSpectral spectral,
const GModelTemporal temporal 
)

Construct from model components.

Parameters
[in]spectralSpectral model component.
[in]temporalTemporal model component.

Constructs a CTA cube background model from a spectral and a temporal component.

Definition at line 149 of file GCTAModelCubeBackground.cpp.

References GModelTemporal::clone(), GModelSpectral::clone(), init_members(), m_spectral, m_temporal, and set_pointers().

GCTAModelCubeBackground::GCTAModelCubeBackground ( const GCTAModelCubeBackground bgd)

Copy constructor.

Parameters
[in]bgdCTA cube background model.

Definition at line 173 of file GCTAModelCubeBackground.cpp.

References copy_members(), and init_members().

GCTAModelCubeBackground::~GCTAModelCubeBackground ( void  )
virtual

Destructor.

Definition at line 190 of file GCTAModelCubeBackground.cpp.

References free_members().

Member Function Documentation

std::string GCTAModelCubeBackground::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GCTAModelCubeBackground").

Implements GModelData.

Definition at line 118 of file GCTAModelCubeBackground.hpp.

void GCTAModelCubeBackground::clear ( void  )
virtual

Clear CTA cube background model.

This method properly resets the CTA cube background model to an initial state.

Implements GModelData.

Definition at line 248 of file GCTAModelCubeBackground.cpp.

References GModelData::free_members(), free_members(), GModelData::init_members(), and init_members().

Referenced by read().

GCTAModelCubeBackground * GCTAModelCubeBackground::clone ( void  ) const
virtual

Clone CTA cube background model.

Returns
Pointer to deep copy of CTA cube background model.

Implements GModelData.

Definition at line 268 of file GCTAModelCubeBackground.cpp.

References GCTAModelCubeBackground().

void GCTAModelCubeBackground::copy_members ( const GCTAModelCubeBackground bgd)
protected

Copy class members.

Parameters
[in]bgdCTA background model.

Definition at line 752 of file GCTAModelCubeBackground.cpp.

References GModelTemporal::clone(), GModelSpectral::clone(), m_npred_energies, m_npred_names, m_npred_times, m_npred_values, m_spectral, m_temporal, and set_pointers().

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

double GCTAModelCubeBackground::eval ( const GEvent event,
const GObservation obs,
const bool &  gradients = false 
) const
virtual

Return background rate in units of events MeV \(^{-1}\) s \(^{-1}\) sr \(^{-1}\).

Parameters
[in]eventObserved event.
[in]obsObservation.
[in]gradientsCompute gradients?
Returns
Background rate (events MeV \(^{-1}\) s \(^{-1}\) sr \(^{-1}\)).

Evaluates the background model. The method returns a real rate, defined as the number of counts per MeV, steradian and ontime.

If the gradients flag is true the method will also set the parameter gradients of the model parameters.

Implements GModelData.

Definition at line 343 of file GCTAModelCubeBackground.cpp.

References GCTAResponseCube::background(), gammalib::cta_dir(), gammalib::cta_rsp_cube(), GEvent::energy(), GModelTemporal::eval(), GModelSpectral::eval(), G_EVAL, GModelTemporal::size(), GModelSpectral::size(), spectral(), temporal(), and GEvent::time().

void GCTAModelCubeBackground::free_members ( void  )
protected

Delete class members.

Definition at line 775 of file GCTAModelCubeBackground.cpp.

References m_spectral, and m_temporal.

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

void GCTAModelCubeBackground::init_members ( void  )
protected

Initialise class members.

Definition at line 730 of file GCTAModelCubeBackground.cpp.

References m_npred_energies, m_npred_names, m_npred_times, m_npred_values, m_spectral, and m_temporal.

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

bool GCTAModelCubeBackground::is_constant ( void  ) const
inlinevirtual

Signals if sky model is temporally constant.

Returns
True if sky model is temporally constant, false otherwise.

Signals if the sky model is temporally constant. A temporally constant model is a model that has a temporal component of type "Constant".

Implements GModelData.

Definition at line 147 of file GCTAModelCubeBackground.hpp.

References m_temporal, and GModelTemporal::type().

GCTAEventList * GCTAModelCubeBackground::mc ( const GObservation obs,
GRan ran 
) const
virtual

Return simulated list of events.

Parameters
[in]obsObservation.
[in]ranRandom number generator.
Returns
Pointer to list of simulated events (needs to be de-allocated by client)
Exceptions
GException::feature_not_implementedSpecified observation is not a CTA observation.

The simulation of an event list from a cube background model is not implemented, hence the method will always throw an exception.

Implements GModelData.

Definition at line 506 of file GCTAModelCubeBackground.cpp.

References G_MC.

double GCTAModelCubeBackground::npred ( const GEnergy obsEng,
const GTime obsTime,
const GObservation obs 
) const
virtual

Return spatially integrated background rate in units of events MeV \(^{-1}\) s \(^{-1}\).

Parameters
[in]obsEngMeasured event energy.
[in]obsTimeMeasured event time.
[in]obsObservation.
Returns
Spatially integrated background rate (events MeV \(^{-1}\) s \(^{-1}\))

Spatially integrates the cube background model for a given measured event energy and event time. The method returns a real rate, defined as the number of counts per MeV and ontime.

Implements GModelData.

Definition at line 410 of file GCTAModelCubeBackground.cpp.

References GCTAResponseCube::background(), gammalib::cta_rsp_cube(), GModelTemporal::eval(), GModelSpectral::eval(), G_NPRED, GObservation::id(), GObservation::instrument(), GCTACubeBackground::integral(), gammalib::is_infinite(), gammalib::is_notanumber(), GEnergy::log10TeV(), m_npred_energies, m_npred_names, m_npred_times, m_npred_values, spectral(), gammalib::str(), temporal(), valid_model(), and gammalib::warning().

GCTAModelCubeBackground & GCTAModelCubeBackground::operator= ( const GCTAModelCubeBackground bgd)
virtual

Assignment operator.

Parameters
[in]bgdCTA cube background model.
Returns
CTA cube background model.

Definition at line 212 of file GCTAModelCubeBackground.cpp.

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

std::string GCTAModelCubeBackground::print ( const GChatter chatter = NORMAL) const
virtual

Print CTA cube background model information.

Parameters
[in]chatterChattiness.
Returns
String containing CTA cube background model information.

Implements GModelData.

Definition at line 670 of file GCTAModelCubeBackground.cpp.

References gammalib::parformat(), GModel::print_attributes(), SILENT, GModelTemporal::size(), GModelSpectral::size(), GModel::size(), spectral(), gammalib::str(), temporal(), and type().

void GCTAModelCubeBackground::read ( const GXmlElement xml)
virtual

Read CTA cube background model from XML element.

Parameters
[in]xmlXML element.

Set up CTA cube background model from the information provided by an XML element. The XML element is expected to have the following structure

<source name="..." type="..." instrument="...">
  <spectrum type="...">
    ...
  </spectrum>
</source>

Optionally, a temporal model may be provided using the following syntax

<source name="..." type="..." instrument="...">
  <spectrum type="...">
    ...
  </spectrum>
  <temporalModel type="...">
    ...
  </temporalModel>
</source>

If no temporal component is found a constant model is assumed.

Implements GModelData.

Definition at line 547 of file GCTAModelCubeBackground.cpp.

References clear(), GModelTemporalConst::clone(), GXmlNode::element(), GXmlNode::elements(), m_spectral, m_temporal, GModel::read_attributes(), set_pointers(), spectral(), temporal(), xml_spectral(), and xml_temporal().

Referenced by GCTAModelCubeBackground().

void GCTAModelCubeBackground::set_pointers ( void  )
protected

Set pointers.

Set pointers to all model parameters. The pointers are stored in a vector that is member of the GModelData base class.

Definition at line 796 of file GCTAModelCubeBackground.cpp.

References GModel::m_pars, GModelTemporal::size(), GModelSpectral::size(), spectral(), and temporal().

Referenced by copy_members(), GCTAModelCubeBackground(), read(), spectral(), and temporal().

GModelSpectral * GCTAModelCubeBackground::spectral ( void  ) const
inline

Return spectral model component.

Returns
Pointer to spectral model component.

Returns a pointer to the spectral model component of the model. The pointer is of type GModelSpectral. Note that a NULL pointer may be returned if the sky model has no spectral model component.

Definition at line 163 of file GCTAModelCubeBackground.hpp.

References m_spectral.

Referenced by gammalib::cta_model_spectral(), eval(), npred(), print(), read(), set_pointers(), valid_model(), and write().

void GCTAModelCubeBackground::spectral ( const GModelSpectral spectral)

Set spectral model component.

Parameters
[in]spectralPointer to spectral model component.

Sets the spectral model component of the model.

Definition at line 281 of file GCTAModelCubeBackground.cpp.

References GModelSpectral::clone(), m_spectral, and set_pointers().

GModelTemporal * GCTAModelCubeBackground::temporal ( void  ) const
inline

Return temporal model component.

Returns
Pointer to temporal model component.

Returns a pointer to the temporal model component of the model. The pointer is of type GModelTemporal. Note that a NULL pointer may be returned if the sky model has no temporal model component.

Definition at line 179 of file GCTAModelCubeBackground.hpp.

References m_temporal.

Referenced by gammalib::cta_model_temporal(), eval(), GCTAModelCubeBackground(), npred(), print(), read(), set_pointers(), valid_model(), and write().

void GCTAModelCubeBackground::temporal ( const GModelTemporal temporal)

Set temporal model component.

Parameters
[in]temporalPointer to temporal model component.

Sets the temporal model component of the model.

Definition at line 308 of file GCTAModelCubeBackground.cpp.

References GModelTemporal::clone(), m_temporal, and set_pointers().

std::string GCTAModelCubeBackground::type ( void  ) const
inlinevirtual

Return data model type.

Returns
Data model type.

Returns the type of the data model.

Implements GModelData.

Definition at line 132 of file GCTAModelCubeBackground.hpp.

Referenced by print().

bool GCTAModelCubeBackground::valid_model ( void  ) const
protected

Verifies if model has all components.

Returns 'true' if models has a spectral and a temporal component. Otherwise returns 'false'.

Definition at line 832 of file GCTAModelCubeBackground.cpp.

References spectral(), and temporal().

Referenced by npred().

void GCTAModelCubeBackground::write ( GXmlElement xml) const
virtual

Write CTA cube background model into XML element.

Parameters
[in]xmlXML element.

Write CTA cube background model information into an XML element. The XML element will have the following structure

<source name="..." type="..." instrument="...">
  <spectrum type="...">
    ...
  </spectrum>
</source>

If the model contains a non-constant temporal model, the temporal component will also be written following the syntax

<source name="..." type="..." instrument="...">
  <spectrum type="...">
    ...
  </spectrum>
  <temporalModel type="...">
    ...
  </temporalModel>
</source>

If no temporal component is found a constant model is assumed.

Implements GModelData.

Definition at line 611 of file GCTAModelCubeBackground.cpp.

References GXmlNode::append(), GXmlElement::attribute(), GXmlNode::element(), GXmlNode::elements(), m_temporal, GModel::name(), spectral(), temporal(), GModelTemporal::type(), GModelTemporal::write(), GModelSpectral::write(), and GModel::write_attributes().

GModelSpectral * GCTAModelCubeBackground::xml_spectral ( const GXmlElement spectral) const
protected

Return pointer to spectral model from XML element.

Parameters
[in]spectralXML element.
Returns
Pointer to spectral model.

Returns pointer to spectral model that is defined in an XML element.

Definition at line 850 of file GCTAModelCubeBackground.cpp.

References GModelSpectralRegistry::alloc().

Referenced by read().

GModelTemporal * GCTAModelCubeBackground::xml_temporal ( const GXmlElement temporal) const
protected

Return pointer to temporal model from XML element.

Parameters
[in]temporalXML element.
Returns
Pointer to temporal model.

Returns pointer to temporal model that is defined in an XML element.

Definition at line 869 of file GCTAModelCubeBackground.cpp.

References GModelTemporalRegistry::alloc().

Referenced by read().

Member Data Documentation

std::vector<GEnergy> GCTAModelCubeBackground::m_npred_energies
mutableprotected

Model energy.

Definition at line 106 of file GCTAModelCubeBackground.hpp.

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

std::vector<std::string> GCTAModelCubeBackground::m_npred_names
mutableprotected

Model names.

Definition at line 105 of file GCTAModelCubeBackground.hpp.

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

std::vector<GTime> GCTAModelCubeBackground::m_npred_times
mutableprotected

Model time.

Definition at line 107 of file GCTAModelCubeBackground.hpp.

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

std::vector<double> GCTAModelCubeBackground::m_npred_values
mutableprotected

Model values.

Definition at line 108 of file GCTAModelCubeBackground.hpp.

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

GModelSpectral* GCTAModelCubeBackground::m_spectral
protected

Spectral model.

Definition at line 101 of file GCTAModelCubeBackground.hpp.

Referenced by copy_members(), free_members(), GCTAModelCubeBackground(), init_members(), read(), and spectral().

GModelTemporal* GCTAModelCubeBackground::m_temporal
protected

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