CTA point spread function for cube analysis. More...

#include <GCTACubePsf.hpp>

Inheritance diagram for GCTACubePsf:

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

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

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

	GCTACubePsf (const GCTAEventCube &cube, const double &dmax, const int &ndbins)
	Event cube constructor. More...

	GCTACubePsf (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, const double &dmax, const int &ndbins)
	PSF cube constructor. More...

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

GCTACubePsf &	operator= (const GCTACubePsf &cube)
	Assignment operator. More...

double	operator() (const GSkyDir &dir, const double &delta, const GEnergy &energy) const
	Return point spread function (in units of sr \(^{-1}\)) More...

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

GCTACubePsf *	clone (void) const
	Clone instance. More...

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

void	set (const GCTAObservation &obs)
	Set PSF cube from one CTA observation. More...

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

const GSkyMap &	cube (void) const
	Return psf cube sky map. More...

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

const GNodeArray &	deltas (void) const
	Return offset angles between true and measured photon direction. More...

double	delta_max (void) const
	Return maximum delta value in radians. More...

int	offset (const int &idelta, const int &iebin) const
	Return map offset. More...

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

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

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

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

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

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

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

void	clear_cube (void)
	Clear all pixels in the PSF cube. More...

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

void	update (const double &delta, const double &logE) const
	Update PSF parameter cache. More...

void	set_delta_axis (void)
	Set nodes for delta axis in radians. More...

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

void	set_to_smooth (void)
	Pad the last delta bins with zero. More...

Protected Attributes
GFilename	m_filename
	Filename. More...

GSkyMap	m_cube
	PSF cube. More...

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

GNodeArray	m_elogmeans
	Mean log10TeV energy for the PSF cube. More...

GNodeArray	m_deltas
	Delta bins (deg) for the PSF cube. More...

GNodeArray	m_deltas_cache
	Internal delta bins (rad) More...

bool	m_quadratic_binning
	Internal binning is linear. More...

Private Attributes
int	m_inx1
	Index of upper left node. More...

int	m_inx2
	Index of lower left node. More...

int	m_inx3
	Index of upper right node. More...

int	m_inx4
	Index of lower right node. More...

double	m_wgt1
	Weight of upper left node. More...

double	m_wgt2
	Weight of lower left node. More...

double	m_wgt3
	Weight of upper right node. More...

double	m_wgt4
	Weight of lower right node. More...

Detailed Description

CTA point spread function for cube analysis.

This class implements a mean CTA point spread function which provides the average point spread function for cube analysis as function of sky position, log10 energy and delta angle between true and measured photon direction.

Definition at line 62 of file GCTACubePsf.hpp.

Constructor & Destructor Documentation

GCTACubePsf::GCTACubePsf ( void )

Void constructor.

Definition at line 68 of file GCTACubePsf.cpp.

References init_members().

Referenced by clone().

GCTACubePsf::GCTACubePsf ( const GCTACubePsf & cube )

Copy constructor.

Parameters

[in] cube Point spread function.

Definition at line 83 of file GCTACubePsf.cpp.

References copy_members(), and init_members().

GCTACubePsf::GCTACubePsf ( const GFilename & filename )

explicit

File constructor.

Parameters

[in] filename PSF cube filename.

Construct PSF cube by loading the information from a PSF cube file.

Definition at line 103 of file GCTACubePsf.cpp.

References init_members(), and load().

GCTACubePsf::GCTACubePsf	(	const GCTAEventCube &	cube,
		const double &	dmax,
		const int &	ndbins
	)

Event cube constructor.

Parameters

[in]	cube	Event cube.
[in]	dmax	Maximum delta (deg).
[in]	ndbins	Number of delta bins.

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

Definition at line 126 of file GCTACubePsf.cpp.

References GNodeArray::append(), GNodeArray::clear(), GCTAEventCube::counts(), GEvents::ebounds(), init_members(), m_cube, m_deltas, m_energies, GSkyMap::nmaps(), GEnergies::set(), set_delta_axis(), set_eng_axis(), GSkyMap::shape(), GNodeArray::size(), GEnergies::size(), and sqrt().

GCTACubePsf::GCTACubePsf	(	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,
		const double &	dmax,
		const int &	ndbins
	)

PSF 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.
[in]	dmax	Maximum delta (deg).
[in]	ndbins	Number of delta bins.

