Multiplicative spatial model class. More...

#include <GCTAModelSpatialMultiplicative.hpp>

Inheritance diagram for GCTAModelSpatialMultiplicative:

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

	GCTAModelSpatialMultiplicative (const GXmlElement &xml)
	XML constructor. More...

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

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

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

virtual void	clear (void)
	Clear instance. More...

virtual GCTAModelSpatialMultiplicative *	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 double	eval (const GCTAInstDir &dir, const GEnergy &energy, const GTime &time, const bool &gradients=false) const
	Evaluate function (in units of sr^-1) More...

virtual double	mc_max_value (const GCTAObservation &obs) const
	Return maximum function value for Monte Carlo simulations. 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 multiplicative spatial model information. More...

void	append (const GCTAModelSpatial &spatial, const std::string &name="")
	Append spatial component. More...

int	components (void) const
	Return number of spatial components. More...

const GCTAModelSpatial *	component (const int &index) const
	Return spatial model component by index. More...

const GCTAModelSpatial *	component (const std::string &name) const
	Return spatial model component by name. More...

Public Member Functions inherited from GCTAModelSpatial
	GCTAModelSpatial (void)
	Void constructor. More...

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

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

virtual GCTAModelSpatial &	operator= (const GCTAModelSpatial &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 GCTAInstDir	mc (const GEnergy &energy, const GTime &time, const GCTAObservation &obs, GRan &ran) const
	Returns MC instrument direction. More...

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

virtual double	npred (const GEnergy &energy, const GTime &time, const GObservation &obs) const
	Return integral of spatial model component. 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 GCTAModelSpatialMultiplicative &model)
	Copy class members. More...

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

Protected Member Functions inherited from GCTAModelSpatial
void	init_members (void)
	Initialise class members. More...

void	copy_members (const GCTAModelSpatial &model)
	Copy class members. More...

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

Protected Attributes
std::string	m_type
	Model type. More...

std::vector< GCTAModelSpatial * >	m_spatial
	Container of spatial models. More...

std::vector< std::string >	m_components
	Names of components. More...

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

Detailed Description

Multiplicative spatial model class.

This class implements a multiplicative spatial component of the CTA background model.

Definition at line 53 of file GCTAModelSpatialMultiplicative.hpp.

Constructor & Destructor Documentation

GCTAModelSpatialMultiplicative::GCTAModelSpatialMultiplicative ( void )

Void constructor.

Definition at line 76 of file GCTAModelSpatialMultiplicative.cpp.

References init_members().

Referenced by clone().

GCTAModelSpatialMultiplicative::GCTAModelSpatialMultiplicative ( const GXmlElement & xml )

explicit

XML constructor.

Parameters

[in] xml XML element.

Creates instance of a multiplicative spatial model by extracting information from an XML element. See GCTAModelSpatialMultiplicative::read() for more information about the expected structure of the XML element.

Definition at line 97 of file GCTAModelSpatialMultiplicative.cpp.

References init_members(), and read().

GCTAModelSpatialMultiplicative::GCTAModelSpatialMultiplicative ( const GCTAModelSpatialMultiplicative & model )

Copy constructor.

Parameters

[in] model Spatial model.

Definition at line 116 of file GCTAModelSpatialMultiplicative.cpp.

References copy_members(), and init_members().

GCTAModelSpatialMultiplicative::~GCTAModelSpatialMultiplicative ( void )

virtual

Destructor.

Definition at line 133 of file GCTAModelSpatialMultiplicative.cpp.

References free_members().

Member Function Documentation

void GCTAModelSpatialMultiplicative::append	(	const GCTAModelSpatial &	spatial,
		const std::string &	name = `""`
	)

Append spatial component.

Parameters

[in]	spatial	Spatial model component.
[in]	name	Name of spatial component (can be empty).

Exceptions

GException::invalid_value Invalid component name specified

Appends a spatial component to the multiplicative model

Definition at line 439 of file GCTAModelSpatialMultiplicative.cpp.

References GCTAModelSpatial::clone(), gammalib::contains(), G_APPEND, m_components, GCTAModelSpatial::m_pars, m_spatial, GOptimizerPar::name(), and gammalib::str().

Referenced by read().

std::string GCTAModelSpatialMultiplicative::classname ( void ) const

inlinevirtual

Return class name.

Returns: String containing the class name ("GCTAModelSpatialMultiplicative").

Implements GCTAModelSpatial.

Definition at line 105 of file GCTAModelSpatialMultiplicative.hpp.

void GCTAModelSpatialMultiplicative::clear ( void )

virtual

Clear instance.

Implements GCTAModelSpatial.

Definition at line 187 of file GCTAModelSpatialMultiplicative.cpp.

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

GCTAModelSpatialMultiplicative * GCTAModelSpatialMultiplicative::clone ( void ) const

virtual

Clone instance.

Implements GCTAModelSpatial.

Definition at line 205 of file GCTAModelSpatialMultiplicative.cpp.

References GCTAModelSpatialMultiplicative().

const GCTAModelSpatial * GCTAModelSpatialMultiplicative::component ( const int & index ) const

Return spatial model component by index.

Parameters

[in] index Index of spectral component.

Returns: Pointer to spatial model.

Exceptions

GException::out_of_range Model index out of valid range

Returns a component of the multiplicative spatial model by index.

Definition at line 499 of file GCTAModelSpatialMultiplicative.cpp.

References G_COMPONENT_INDEX, and m_spatial.

const GCTAModelSpatial * GCTAModelSpatialMultiplicative::component ( const std::string & name ) const

Return spatial model component by name.

Parameters

[in] name Name of spatial component.

Returns: Pointer to spatial model.

Exceptions

GException::invalid_argument Spatial component not found

Returns a component of the multiplicative spatial model by name.

Definition at line 523 of file GCTAModelSpatialMultiplicative.cpp.

References G_COMPONENT_NAME, m_components, and m_spatial.

int GCTAModelSpatialMultiplicative::components ( void ) const

inline

Return number of spatial components.

Returns: Number of model components.

Returns the number of spatial components.

Definition at line 133 of file GCTAModelSpatialMultiplicative.hpp.

References m_spatial.

Referenced by copy_members(), and print().

void GCTAModelSpatialMultiplicative::copy_members ( const GCTAModelSpatialMultiplicative & model )

protected

Copy class members.

Parameters

[in] model Spatial background model component.

Definition at line 609 of file GCTAModelSpatialMultiplicative.cpp.

References components(), m_components, GCTAModelSpatial::m_pars, m_spatial, m_type, and GCTAModelSpatial::size().

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

double GCTAModelSpatialMultiplicative::eval	(	const GCTAInstDir &	dir,
		const GEnergy &	energy,
		const GTime &	time,
		const bool &	gradients = `false`
	)		const