Abstract temporal model base class. More...

#include <GModelTemporal.hpp>

Inheritance diagram for GModelTemporal:

Public Member Functions
	GModelTemporal (void)
	Void constructor. More...

	GModelTemporal (const GModelTemporal &model)
	Copy constructor. More...

virtual	~GModelTemporal (void)
	Destructor. More...

virtual GModelTemporal &	operator= (const GModelTemporal &model)
	Assignment operator. More...

virtual GModelPar &	operator[] (const int &index)
	Returns model parameter. More...

virtual const GModelPar &	operator[] (const int &index) const
	Returns model parameter (const version) More...

virtual GModelPar &	operator[] (const std::string &name)
	Returns reference to model parameter. More...

virtual const GModelPar &	operator[] (const std::string &name) const
	Returns reference to model parameter (const version) More...

virtual void	clear (void)=0
	Clear object. More...

virtual GModelTemporal *	clone (void) const =0
	Clones object. More...

virtual std::string	classname (void) const =0
	Return class name. More...

virtual std::string	type (void) const =0

virtual double	eval (const GTime &srcTime, const bool &gradients=false) const =0

virtual GTimes	mc (const double &rate, const GTime &tmin, const GTime &tmax, GRan &ran) const =0

virtual void	read (const GXmlElement &xml)=0

virtual void	write (GXmlElement &xml) const =0

virtual std::string	print (const GChatter &chatter=NORMAL) const =0
	Print content of object. More...

GModelPar &	at (const int &index)
	Returns model parameter. More...

const GModelPar &	at (const int &index) const
	Returns model parameter (const version) More...

bool	has_par (const std::string &name) const
	Checks if parameter name exists. More...

int	size (void) const
	Return number of parameters. More...

void	autoscale (void)
	Autoscale parameters. 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 GModelTemporal &model)
	Copy class members. More...

void	free_members (void)
	Delete class members. More...

Protected Attributes
std::vector< GModelPar * >	m_pars
	Parameter pointers. More...

Detailed Description

Abstract temporal model base class.

This class implements the temporal component of the factorised model. The temporal component of the factorised model is supposed to describe the relative variation of the source flux with respect to the mean value that is given by the spectral component. Normally, this model will have a mean value of 1.

Definition at line 51 of file GModelTemporal.hpp.

Constructor & Destructor Documentation

GModelTemporal::GModelTemporal ( void )

Void constructor.

Definition at line 54 of file GModelTemporal.cpp.

References init_members().

GModelTemporal::GModelTemporal ( const GModelTemporal & model )

Copy constructor.

Parameters

[in] model Temporal model.

Definition at line 69 of file GModelTemporal.cpp.

References copy_members(), and init_members().

GModelTemporal::~GModelTemporal ( void )

virtual

Destructor.

Definition at line 85 of file GModelTemporal.cpp.

References free_members().

Member Function Documentation

GModelPar & GModelTemporal::at ( const int & index )

Returns model parameter.

Parameters