Constructs a PSF cube by specifying the sky map grid and the energies.

Definition at line 194 of file GCTACubePsf.cpp.

References GNodeArray::append(), GNodeArray::clear(), energies(), init_members(), m_cube, m_deltas, m_energies, set_delta_axis(), set_eng_axis(), GSkyMap::shape(), GNodeArray::size(), GEnergies::size(), and sqrt().

GCTACubePsf::~GCTACubePsf ( void )

virtual

Destructor.

Definition at line 249 of file GCTACubePsf.cpp.

References free_members().

Member Function Documentation

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

inlinevirtual

Return class name.

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

Implements GBase.

Definition at line 151 of file GCTACubePsf.hpp.

void GCTACubePsf::clear ( void )

virtual

Clear instance.

This method properly resets the object to an initial state.

Implements GBase.

Definition at line 338 of file GCTACubePsf.cpp.

References free_members(), and init_members().

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

void GCTACubePsf::clear_cube ( void )

protected

Clear all pixels in the PSF cube.

Definition at line 743 of file GCTACubePsf.cpp.

References m_cube, GSkyMap::nmaps(), and GSkyMap::npix().

Referenced by fill(), and set().

GCTACubePsf * GCTACubePsf::clone ( void ) const

virtual

Clone instance.

Returns: Deep copy of mean PSF instance.

Implements GBase.

Definition at line 356 of file GCTACubePsf.cpp.

References GCTACubePsf().

void GCTACubePsf::copy_members ( const GCTACubePsf & cube )

protected

Copy class members.

Parameters

[in] cube PSF cube.

Definition at line 705 of file GCTACubePsf.cpp.

References m_cube, m_deltas, m_deltas_cache, m_elogmeans, m_energies, m_filename, m_inx1, m_inx2, m_inx3, m_inx4, m_quadratic_binning, m_wgt1, m_wgt2, m_wgt3, and m_wgt4.

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

const GSkyMap & GCTACubePsf::cube ( void ) const

inline

Return psf cube sky map.

Returns: psf cube sky map.

The GCTACubePsf represents the psf cube as a sky map. This methods returns the sky map that is stored internally by GCTACubePsf as psf cube.

Definition at line 167 of file GCTACubePsf.hpp.

References m_cube.

double GCTACubePsf::delta_max ( void ) const

inline

Return maximum delta value in radians.

Returns: Maximum delta value (radians).

Definition at line 203 of file GCTACubePsf.hpp.

References gammalib::deg2rad, m_deltas, and GNodeArray::size().

Referenced by GCTAResponseCube::irf(), GCTAResponseCube::irf_diffuse(), GCTAResponseCube::irf_ptsrc(), GCTAResponseCube::psf_diffuse(), GCTAResponseCube::psf_elliptical(), and GCTAResponseCube::psf_radial().

const GNodeArray & GCTACubePsf::deltas ( void ) const

inline

Return offset angles between true and measured photon direction.

Returns: Offset angles between true and measured photon direction

Definition at line 191 of file GCTACubePsf.hpp.

References m_deltas.

const GEnergies & GCTACubePsf::energies ( void ) const

inline

Return energies.

Returns: Energies

Definition at line 179 of file GCTACubePsf.hpp.

References m_energies.

Referenced by GCTACubePsf().

const GFilename & GCTACubePsf::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 222 of file GCTACubePsf.hpp.

References m_filename.

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

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

Fill PSF cube from observation container.

Parameters

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

Sets the PSF cube from all CTA observations in the observation container.

Definition at line 395 of file GCTACubePsf.cpp.

References clear_cube(), GCTAObservation::eventtype(), fill_cube(), GObservation::id(), GCTAObservation::instrument(), m_cube, m_deltas, m_energies, GObservation::name(), norm(), GSkyMap::npix(), offset(), set_to_smooth(), GNodeArray::size(), GEnergies::size(), and GObservations::size().

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

protected

Fill PSF cube for one observation.

Parameters

[in]	obs	Observation.
[in]	exposure	Pointer towards exposure map.
[in]	log	Pointer towards logger.

Exceptions

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

Definition at line 773 of file GCTACubePsf.cpp.

