CTA exposure cube class. More...

#include <GCTACubeExposure.hpp>

Inheritance diagram for GCTACubeExposure:

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

	GCTACubeExposure (const GCTACubeExposure &cube)
	Copy constructor. More...

	GCTACubeExposure (const GFilename &filename)
	File constructor. More...

	GCTACubeExposure (const GCTAEventCube &cube)
	Event cube constructor. More...

	GCTACubeExposure (const std::string &wcs, const std::string &coords, const double &x, const double &y, const double &dx, const double &dy, const int &nx, const int &ny, const GEnergies &energies)
	Exposure cube constructor. More...

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

GCTACubeExposure &	operator= (const GCTACubeExposure &exp)
	Assignment operator. More...

double	operator() (const GSkyDir &dir, const GEnergy &energy) const
	Return exposure (in units of cm**2 s) More...

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

GCTACubeExposure *	clone (void) const
	Clone exposure cube. More...

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

void	set (const GCTAObservation &obs)
	Set exposure cube for one CTA observation. More...

void	fill (const GObservations &obs, GLog *log=NULL)
	Fill exposure cube from observation container. More...

const GSkyMap &	cube (void) const
	Return exposure cube. More...

const GEnergies &	energies (void) const
	Return energies. More...

const GGti &	gti (void) const
	Return Good Time Intervals. More...

const double &	livetime (void) const
	Return livetime. More...

const double &	ontime (void) const
	Return ontime. More...

double	deadc (void) const
	Return deadtime correction. More...

void	read (const GFits &fits)
	Read exposure cube from FITS object. More...

void	write (GFits &file) const
	Write CTA exposure cube into FITS file. More...

void	load (const GFilename &filename)
	Load exposure cube from FITS file. More...

void	save (const GFilename &filename, const bool &clobber=false) const
	Save exposure cube into FITS file. More...

const GFilename &	filename (void) const
	Return exposure cube filename. More...

std::string	print (const GChatter &chatter=NORMAL) const
	Print exposure cube information. 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 GCTACubeExposure &exp)
	Copy class members. More...

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

void	fill_cube (const GCTAObservation &obs, GLog *log=NULL)
	Fill exposure cube for one observation. More...

void	update (const double &logE) const
	Update 1D cache. More...

void	set_eng_axis (void)
	Set nodes for a logarithmic (base 10) energy axis. More...

void	read_attributes (const GFitsHDU &hdu)
	Read exposure attributes. More...

void	write_attributes (GFitsHDU &hdu) const
	Write attributes to exposure extension. More...

Protected Attributes
GFilename	m_filename
	Filename. More...

GSkyMap	m_cube
	Average Exposure cube. More...

GEnergies	m_energies
	Energy values for the Exposure cube. More...

GNodeArray	m_elogmeans
	Mean energy for the Exposure cube. More...

GGti	m_gti
	Good time interval for the Exposure cube. More...

double	m_livetime
	Livetime (sec) More...

Private Attributes
int	m_inx_left
	Index of left node. More...

int	m_inx_right
	Index of right node. More...

double	m_wgt_left
	Weight of left node. More...

double	m_wgt_right
	Weight of right node. More...

Detailed Description

CTA exposure cube class.

This class implements a CTA exposure cube which provides the average exposure for binned analysis as function of sky position and energy.

Definition at line 55 of file GCTACubeExposure.hpp.

Constructor & Destructor Documentation

GCTACubeExposure::GCTACubeExposure ( void )

Void constructor.

Definition at line 64 of file GCTACubeExposure.cpp.

References init_members().

Referenced by clone().

GCTACubeExposure::GCTACubeExposure ( const GCTACubeExposure & cube )

Copy constructor.

Parameters

[in] cube Exposure cube.

Definition at line 79 of file GCTACubeExposure.cpp.

References copy_members(), and init_members().

GCTACubeExposure::GCTACubeExposure ( const GFilename & filename )

explicit

File constructor.

Parameters

[in] filename Exposure cube filename.

