Fermi/LAT observation class. More...

#include <GLATObservation.hpp>

Inheritance diagram for GLATObservation:

Public Member Functions
	GLATObservation (void)
	Void constructor.

	GLATObservation (const GXmlElement &xml)
	XML constructor.

	GLATObservation (const GLATObservation &obs)
	Copy constructor.

virtual	~GLATObservation (void)
	Destructor.

GLATObservation &	operator= (const GLATObservation &obs)
	Assignment operator.

virtual void	clear (void)
	Clear Fermi/LAT observation.

virtual GLATObservation *	clone (void) const
	Clone Fermi/LAT observation.

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

virtual void	response (const GResponse &rsp)
	Set response function.

virtual const GLATResponse *	response (void) const
	Return Fermi/LAT response function.

virtual std::string	instrument (void) const
	Return instrument name.

virtual double	ontime (void) const
	Return ontime.

virtual double	livetime (void) const
	Return livetime.

virtual double	deadc (const GTime &time=GTime()) const
	Return deadtime correction factor.

virtual void	read (const GXmlElement &xml)
	Read observation from XML element.

virtual void	write (GXmlElement &xml) const
	Write observation into XML element.

virtual std::string	print (const GChatter &chatter=NORMAL) const
	Print LAT observation information.

void	load_unbinned (const std::string &ft1name, const std::string &ft2name, const std::string &ltcube_name)
	Load data for unbinned analysis.

void	load_binned (const std::string &cntmap_name, const std::string &expmap_name, const std::string &ltcube_name)
	Load data for binned analysis.

void	response (const std::string &irfname)
	Set response function.

const GLATLtCube *	ltcube (void) const
	Return Fermi/LAT livetime cube.

Public Member Functions inherited from GObservation
	GObservation (void)
	Void constructor.

	GObservation (const GObservation &obs)
	Copy constructor.

virtual	~GObservation (void)
	Destructor.

virtual GObservation &	operator= (const GObservation &obs)
	Assignment operator.

virtual GEvents *	events (void)
	Return events.

virtual const GEvents *	events (void) const
	Return events (const version)

virtual void	events (const GEvents &events)
	Set event container.

virtual double	likelihood (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Compute likelihood function.

virtual double	model (const GModels &models, const GEvent &event, GVector *gradients=NULL) const
	Return model value and (optionally) gradients.

virtual GVector	model (const GModels &models, GMatrixSparse *gradients=NULL) const
	Return vector of model values and (optionally) gradients.

virtual double	nobserved (void) const
	Return total number of observed events.

virtual double	npred (const GModels &models, GVector *gradients=NULL) const
	Return total number (and optionally gradients) of predicted counts for all models.

virtual double	npred (const GModel &model) const
	Return total number of predicted counts for one model.

virtual double	model_grad (const GModel &model, const GModelPar &par, const GEvent &event) const
	Returns parameter gradient of model for a given event.

virtual GVector	model_grad (const GModel &model, const GModelPar &par) const
	Returns parameter gradients of model for all events.

virtual double	npred_grad (const GModel &model, const GModelPar &par) const
	Returns parameter gradient of Npred.

virtual void	remove_response_cache (const std::string &name)
	Remove response cache for specific model.

virtual double	grad_step_size (const GModelPar &par) const
	Return gradient step size for a given model parameter.

bool	has_events (void) const
	Signal if observation has events.

bool	has_gradient (const GModel &model, const GModelPar &par) const
	Check whether a model parameter has an analytical gradient.

void	name (const std::string &name)
	Set observation name.

void	id (const std::string &id)
	Set observation identifier.

void	statistic (const std::string &statistic)
	Set optimizer statistic.

const std::string &	name (void) const
	Return observation name.

const std::string &	id (void) const
	Return observation identifier.

const std::string &	statistic (void) const
	Return optimizer statistic.

void	computed_gradient (const GModel &model, const GModelPar &par) const
	Signals that an analytical gradient was computed for a model parameter.

Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor.

Protected Member Functions
void	init_members (void)
	Initialise class members.

void	copy_members (const GLATObservation &obs)
	Copy class members.

void	free_members (void)
	Delete class members.

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

void	copy_members (const GObservation &obs)
	Copy class members.

void	free_members (void)
	Delete class members.

virtual double	likelihood_poisson_unbinned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Poisson statistic and unbinned analysis (version with working arrays)

virtual double	likelihood_poisson_binned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Poisson statistic and binned analysis (version with working arrays)

virtual double	likelihood_gaussian_binned (const GModels &models, GVector gradients, GMatrixSparse curvature, double *npred) const
	Evaluate log-likelihood function for Gaussian statistic and binned analysis (version with working arrays)

virtual bool	use_event_for_likelihood (const int &index) const
	Check whether bin should be used for likelihood analysis.

virtual double	npred_spec (const GModel &model, const GTime &obsTime) const
	Integrates spatially integrated Npred kernel spectrally.

Protected Attributes
std::string	m_ft1file
	FT1 filename.

std::string	m_ft2file
	FT2 filename.

std::string	m_ltfile
	Lifetime cube filename.

std::string	m_cntfile
	Counts map filename.

std::string	m_expfile
	Exposure map filename.

GLATResponse	m_response
	Instrument response functions.

GLATLtCube *	m_ltcube
	Pointer to livetime cube.

Protected Attributes inherited from GObservation
std::string	m_name
	Observation name.

std::string	m_id
	Observation identifier.

std::string	m_statistic
	Optimizer statistic.

GEvents *	m_events
	Pointer to event container.

std::vector< std::string >	m_pars_with_gradients

Detailed Description

Fermi/LAT observation class.

This class implements a Fermi/LAT observation.

Definition at line 49 of file GLATObservation.hpp.

Constructor & Destructor Documentation

◆ GLATObservation() [1/3]

GLATObservation::GLATObservation ( void )

Void constructor.

Definition at line 67 of file GLATObservation.cpp.

References init_members().

Referenced by clone().

◆ GLATObservation() [2/3]

GLATObservation::GLATObservation ( const GXmlElement & xml )

explicit

XML constructor.

Parameters

[in] xml XML element.

Constructs a LAT observation from the information that is found in an XML element.

Definition at line 85 of file GLATObservation.cpp.

References init_members(), and read().

◆ GLATObservation() [3/3]

GLATObservation::GLATObservation ( const GLATObservation & obs )

Copy constructor.

Parameters

[in] obs LAT observation.

Definition at line 103 of file GLATObservation.cpp.

References copy_members(), and init_members().

◆ ~GLATObservation()

GLATObservation::~GLATObservation ( void )

virtual

Destructor.

Definition at line 119 of file GLATObservation.cpp.

References free_members().

Member Function Documentation

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GObservation.

Definition at line 108 of file GLATObservation.hpp.

◆ clear()

void GLATObservation::clear ( void )

virtual

Clear Fermi/LAT observation.

Implements GObservation.

Definition at line 174 of file GLATObservation.cpp.

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

Referenced by read().

◆ clone()

GLATObservation * GLATObservation::clone ( void ) const

virtual

Clone Fermi/LAT observation.

Returns: Pointer to deep copy of Fermi/LAT observation.

Implements GObservation.

Definition at line 194 of file GLATObservation.cpp.

References GLATObservation().

◆ copy_members()

void GLATObservation::copy_members ( const GLATObservation & obs )

protected

Copy class members.

Parameters

[in] obs LAT observation.

Definition at line 719 of file GLATObservation.cpp.

References GLATLtCube::clone(), m_cntfile, m_expfile, m_ft1file, m_ft2file, m_ltcube, m_ltfile, and m_response.

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

◆ deadc()

double GLATObservation::deadc ( const GTime & time = GTime() ) const

inlinevirtual

Return deadtime correction factor.

Returns: Deadtime correction factor

Implements GObservation.

Definition at line 185 of file GLATObservation.hpp.

◆ free_members()

void GLATObservation::free_members ( void )

protected

Delete class members.

Definition at line 740 of file GLATObservation.cpp.

References m_ltcube.

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

◆ init_members()

void GLATObservation::init_members ( void )

protected

Initialise class members.

Definition at line 698 of file GLATObservation.cpp.

References GLATResponse::clear(), m_cntfile, m_expfile, m_ft1file, m_ft2file, m_ltcube, m_ltfile, and m_response.

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

◆ instrument()

std::string GLATObservation::instrument ( void ) const

inlinevirtual

Return instrument name.

Returns: Instrument name ("LAT")

Implements GObservation.

Definition at line 146 of file GLATObservation.hpp.

Referenced by print().

◆ livetime()

double GLATObservation::livetime ( void ) const

inlinevirtual

Return livetime.

Returns: Livetime

Implements GObservation.

Definition at line 172 of file GLATObservation.hpp.

Referenced by print().

◆ load_binned()

void GLATObservation::load_binned	(	const std::string &	cntmap_name,
		const std::string &	expmap_name,
		const std::string &	ltcube_name )

Load data for binned analysis.

Parameters

[in]	cntmap_name	Counts map or Source map FITS filename
[in]	expmap_name	Binned explosure map FITS filename
[in]	ltcube_name	Livetime cube FITS filename

Todo: So far nothing is done with the expmap file. Approriate loading needs to be implemented.

Definition at line 653 of file GLATObservation.cpp.

References GObservation::events(), GEvents::load(), GLATLtCube::load(), m_cntfile, GObservation::m_events, m_expfile, m_ltcube, and m_ltfile.

Referenced by read().

◆ load_unbinned()

void GLATObservation::load_unbinned	(	const std::string &	ft1name,
		const std::string &	ft2name,
		const std::string &	ltcube_name )

Load data for unbinned analysis.

Parameters

[in]	ft1name	FT1 FITS filename.
[in]	ft2name	FT2 FITS filename.
[in]	ltcube_name	Livetime cube FITS filename

Todo: So far nothing is done with the ft2 file and the ltcube file. Loading of the relevant information needs to be implemented.

Definition at line 599 of file GLATObservation.cpp.

References GFits::close(), GObservation::events(), GLATLtCube::load(), GObservation::m_events, m_ft1file, m_ft2file, m_ltcube, m_ltfile, and GEvents::read().

Referenced by read().

◆ ltcube()

const GLATLtCube * GLATObservation::ltcube ( void ) const

inline

Return Fermi/LAT livetime cube.

Returns: Fermi/LAT livetime cube

Definition at line 133 of file GLATObservation.hpp.

References m_ltcube.

Referenced by GLATMeanPsf::set().

◆ ontime()

double GLATObservation::ontime ( void ) const

inlinevirtual

Return ontime.

Returns: Ontime

Implements GObservation.

Definition at line 159 of file GLATObservation.hpp.

Referenced by print().

◆ operator=()

GLATObservation & GLATObservation::operator= ( const GLATObservation & obs )

Assignment operator.

Parameters

[in] obs Fermi/LAT observation.

Returns: Fermi/LAT observation.

Definition at line 141 of file GLATObservation.cpp.

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

◆ print()

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

virtual

Print LAT observation information.

Parameters

[in] chatter Chattiness.

Returns: String containing LAT observation information.

Implements GObservation.

Definition at line 538 of file GLATObservation.cpp.

References instrument(), livetime(), GObservation::m_events, m_ltcube, m_response, GObservation::name(), ontime(), gammalib::parformat(), GEvents::print(), GLATLtCube::print(), GLATResponse::print(), gammalib::reduce(), SILENT, GObservation::statistic(), and gammalib::str().

◆ read()

void GLATObservation::read ( const GXmlElement & xml )

virtual

Read observation from XML element.

Parameters

[in] xml XML element.

Exceptions

GException::invalid_value Invalid parameter names found in XML element.

Reads information for a LAT observation from an XML element. The expected format of the XML element is

<observation name="..." id="..." instrument="LAT">
  <parameter name="FT1" file="..."/>
  <parameter name="FT2" file="..."/>
  <parameter name="LiveTimeCube" file="..."/>
  <parameter name="IRF" file="..."/>
</observation>

for an unbinned observation and

<observation name="..." id="..." instrument="LAT">
  <parameter name="CountsMap" file="..."/>
  <parameter name="ExposureMap" file="..."/>
  <parameter name="LiveTimeCube" file="..."/>
  <parameter name="IRF" value="..."/>
</observation>

for a binned observation.

Implements GObservation.

Definition at line 292 of file GLATObservation.cpp.

References GXmlElement::attribute(), clear(), GXmlNode::element(), GXmlNode::elements(), G_READ, load_binned(), load_unbinned(), response(), gammalib::xml_check_parnum(), and gammalib::xml_file_expand().

Referenced by GLATObservation().

◆ response() [1/3]

void GLATObservation::response ( const GResponse & rsp )

virtual

Set response function.

Parameters

[in] rsp Response function.

Exceptions

GException::invalid_argument Response rsp in not a LAT response.

Sets the response function for the observation. The argument has to be of type GLATResponse, otherwise an exception is thrown.

Implements GObservation.

Definition at line 211 of file GLATObservation.cpp.

References G_RESPONSE, m_response, and GObservation::name().

Referenced by GLATMeanPsf::set().

◆ response() [2/3]

void GLATObservation::response ( const std::string & irfname )

Set response function.

Parameters

[in] irfname Name of instrument response function.

Set the LAT response function using the IRF name and the path to the calibration database. The IRF name has to be one of

 name (is equivalent to front+back)
 name::front
 name::back
 name::psf(0-3)
 name::edisp(0-3)

where name is the response name (for example "P8R2_SOURCE_V6"). Note that the name is case sensitive, but the event typ is not case sensitive.

Definition at line 250 of file GLATObservation.cpp.

References GLATResponse::clear(), GLATResponse::load(), and m_response.

◆ response() [3/3]

const GLATResponse * GLATObservation::response ( void ) const

inlinevirtual

Return Fermi/LAT response function.

Returns: Fermi/LAT response function

Implements GObservation.

Definition at line 120 of file GLATObservation.hpp.

References m_response.

Referenced by read().

◆ write()

void GLATObservation::write ( GXmlElement & xml ) const

virtual

Write observation into XML element.

Parameters

[in] xml XML element.

Exceptions

GException::invalid_value	No events allocated or invalid parameter names found in XML element..
GException::runtime_error	Non-LAT events encountered.

Writes information for a LAT observation into an XML element. The expected format of the XML element is

<observation name="..." id="..." instrument="LAT">
  <parameter name="FT1" file="..."/>
  <parameter name="FT2" file="..."/>
  <parameter name="LiveTimeCube" file="..."/>
  <parameter name="IRF" file="..."/>
</observation>

for an unbinned observation and

<observation name="..." id="..." instrument="LAT">
  <parameter name="CountsMap" file="..."/>
  <parameter name="ExposureMap" file="..."/>
  <parameter name="LiveTimeCube" file="..."/>
  <parameter name="IRF" value="..."/>
</observation>

for a binned observation.

Todo: We should create a special exception that informs that there is neither a valid LAT event list nor a valid LAT counts map in this observations.

Implements GObservation.

Definition at line 429 of file GLATObservation.cpp.

References GXmlNode::append(), GXmlElement::attribute(), GXmlNode::element(), GXmlNode::elements(), G_WRITE, m_cntfile, GObservation::m_events, m_expfile, m_ft1file, m_ft2file, m_ltfile, m_response, GObservation::name(), GLATResponse::rspname(), gammalib::xml_check_parnum(), and gammalib::xml_file_reduce().

Member Data Documentation

◆ m_cntfile

std::string GLATObservation::m_cntfile

protected

Counts map filename.

Definition at line 95 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), load_binned(), and write().

◆ m_expfile

std::string GLATObservation::m_expfile

protected

Exposure map filename.

Definition at line 96 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), load_binned(), and write().

◆ m_ft1file

std::string GLATObservation::m_ft1file

protected

FT1 filename.

Definition at line 92 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), load_unbinned(), and write().

◆ m_ft2file

std::string GLATObservation::m_ft2file

protected

FT2 filename.

Definition at line 93 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), load_unbinned(), and write().

◆ m_ltcube

GLATLtCube* GLATObservation::m_ltcube

protected

Pointer to livetime cube.

Definition at line 98 of file GLATObservation.hpp.

Referenced by copy_members(), free_members(), init_members(), load_binned(), load_unbinned(), ltcube(), and print().

◆ m_ltfile

std::string GLATObservation::m_ltfile

protected

Lifetime cube filename.

Definition at line 94 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), load_binned(), load_unbinned(), and write().

◆ m_response

GLATResponse GLATObservation::m_response

protected

Instrument response functions.

Definition at line 97 of file GLATObservation.hpp.

Referenced by copy_members(), init_members(), print(), response(), response(), response(), and write().

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

inst/lat/include/GLATObservation.hpp
inst/lat/src/GLATObservation.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GLATObservation() [1/3]

◆ GLATObservation() [2/3]

◆ GLATObservation() [3/3]

◆ ~GLATObservation()

Member Function Documentation

◆ classname()

◆ clear()

◆ clone()

◆ copy_members()

◆ deadc()

◆ free_members()

◆ init_members()

◆ instrument()

◆ livetime()

◆ load_binned()

◆ load_unbinned()

◆ ltcube()

◆ ontime()

◆ operator=()

◆ print()

◆ read()

◆ response() [1/3]

◆ response() [2/3]

◆ response() [3/3]

◆ write()

Member Data Documentation

◆ m_cntfile

◆ m_expfile

◆ m_ft1file

◆ m_ft2file

◆ m_ltcube

◆ m_ltfile

◆ m_response