References GCTARoi::centre(), gammalib::deg2rad, GCTAInstDir::dir(), GSkyDir::dist(), GCTAObservation::ebounds(), GCTAObservation::eventtype(), G_FILL_CUBE, GObservation::id(), GCTAObservation::instrument(), GSkyMap::inx2dir(), GCTARoi::is_valid(), GCTAObservation::livetime(), m_cube, m_deltas, m_energies, GObservation::name(), GSkyMap::npix(), offset(), GSkyMap::overlaps(), GCTAObservation::pointing(), GCTARoi::radius(), GCTAObservation::response(), GCTAObservation::roi(), GNodeArray::size(), and GEnergies::size().

Referenced by fill(), and set().

void GCTACubePsf::free_members ( void )

protected

Delete class members.

Definition at line 733 of file GCTACubePsf.cpp.

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

void GCTACubePsf::init_members ( void )

protected

Initialise class members.

Definition at line 674 of file GCTACubePsf.cpp.

References GNodeArray::clear(), GEnergies::clear(), GFilename::clear(), GSkyMap::clear(), m_cube, m_deltas, m_deltas_cache, m_elogmeans, m_energies, m_filename, m_inx1, m_inx2, m_inx3, m_inx4, m_quadratic_binning, m_wgt1, m_wgt2, m_wgt3, and m_wgt4.

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

void GCTACubePsf::load ( const GFilename & filename )

Load PSF cube from FITS file.

Parameters

[in] filename Performance table file name.

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

Definition at line 549 of file GCTACubePsf.cpp.

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

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

int GCTACubePsf::offset	(	const int &	idelta,
		const int &	iebin
	)		const

inline

Return map offset.

Returns: Map offset.

Definition at line 234 of file GCTACubePsf.hpp.

References m_deltas, and GNodeArray::size().

Referenced by fill(), fill_cube(), set_to_smooth(), and update().

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

Return point spread function (in units of sr \(^{-1}\))

Parameters

[in]	dir	Coordinate of the true photon position.
[in]	delta	Angular separation between true and measured photon directions (rad).
[in]	energy	Energy of the true photon.

Returns: point spread function (in units of sr \(^{-1}\))

Returns the point spread function for a given angular separation in units of sr^-1 for a given energy and coordinate.

Definition at line 304 of file GCTACubePsf.cpp.

References GEnergy::log10TeV(), m_cube, m_inx1, m_inx2, m_inx3, m_inx4, m_wgt1, m_wgt2, m_wgt3, m_wgt4, and update().

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

Assignment operator.

Parameters

[in] cube Mean PSF cube.

Returns: Mean PSF cube.

Definition at line 271 of file GCTACubePsf.cpp.

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

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

virtual

Print PSF cube information.

Parameters

[in] chatter Chattiness.

Returns: String containing PSF cube information.

Implements GBase.

Definition at line 616 of file GCTACubePsf.cpp.

References m_cube, m_deltas, m_energies, m_filename, gammalib::parformat(), GEnergies::print(), GSkyMap::print(), SILENT, GNodeArray::size(), GEnergies::size(), and gammalib::str().

Referenced by GCTAResponseCube::print().

void GCTACubePsf::read ( const GFits & fits )

Read PSF cube from FITS object.

Parameters

[in] fits FITS object.

Read the PSF cube from a FITS object.

Definition at line 475 of file GCTACubePsf.cpp.

References clear(), gammalib::extname_deltas, gammalib::extname_energies, GFits::image(), m_cube, m_deltas, m_energies, GEnergies::read(), GNodeArray::read(), GSkyMap::read(), set_delta_axis(), set_eng_axis(), set_to_smooth(), and GFits::table().

Referenced by load().

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

Save PSF cube into FITS file.

Parameters

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

Save the PSF cube into a FITS file.

Definition at line 582 of file GCTACubePsf.cpp.

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

void GCTACubePsf::set ( const GCTAObservation & obs )

Set PSF cube from one CTA observation.

Parameters

[in] obs CTA observation.

Sets the PSF cube for one CTA observation.

Definition at line 369 of file GCTACubePsf.cpp.

References clear_cube(), fill_cube(), and set_to_smooth().

void GCTACubePsf::set_delta_axis ( void )

protected

Set nodes for delta axis in radians.

Set the delta axis nodes in radians. If a quadratic binning is detected, the axis is set to sqrt(delta) so that a linear interpolation scheme can be used which is much faster than a quadratic scheme.