Construct exposure cube by loading the information from an exposure cube file.

Definition at line 100 of file GCTACubeExposure.cpp.

References init_members(), and load().

GCTACubeExposure::GCTACubeExposure ( const GCTAEventCube & cube )

explicit

Event cube constructor.

Parameters

[in] cube Event cube.

Construct exposure cube using the same binning and sky projection that is used for the event cube.

Definition at line 121 of file GCTACubeExposure.cpp.

References GCTAEventCube::counts(), GEvents::ebounds(), init_members(), m_cube, m_energies, GSkyMap::nmaps(), GEnergies::set(), set_eng_axis(), and GEnergies::size().

GCTACubeExposure::GCTACubeExposure	(	const std::string &	wcs,
		const std::string &	coords,
		const double &	x,
		const double &	y,
		const double &	dx,
		const double &	dy,
		const int &	nx,
		const int &	ny,
		const GEnergies &	energies
	)

Exposure cube constructor.

Parameters

[in]	wcs	World Coordinate System.
[in]	coords	Coordinate System (CEL or GAL).
[in]	x	X coordinate of sky map centre (deg).
[in]	y	Y coordinate of sky map centre (deg).
[in]	dx	Pixel size in x direction at centre (deg/pixel).
[in]	dy	Pixel size in y direction at centre (deg/pixel).
[in]	nx	Number of pixels in x direction.
[in]	ny	Number of pixels in y direction.
[in]	energies	Energies.

Constructs an exposure cube by specifying the sky map grid and the energies.

Definition at line 162 of file GCTACubeExposure.cpp.

References energies(), init_members(), m_cube, m_energies, set_eng_axis(), and GEnergies::size().

GCTACubeExposure::~GCTACubeExposure ( void )

virtual

Destructor.

Definition at line 192 of file GCTACubeExposure.cpp.

References free_members().

Member Function Documentation

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

inlinevirtual

Return class name.

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

Implements GBase.

Definition at line 135 of file GCTACubeExposure.hpp.

void GCTACubeExposure::clear ( void )

virtual

Clear instance.

This method properly resets the object to an initial state.

Implements GBase.

Definition at line 272 of file GCTACubeExposure.cpp.

References free_members(), and init_members().

Referenced by GCTAResponseCube::init_members(), and read().

GCTACubeExposure * GCTACubeExposure::clone ( void ) const

virtual

Clone exposure cube.

Returns: Deep copy of exposure cube instance.

Implements GBase.

Definition at line 290 of file GCTACubeExposure.cpp.

References GCTACubeExposure().

void GCTACubeExposure::copy_members ( const GCTACubeExposure & cube )

protected

Copy class members.

Parameters

[in] cube Exposure cube

Definition at line 602 of file GCTACubeExposure.cpp.

References m_cube, m_elogmeans, m_energies, m_filename, m_gti, m_inx_left, m_inx_right, m_livetime, m_wgt_left, and m_wgt_right.

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

const GSkyMap & GCTACubeExposure::cube ( void ) const

inline

Return exposure cube.

Returns: Exposure cube.

Returns the GSkyMap object that is used to store the exposure cube information.

Definition at line 150 of file GCTACubeExposure.hpp.

References m_cube.

double GCTACubeExposure::deadc ( void ) const

inline

Return deadtime correction.

Returns: Deadtime correction factor.

Definition at line 210 of file GCTACubeExposure.hpp.

References m_gti, m_livetime, and GGti::ontime().

Referenced by GCTAResponseCube::irf(), GCTAResponseCube::irf_diffuse(), GCTAResponseCube::irf_elliptical(), GCTAResponseCube::irf_ptsrc(), GCTAResponseCube::irf_radial(), GCTAObservation::response(), and write_attributes().

const GEnergies & GCTACubeExposure::energies ( void ) const

inline

Return energies.

Returns: Energies

Definition at line 162 of file GCTACubeExposure.hpp.

References m_energies.

Referenced by GCTACubeExposure().

const GFilename & GCTACubeExposure::filename ( void ) const

inline

Return exposure cube filename.

Returns: Exposure cube filename.

Returns the filename from which the exposure cube was loaded or into which the exposure cube has been saved.

Definition at line 225 of file GCTACubeExposure.hpp.

References m_filename.

Referenced by load(), save(), and GCTAResponseCube::write().

void GCTACubeExposure::fill	(	const GObservations &	obs,
		GLog *	log = `NULL`
	)

Fill exposure cube from observation container.

Parameters

[in]	obs	Observation container.
[in]	log	Pointer to logger.

Set the exposure cube by summing the exposure for all CTA observations in an observation container. The cube pixel values are computed as the sum over the products of the effective area and the livetime.

Definition at line 329 of file GCTACubeExposure.cpp.

References GGti::clear(), GCTAObservation::eventtype(), fill_cube(), GObservation::id(), GCTAObservation::instrument(), m_cube, m_gti, m_livetime, GObservation::name(), and GObservations::size().

void GCTACubeExposure::fill_cube	(	const GCTAObservation &	obs,
		GLog *	log = `NULL`
	)

protected

Fill exposure cube for one observation.

Parameters

[in]	obs	Observation.
[in]	log	Pointer to logger.

Exceptions

GException::invalid_value No RoI or response found in CTA observation.

Fill the exposure cube from one CTA observations. The exposure cube pixel values are computed as the product of the effective area and the livetime.

Definition at line 644 of file GCTACubeExposure.cpp.

References GCTARoi::centre(), GCTAInstDir::dir(), GSkyDir::dist(), GCTAObservation::ebounds(), GCTAObservation::eventtype(), GGti::extend(), G_FILL_CUBE, GCTAObservation::gti(), GObservation::id(), GCTAObservation::instrument(), GSkyMap::inx2dir(), GGti::is_empty(), GCTARoi::is_valid(), GCTAObservation::livetime(), m_cube, m_energies, m_gti, m_livetime, GObservation::name(), GSkyMap::npix(), GSkyMap::overlaps(), GCTAObservation::pointing(), GCTARoi::radius(), GGti::reference(), GCTAObservation::response(), GCTAObservation::roi(), and GEnergies::size().

Referenced by fill(), and set().

void GCTACubeExposure::free_members ( void )

protected

Delete class members.

Definition at line 625 of file GCTACubeExposure.cpp.

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

const GGti & GCTACubeExposure::gti ( void ) const

inline

Return Good Time Intervals.

Returns: Good Time Intervals.

Definition at line 174 of file GCTACubeExposure.hpp.

References m_gti.

void GCTACubeExposure::init_members ( void )

protected

Initialise class members.

Definition at line 573 of file GCTACubeExposure.cpp.

References GNodeArray::clear(), GGti::clear(), GEnergies::clear(), GFilename::clear(), GSkyMap::clear(), G_CTA_MJDREF, m_cube, m_elogmeans, m_energies, m_filename, m_gti, m_inx_left, m_inx_right, m_livetime, m_wgt_left, m_wgt_right, and GGti::reference().

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

const double & GCTACubeExposure::livetime ( void ) const

inline

Return livetime.

Returns: Livetime (seconds).

Definition at line 186 of file GCTACubeExposure.hpp.

References m_livetime.

Referenced by GCTAResponseCube::irf(), GCTAResponseCube::irf_diffuse(), GCTAResponseCube::irf_elliptical(), GCTAResponseCube::irf_ptsrc(), GCTAResponseCube::irf_radial(), and GCTAObservation::response().

void GCTACubeExposure::load ( const GFilename & filename )

Load exposure cube from FITS file.

Parameters

[in] filename Performance table file name.

Loads the exposure cube from a FITS file into the object.

Definition at line 451 of file GCTACubeExposure.cpp.

References GFits::close(), filename(), m_filename, and read().

Referenced by GCTACubeExposure(), and GCTAResponseCube::read().

const double & GCTACubeExposure::ontime ( void ) const

inline

Return ontime.

Returns: Ontime (seconds).

Definition at line 198 of file GCTACubeExposure.hpp.

References m_gti, and GGti::ontime().

Referenced by GCTAObservation::response(), and write_attributes().

double GCTACubeExposure::operator()	(	const GSkyDir &	dir,
		const GEnergy &	energy
	)		const

Return exposure (in units of cm**2 s)

Parameters

[in]	dir	Coordinate of the true photon position.
[in]	energy	Energy of the true photon.

Returns: Exposure (in units of cm**2 s)

Definition at line 242 of file GCTACubeExposure.cpp.

References GEnergy::log10TeV(), m_cube, m_inx_left, m_inx_right, m_wgt_left, m_wgt_right, and update().

GCTACubeExposure & GCTACubeExposure::operator= ( const GCTACubeExposure & cube )

Assignment operator.

Parameters

[in] cube Exposure cube.

Returns: Exposure cube.

Definition at line 214 of file GCTACubeExposure.cpp.

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

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

virtual

Print exposure cube information.

Parameters

[in] chatter Chattiness.

Returns: String containing exposure cube information.

Todo:: Add content

Implements GBase.

Definition at line 520 of file GCTACubeExposure.cpp.

References m_cube, m_energies, m_filename, m_gti, m_livetime, gammalib::parformat(), GEnergies::print(), GGti::print(), GSkyMap::print(), SILENT, GGti::size(), GEnergies::size(), and gammalib::str().

Referenced by GCTAResponseCube::print().

void GCTACubeExposure::read ( const GFits & fits )

Read exposure cube from FITS object.

Parameters

[in] fits FITS object.

Read the exposure cube from a FITS object.

Definition at line 384 of file GCTACubeExposure.cpp.

References clear(), gammalib::extname_energies, gammalib::extname_gti, GFits::image(), m_cube, m_energies, m_gti, GGti::read(), GEnergies::read(), GSkyMap::read(), read_attributes(), set_eng_axis(), and GFits::table().

Referenced by load().

void GCTACubeExposure::read_attributes ( const GFitsHDU & hdu )

protected

Read exposure attributes.

Parameters

[in] hdu FITS HDU.

Reads CTA exposure attributes from the HDU.

Definition at line 822 of file GCTACubeExposure.cpp.

References GFitsHDU::has_card(), m_livetime, and GFitsHDU::real().

Referenced by read().

void GCTACubeExposure::save	(	const GFilename &	filename,
		const bool &	clobber = `false`
	)		const

Save exposure cube into FITS file.

Parameters

[in]	filename	Exposure cube FITS file name.
[in]	clobber	Overwrite existing file?

Save the exposure cube into a FITS file.

Definition at line 484 of file GCTACubeExposure.cpp.

References GFits::close(), filename(), m_filename, GFits::saveto(), and write().

void GCTACubeExposure::set ( const GCTAObservation & obs )

Set exposure cube for one CTA observation.

Parameters

[in] obs CTA observation.

Set the exposure cube for one CTA observation. The cube pixel values are computed as product of the effective area and the livetime.

Definition at line 304 of file GCTACubeExposure.cpp.

References GGti::clear(), fill_cube(), m_cube, m_gti, and m_livetime.

void GCTACubeExposure::set_eng_axis ( void )

protected

Set nodes for a logarithmic (base 10) energy axis.

Set axis nodes so that each node is the logarithm of the energy values.

Definition at line 794 of file GCTACubeExposure.cpp.

References GNodeArray::append(), GNodeArray::clear(), m_elogmeans, m_energies, and GEnergies::size().

Referenced by GCTACubeExposure(), and read().

void GCTACubeExposure::update ( const double & logE ) const

protected

Update 1D cache.

Parameters

[in] logE Log10 energy in TeV.

Updates the 1D interpolation cache. The interpolation cache is composed of two indices and weights that define 2 data values of the 2D skymap that are used for linear interpolation.