[in] index Parameter index [0,...,size()[.

Returns: Model parameter.

Exceptions

GException::out_of_range Parameter index is out of range.

Returns model parameter with index range checking.

Definition at line 205 of file GModelTemporal.cpp.

References G_AT, m_pars, and size().

const GModelPar & GModelTemporal::at ( const int & index ) const

Returns model parameter (const version)

Parameters

[in] index Parameter index [0,...,size()[.

Returns: Model parameter.

Exceptions

GException::out_of_range Parameter index is out of range.

Returns model parameter with index range checking.

Definition at line 228 of file GModelTemporal.cpp.

References G_AT, m_pars, and size().

void GModelTemporal::autoscale ( void )

Autoscale parameters.

Sets the scale factors for all parameters so that the values are unity.

Definition at line 272 of file GModelTemporal.cpp.

References m_pars.

virtual std::string GModelTemporal::classname ( void ) const

pure virtual

Return class name.

Returns: String containing the class name.

Returns the class name for non-abstract classes in a human readable way.

Implements GBase.

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

virtual void GModelTemporal::clear ( void )

pure virtual

Clear object.

Sets the object to a clean initial state. After calling the method the object will be in the same state as it were if an empty instance of the object would have been created.

Implements GBase.

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

virtual GModelTemporal* GModelTemporal::clone ( void ) const

pure virtual

Clones object.

Returns: Pointer to deep copy of object.

Creates a deep copy of the object and returns a pointer to the object.

Implements GBase.

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

Referenced by GCTAModelIrfBackground::copy_members(), GCTAModelAeffBackground::copy_members(), GCTAModelCubeBackground::copy_members(), GCTAModelRadialAcceptance::copy_members(), GCTAModelBackground::copy_members(), GCTAModelSkyCube::copy_members(), GModelSky::copy_members(), GCTAModelAeffBackground::GCTAModelAeffBackground(), GCTAModelBackground::GCTAModelBackground(), GCTAModelCubeBackground::GCTAModelCubeBackground(), GCTAModelRadialAcceptance::GCTAModelRadialAcceptance(), GCTAModelSkyCube::GCTAModelSkyCube(), GModelSky::GModelSky(), GCTAModelIrfBackground::temporal(), GCTAModelAeffBackground::temporal(), GCTAModelCubeBackground::temporal(), GCTAModelRadialAcceptance::temporal(), GCTAModelBackground::temporal(), GCTAModelSkyCube::temporal(), and GModelSky::temporal().

void GModelTemporal::copy_members ( const GModelTemporal & model )

protected

Copy class members.

Parameters

[in] model Temporal model.

Definition at line 310 of file GModelTemporal.cpp.

References m_pars.

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

virtual double GModelTemporal::eval	(	const GTime &	srcTime,
		const bool &	gradients = `false`
	)		const

pure virtual

void GModelTemporal::free_members ( void )

protected

Delete class members.

Definition at line 323 of file GModelTemporal.cpp.

Referenced by GModelTemporalConst::clear(), GModelTemporalLightCurve::clear(), GModelTemporalPhaseCurve::clear(), operator=(), and ~GModelTemporal().

bool GModelTemporal::has_par ( const std::string & name ) const

Checks if parameter name exists.

Parameters

[in] name Parameter name.

Returns: True if parameter with specified name exists.

Searches all parameter names for a match with the specified name. If the specified name has been found, true is returned.

Definition at line 249 of file GModelTemporal.cpp.

References m_pars, and size().

void GModelTemporal::init_members ( void )

protected

Initialise class members.

Definition at line 295 of file GModelTemporal.cpp.

References m_pars.

Referenced by GModelTemporalConst::clear(), GModelTemporalLightCurve::clear(), GModelTemporalPhaseCurve::clear(), GModelTemporal(), and operator=().

virtual GTimes GModelTemporal::mc	(	const double &	rate,
		const GTime &	tmin,
		const GTime &	tmax,
		GRan &	ran
	)		const

pure virtual

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

Referenced by GCTAModelIrfBackground::mc(), GCTAModelAeffBackground::mc(), GCTAModelRadialAcceptance::mc(), GCTAModelBackground::mc(), and GModelSky::mc().

GModelTemporal & GModelTemporal::operator= ( const GModelTemporal & model )

virtual

Assignment operator.

Parameters

[in] model Temporal model.

Returns: Temporal model.

Definition at line 107 of file GModelTemporal.cpp.

References copy_members(), free_members(), and init_members().

Referenced by GModelTemporalConst::operator=(), GModelTemporalLightCurve::operator=(), and GModelTemporalPhaseCurve::operator=().

GModelPar & GModelTemporal::operator[] ( const int & index )

inlinevirtual

Returns model parameter.

Parameters

[in] index Parameter index [0,...,size()-1].

Returns: Model parameter.

Returns model parameter without index range checking.

Definition at line 106 of file GModelTemporal.hpp.

References m_pars.

const GModelPar & GModelTemporal::operator[] ( const int & index ) const

inlinevirtual

Returns model parameter (const version)

Parameters

[in] index Parameter index [0,...,size()-1].

Returns: Model parameter.

Returns model parameter without index range checking.

Definition at line 121 of file GModelTemporal.hpp.

References m_pars.

GModelPar & GModelTemporal::operator[] ( const std::string & name )

virtual

Returns reference to model parameter.

Parameters

[in] name Parameter name.

Exceptions

GException::invalid_argument Parameter with specified name not found.

Definition at line 136 of file GModelTemporal.cpp.

References G_ACCESS, m_pars, and size().

const GModelPar & GModelTemporal::operator[] ( const std::string & name ) const

virtual

Returns reference to model parameter (const version)

Parameters

[in] name Parameter name.

Exceptions

GException::invalid_argument Parameter with specified name not found.

Definition at line 166 of file GModelTemporal.cpp.

References G_ACCESS, m_pars, and size().

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

pure virtual

Print content of object.

Parameters

[in] chatter Chattiness (defaults to NORMAL).

Returns: String containing the content of the object.

Formats the content in a standard way and puts this content in a C++ string that is returned.

Implements GBase.

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

virtual void GModelTemporal::read ( const GXmlElement & xml )

pure virtual

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

Referenced by GModelTemporalRegistry::alloc().

int GModelTemporal::size ( void ) const

inline

Return number of parameters.

Returns: Number of parameters in temporal model component.

Returns the number of parameters in the temporal model component.

Definition at line 135 of file GModelTemporal.hpp.

References m_pars.

Referenced by at(), GResponse::convolve(), GResponse::edisp_kerns::edisp_kerns(), GCTAModelIrfBackground::eval(), GCTAModelAeffBackground::eval(), GCTAModelCubeBackground::eval(), GCTAModelRadialAcceptance::eval(), GCTAModelBackground::eval(), GCTAModelSkyCube::eval(), GResponse::eval_prob(), GResponse::eval_probs(), has_par(), operator[](), GCTAModelIrfBackground::print(), GCTAModelAeffBackground::print(), GModelTemporalConst::print(), GCTAModelCubeBackground::print(), GCTAModelRadialAcceptance::print(), GCTAModelBackground::print(), GModelTemporalLightCurve::print(), GCTAModelSkyCube::print(), GModelTemporalPhaseCurve::print(), GModelSky::print(), GCTAModelIrfBackground::set_pointers(), GCTAModelAeffBackground::set_pointers(), GCTAModelCubeBackground::set_pointers(), GCTAModelRadialAcceptance::set_pointers(), GCTAModelBackground::set_pointers(), GCTAModelSkyCube::set_pointers(), GModelSky::set_pointers(), GModelSky::signal_analytical_gradients(), and GResponse::size_edisp_vector().

virtual std::string GModelTemporal::type ( void ) const

pure virtual

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

Referenced by GModelTemporalRegistry::GModelTemporalRegistry(), GCTAModelIrfBackground::is_constant(), GCTAModelAeffBackground::is_constant(), GCTAModelCubeBackground::is_constant(), GCTAModelRadialAcceptance::is_constant(), GCTAModelBackground::is_constant(), GCTAModelSkyCube::is_constant(), GModelSky::is_constant(), GCTAModelIrfBackground::write(), GCTAModelAeffBackground::write(), GCTAModelCubeBackground::write(), GCTAModelRadialAcceptance::write(), and GCTAModelSkyCube::write().

virtual void GModelTemporal::write ( GXmlElement & xml ) const

pure virtual

Implemented in GModelTemporalPhaseCurve, GModelTemporalLightCurve, and GModelTemporalConst.

Referenced by GCTAModelIrfBackground::write(), GCTAModelAeffBackground::write(), GCTAModelCubeBackground::write(), GCTAModelRadialAcceptance::write(), GCTAModelBackground::write(), GCTAModelSkyCube::write(), and GModelSky::write().

Member Data Documentation

std::vector<GModelPar*> GModelTemporal::m_pars

protected

Parameter pointers.

Definition at line 93 of file GModelTemporal.hpp.

Referenced by at(), autoscale(), GModelTemporalConst::copy_members(), copy_members(), GModelTemporalLightCurve::copy_members(), GModelTemporalPhaseCurve::copy_members(), has_par(), GModelTemporalConst::init_members(), init_members(), GModelTemporalLightCurve::init_members(), GModelTemporalPhaseCurve::init_members(), operator[](), GModelTemporalConst::print(), GModelTemporalLightCurve::print(), GModelTemporalPhaseCurve::print(), and size().

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

include/GModelTemporal.hpp
src/model/GModelTemporal.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation