COSI event bin container class. More...

#include <GCOSEventCube.hpp>

Inheritance diagram for GCOSEventCube:

Public Member Functions
	GCOSEventCube (void)
	Void constructor.

	GCOSEventCube (const GFilename &filename)
	Load constructor.

	GCOSEventCube (const std::string &coords, const int &nside, const std::string &order, const GBounds &phibounds, const GEbounds &ebounds, const GGti &gti)
	Cube constructor.

	GCOSEventCube (const GCOSEventCube &cube)
	Copy constructor.

virtual	~GCOSEventCube (void)
	Destructor.

virtual GCOSEventCube &	operator= (const GCOSEventCube &cube)
	Assignment operator.

virtual GCOSEventBin *	operator[] (const int &index)
	Event bin access operator.

virtual const GCOSEventBin *	operator[] (const int &index) const
	Event bin access operator (const version)

virtual void	clear (void)
	Clear COSI event cube.

virtual GCOSEventCube *	clone (void) const
	Clone event cube.

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

virtual int	size (void) const
	Return number of bins in event cube.

virtual int	dim (void) const
	Return dimension of event cube.

virtual int	naxis (const int &axis) const
	Return number of bins in axis.

virtual void	load (const GFilename &filename)
	Load COSI event cube from FITS file.

virtual void	save (const GFilename &filename, const bool &clobber=false) const
	Save COSI event cube into FITS file.

virtual void	read (const GFits &fits)
	Read COSI event cube from FITS file.

virtual void	write (GFits &fits) const
	Write COSI event cube into FITS file.

virtual double	number (void) const
	Return number of events in cube.

virtual std::string	print (const GChatter &chatter=NORMAL) const
	Print COSI event cube information.

void	set (const std::string &coords, const int &nside, const std::string &order, const GBounds &phibounds, const GEbounds &ebounds, const GGti &gti)
	Set event cube.

const GSkyMap &	cube (void) const
	Return event cube.

const GBounds &	phibounds (void) const
	Return Phi boundaries.

const GTime &	time (void) const
	Return event cube time.

const double &	ontime (void) const
	Return event cube ontime.

const double &	solidangle (void) const
	Return event cube pixels solid angles.

void	fill (const GCOSEventList &list)
	Fill event cube with events from event list.

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

	GEventCube (const GEventCube &cube)
	Copy constructor.

virtual	~GEventCube (void)
	Destructor.

virtual GEventCube &	operator= (const GEventCube &cube)
	Assignment operator.

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

	GEvents (const GEvents &events)
	Copy constructor.

virtual	~GEvents (void)
	Destructor.

virtual GEvents &	operator= (const GEvents &events)
	Assignment operator.

void	ebounds (const GEbounds &ebounds)
	Set energy boundaries.

void	gti (const GGti &gti)
	Set Good Time Intervals.

const GEbounds &	ebounds (void) const
	Return energy boundaries.

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

const GTime &	tstart (void) const
	Return start time.

const GTime &	tstop (void) const
	Return stop time.

const GEnergy &	emin (void) const
	Return minimum energy.

const GEnergy &	emax (void) const
	Return maximum energy.

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

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

void	copy_members (const GCOSEventCube &cube)
	Copy class members.

void	free_members (void)
	Delete class members.

void	set_scatter_directions (void)
	Set scatter directions of all events cube pixels.

void	set_scatter_angles (void)
	Set Compton scatter angles of event cube.

virtual void	set_energies (void)
	Set log mean energies and energy widths of energy bins.

virtual void	set_times (void)
	Set mean event time and ontime of event cube.

void	init_bin (void)
	Initialise event bin.

void	set_bin (const int &index)
	Set event bin.

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

void	copy_members (const GEventCube &cube)
	Copy class members.

void	free_members (void)
	Delete class members.

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

void	copy_members (const GEvents &events)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Attributes
GSkyMap	m_cube
	Event cube.

GBounds	m_phibounds
	Phi layer boundaries.

GCOSEventBin	m_bin
	Current event bin.

GCOSInstDir	m_dir
	Current event direction.

GTime	m_time
	Event cube mean time.

double	m_ontime
	Event cube ontime (sec)

double	m_solidangle
	Event bin solid angle (sr)

int	m_npix
	Number of HealPix pixels.

int	m_nphi
	Number of Phi layers.

std::vector< GSkyDir >	m_dirs
	Cube pixel scatter directions.

std::vector< double >	m_phis
	Array of scatter angles.

std::vector< double >	m_phiwidths
	Array of scatter angles bin widths.

std::vector< GEnergy >	m_energies
	Cube energy bin mean energies.

std::vector< GEnergy >	m_ewidths
	Cube energy bin widths.

int	m_num_events_checked
	Number of checked events.

int	m_num_events_used
	Number of used events.

int	m_num_outside_gti
	Number of events outside GTI.

int	m_num_outside_ebounds
	Number of events outside energy boundaries.

int	m_num_outside_phibounds
	Number of events outside scatter angle bounds.

Protected Attributes inherited from GEvents
GEbounds	m_ebounds
	Energy boundaries covered by events.

GGti	m_gti
	Good time intervals covered by events.

Detailed Description

COSI event bin container class.

This class is a container class for COSI event bins.

Definition at line 59 of file GCOSEventCube.hpp.

Constructor & Destructor Documentation

◆ GCOSEventCube() [1/4]

GCOSEventCube::GCOSEventCube ( void )

Void constructor.

Constructs an empty COSI event cube.

Definition at line 67 of file GCOSEventCube.cpp.

References init_members().

Referenced by clone().

◆ GCOSEventCube() [2/4]

GCOSEventCube::GCOSEventCube ( const GFilename & filename )

explicit

Load constructor.

Parameters

[in] filename COSI event cube FITS filename.

Construct a COSI event cube by loading it from a FITS file.

Definition at line 117 of file GCOSEventCube.cpp.

References init_members(), and load().

◆ GCOSEventCube() [3/4]

GCOSEventCube::GCOSEventCube	(	const std::string &	coords,
		const int &	nside,
		const std::string &	order,
		const GBounds &	phibounds,
		const GEbounds &	ebounds,
		const GGti &	gti )

Cube constructor.

Parameters

[in]	coords	Event cube coordinate system (CEL or GAL).
[in]	nside	Event cube Nside parameter.
[in]	order	Event cube pixel ordering (RING or NEST).
[in]	phibounds	Phi layer boundaries.
[in]	ebounds	Event cube energy boundaries.
[in]	gti	Good Time intervals.

Constructs a HealPix event cube by specifying the coordinate system, the HealPix Nside parameter and pixel ordering scheme, the event cube Phi layer boundaries, the event cube energy boundaries and the event cube Good Time Invervals.

Definition at line 92 of file GCOSEventCube.cpp.

References GEvents::ebounds(), GEvents::gti(), init_members(), phibounds(), and set().

◆ GCOSEventCube() [4/4]

GCOSEventCube::GCOSEventCube ( const GCOSEventCube & cube )

Copy constructor.

Parameters

[in] cube COSI event cube.

Definition at line 135 of file GCOSEventCube.cpp.

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

◆ ~GCOSEventCube()

GCOSEventCube::~GCOSEventCube ( void )

virtual

Destructor.

Definition at line 151 of file GCOSEventCube.cpp.

References free_members().

Member Function Documentation

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GEventCube.

Definition at line 151 of file GCOSEventCube.hpp.

◆ clear()

void GCOSEventCube::clear ( void )

virtual

Clear COSI event cube.

Clears COSI event cube by resetting all class members to an initial state. Any information that was present before will be lost.

Implements GEventCube.

Definition at line 249 of file GCOSEventCube.cpp.

References free_members(), GEventCube::free_members(), GEvents::free_members(), init_members(), GEventCube::init_members(), and GEvents::init_members().

Referenced by read(), and set().

◆ clone()

GCOSEventCube * GCOSEventCube::clone ( void ) const

virtual

Clone event cube.

Returns: Pointer to deep copy of COSI event cube.

Implements GEventCube.

Definition at line 271 of file GCOSEventCube.cpp.

References GCOSEventCube().

◆ copy_members()

void GCOSEventCube::copy_members ( const GCOSEventCube & cube )

protected

Copy class members.

Parameters

[in] cube COSI event cube.

This method copies the class members from another event cube in the actual object. It also prepares the event bin member that will be returned in case of an operator access to the class.

Definition at line 864 of file GCOSEventCube.cpp.

References cube(), init_bin(), m_cube, m_dir, m_dirs, m_energies, m_ewidths, m_nphi, m_npix, m_num_events_checked, m_num_events_used, m_num_outside_ebounds, m_num_outside_gti, m_num_outside_phibounds, m_ontime, m_phibounds, m_phis, m_phiwidths, m_solidangle, and m_time.

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

◆ cube()

const GSkyMap & GCOSEventCube::cube ( void ) const

inline

Return event cube.

Returns: Event cube.

Definition at line 163 of file GCOSEventCube.hpp.

References m_cube.

Referenced by copy_members(), GCOSEventCube(), and operator=().

◆ dim()

int GCOSEventCube::dim ( void ) const

virtual

Return dimension of event cube.

Returns: Number of dimensions in event cube.

The number of dimensions of the event cube counts one for the sky map pixels, one for the phibar axis and one for the energy axis. So typically an event cube has 3 dimensions.

Implements GEventCube.

Definition at line 301 of file GCOSEventCube.cpp.

References dim(), GSkyMap::is_empty(), m_cube, and GSkyMap::ndim().

Referenced by dim(), and naxis().

◆ fill()

void GCOSEventCube::fill ( const GCOSEventList & list )

Fill event cube with events from event list.

Parameters

[in] list COSI event list.

Exceptions

GException::invalid_value No Good Time Intervals defined. No energy boundaries defined. No scatter angle boundaries defined.

Fills events from an event list into the event cube. Events that existed in the event cube will be preserved so that events from multiple event lists can be filled into the event cube.

The method requires that Good Time Intervals, energy boundaries and scatter angle boundaries are defined. If boundaries are not defined an exception will be thrown.

Only events that fall within the Good Time Intervals, energy boundaries and scatter angle boundaries will be filled into the cube, other events will be ignored.

The method assumes that the event list and the Good Time Intervals are sorted by increasing time. This allows for a fast check of event times against Good Time Intervals.

The method updates the event filling statistics.

Definition at line 638 of file GCOSEventCube.cpp.

References GSkyMap::dir2inx(), GEvents::ebounds(), G_FILL, GEvents::gti(), GBounds::index(), GEbounds::index(), m_cube, GEvents::m_ebounds, m_num_events_checked, m_num_events_used, m_num_outside_ebounds, m_num_outside_gti, m_num_outside_phibounds, m_phibounds, phibounds(), GBounds::size(), size(), GCOSEventList::size(), time(), GEvents::tstart(), and GEvents::tstop().

◆ free_members()

void GCOSEventCube::free_members ( void )

protected

Delete class members.

Definition at line 902 of file GCOSEventCube.cpp.

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

◆ init_bin()

void GCOSEventCube::init_bin ( void )

protected

Initialise event bin.

Initialises the event bin. The event bin is cleared and all fixed pointers are set. Only the m_counts, m_phiwidth, m_energy and m_ewidth members of the event bin will be set to NULL as those will change for individual bins and set by the set_bin() method. The set_bin() method is called before any event bin access.

< Will be set by set_bin method

< Content will be set by set_bin method

< Fixed content

< Will be set by set_bin method

Definition at line 1068 of file GCOSEventCube.cpp.

References GCOSEventBin::free_members(), m_bin, GCOSEventBin::m_counts, GCOSEventBin::m_dir, m_dir, GCOSEventBin::m_energy, GCOSEventBin::m_ewidth, GCOSEventBin::m_ontime, m_ontime, GCOSEventBin::m_phiwidth, GCOSEventBin::m_solidangle, m_solidangle, GCOSEventBin::m_time, and m_time.

Referenced by copy_members(), and init_members().

◆ init_members()

void GCOSEventCube::init_members ( void )

protected

Initialise class members.

Definition at line 822 of file GCOSEventCube.cpp.

References GBounds::clear(), GCOSEventBin::clear(), GCOSInstDir::clear(), GSkyMap::clear(), GTime::clear(), init_bin(), m_bin, m_cube, m_dir, m_dirs, m_energies, m_ewidths, m_nphi, m_npix, m_num_events_checked, m_num_events_used, m_num_outside_ebounds, m_num_outside_gti, m_num_outside_phibounds, m_ontime, m_phibounds, m_phis, m_phiwidths, m_solidangle, and m_time.

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

◆ load()

void GCOSEventCube::load ( const GFilename & filename )

virtual

Load COSI event cube from FITS file.

Parameters

[in] filename FITS file name.

The method clears the object before loading, thus any events residing in the object before loading will be lost.

Implements GEventCube.

Definition at line 351 of file GCOSEventCube.cpp.

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

Referenced by GCOSEventCube().

◆ naxis()

int GCOSEventCube::naxis ( const int & axis ) const

virtual

Return number of bins in axis.

Parameters

[in] axis Axis [0,...,dim()-1].

Returns: Number of bins in axis.

Exceptions

GException::out_of_range Axis is out of range.

Returns the number of bins along a given event cube axis. If axis=0 the number if HealPix pixels is returned. If axis=1 the number of Phi laters is returned. If axis=2 the number of energy bins is returned.

Implements GEventCube.

Definition at line 325 of file GCOSEventCube.cpp.

References dim(), G_NAXIS, m_cube, naxis(), GSkyMap::npix(), and GSkyMap::shape().

Referenced by naxis().

◆ number()

double GCOSEventCube::number ( void ) const

virtual

Return number of events in cube.

Returns: Number of events in event cube.

This method returns the number of events in the event cube.

Implements GEventCube.

Definition at line 519 of file GCOSEventCube.cpp.

References m_cube, number(), GSkyMap::pixels(), and size().

Referenced by number(), and print().

◆ ontime()

const double & GCOSEventCube::ontime ( void ) const

inline

Return event cube ontime.

Returns: Event cube ontime.

Definition at line 199 of file GCOSEventCube.hpp.

References m_ontime.

◆ operator=()

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

virtual

Assignment operator.

Parameters

[in] cube COSI event cube.

Returns: COSI event cube.

Definition at line 173 of file GCOSEventCube.cpp.

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

◆ operator[]() [1/2]

GCOSEventBin * GCOSEventCube::operator[] ( const int & index )

virtual

Event bin access operator.

Parameters

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

Returns: Pointer to event bin.

Returns pointer to an event bin. Note that the returned pointer is in fact always the same, but the method sets the pointers within the event bin so that they point to the appropriate information.

Implements GEventCube.

Definition at line 207 of file GCOSEventCube.cpp.

References m_bin, and set_bin().

◆ operator[]() [2/2]

const GCOSEventBin * GCOSEventCube::operator[] ( const int & index ) const

virtual

Event bin access operator (const version)

Parameters

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

Returns: Const pointer to event bin.

Returns pointer to an event bin. Note that the returned pointer is in fact always the same, but the method sets the pointers within the event bin so that they point to the appropriate information.

Implements GEventCube.

Definition at line 227 of file GCOSEventCube.cpp.

References m_bin, and set_bin().

◆ phibounds()

const GBounds & GCOSEventCube::phibounds ( void ) const

inline

Return Phi boundaries.

Returns: Phi boundaries.

Definition at line 175 of file GCOSEventCube.hpp.

References m_phibounds.

Referenced by fill(), GCOSEventCube(), read(), and set().

◆ print()

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

virtual

Print COSI event cube information.

Parameters

[in] chatter Chattiness.

Returns: String containing COSI event cube information.

Implements GEventCube.

Definition at line 750 of file GCOSEventCube.cpp.

References GEvents::emax(), GEvents::emin(), GEvents::gti(), GEvents::m_ebounds, m_npix, m_ontime, m_phibounds, m_time, GBounds::max(), GBounds::min(), number(), gammalib::parformat(), GTime::print(), gammalib::reduce(), SILENT, GBounds::size(), size(), GEbounds::size(), gammalib::str(), GEvents::tstart(), GEvents::tstop(), and GBounds::unit().

◆ read()

void GCOSEventCube::read ( const GFits & fits )

virtual

Read COSI event cube from FITS file.

Parameters

[in] fits FITS file.

Reads a COSI event cube from a FITS file.

Implements GEventCube.

Definition at line 401 of file GCOSEventCube.cpp.

References clear(), GEvents::ebounds(), gammalib::extname_ebounds, gammalib::extname_gti, GEvents::gti(), GFitsHDU::has_card(), GFitsHDU::integer(), m_cube, GEvents::m_ebounds, GEvents::m_gti, m_num_events_checked, m_num_events_used, m_num_outside_ebounds, m_num_outside_gti, m_num_outside_phibounds, m_phibounds, phibounds(), GBounds::read(), GEbounds::read(), GGti::read(), GSkyMap::read(), set_energies(), set_scatter_angles(), set_scatter_directions(), set_times(), GSkyMap::shape(), GBounds::size(), GEbounds::size(), and GFits::table().

Referenced by load().

◆ save()

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

virtual

Save COSI event cube into FITS file.

Parameters

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

Saves the COSI event cube into a FITS file.

Implements GEventCube.

Definition at line 375 of file GCOSEventCube.cpp.

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

◆ set()

void GCOSEventCube::set	(	const std::string &	coords,
		const int &	nside,
		const std::string &	order,
		const GBounds &	phibounds,
		const GEbounds &	ebounds,
		const GGti &	gti )

Set event cube.

Parameters

[in]	coords	Event cube coordinate system (CEL or GAL).
[in]	nside	Event cube Nside parameter.
[in]	order	Event cube pixel ordering (RING or NEST).
[in]	phibounds	Phi layer boundaries.
[in]	ebounds	Event cube energy boundaries.
[in]	gti	Good Time intervals.

Exceptions

GException::invalid_argument Invalid units specified for Phi layer boundaries.

Sets a HealPix event cube by specifying the coordinate system, the HealPix Nside parameter and pixel ordering scheme, the event cube Phi layer boundaries, the event cube energy boundaries and the event cube Good Time Intervals.

Definition at line 555 of file GCOSEventCube.cpp.

References clear(), GEvents::ebounds(), G_SET, GEvents::gti(), m_cube, GEvents::m_ebounds, GEvents::m_gti, m_phibounds, phibounds(), set_energies(), set_scatter_angles(), set_scatter_directions(), set_times(), GSkyMap::shape(), GBounds::size(), GEbounds::size(), gammalib::tolower(), and GBounds::unit().

Referenced by GCOSEventCube().

◆ set_bin()

void GCOSEventCube::set_bin ( const int & index )

protected

Set event bin.

Parameters

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

Exceptions

GException::out_of_range Event index is outside valid range.

Sets the pointers of the event bin to the event cube cell that corresponds to the specified index. The event bin is in fact physically stored in the event cube, and only a single event bin is indeed allocated. This method sets up the pointers in the event bin so that a client can easily access the information of individual bins as if they were stored in an array.

The method updates the following members of the event bin: m_index, m_counts, m_phiwidth, m_energy and m_ewidth.

The method also updates the event bin direction m_dir.

Definition at line 1106 of file GCOSEventCube.cpp.

References GCOSInstDir::dir(), G_SET_BIN, m_bin, GCOSEventBin::m_counts, m_cube, m_dir, m_dirs, m_energies, GCOSEventBin::m_energy, GCOSEventBin::m_ewidth, m_ewidths, GCOSEventBin::m_index, m_nphi, m_npix, m_phis, GCOSEventBin::m_phiwidth, m_phiwidths, GCOSInstDir::phi(), GSkyMap::pixels(), and size().

Referenced by operator[](), and operator[]().

◆ set_energies()

void GCOSEventCube::set_energies ( void )

protectedvirtual

Set log mean energies and energy widths of energy bins.

Exceptions

GException::invalid_value No energy boundaries defined.

Computes the long mean energy and energy bin width of the event cube.

Reimplemented from GEventCube.

Definition at line 999 of file GCOSEventCube.cpp.

References GEbounds::elogmean(), GEbounds::emax(), GEbounds::emin(), G_SET_ENERGIES, GEvents::m_ebounds, m_energies, m_ewidths, and GEbounds::size().

Referenced by read(), and set().

◆ set_scatter_angles()

void GCOSEventCube::set_scatter_angles ( void )

protected

Set Compton scatter angles of event cube.

Exceptions

GException::invalid_value No scatter angles have been defined.

Computes the Compton scatter angles for all Phibar layers. This method sets the m_phis, m_phiwidths and m_nphi members of the class.

Definition at line 959 of file GCOSEventCube.cpp.

References G_SET_SCATTER_ANGLES, m_nphi, m_phibounds, m_phis, m_phiwidths, GBounds::max(), GBounds::mean(), GBounds::min(), and GBounds::size().

Referenced by read(), and set().

◆ set_scatter_directions()

void GCOSEventCube::set_scatter_directions ( void )

protected

Set scatter directions of all events cube pixels.

Exceptions

GException::invalid_value No sky pixels have been defined.

Computes the scatter directions of all events cube pixels. This method sets the m_dirs, m_npix and m_solidangle members of the class.

Definition at line 918 of file GCOSEventCube.cpp.

References G_SET_SCATTER_DIRECTIONS, GSkyMap::inx2dir(), m_cube, m_dirs, m_npix, m_solidangle, GSkyMap::npix(), and GSkyMap::solidangle().

Referenced by read(), and set().

◆ set_times()

void GCOSEventCube::set_times ( void )

protectedvirtual

Set mean event time and ontime of event cube.

Exceptions

GException::invalid_value No Good Time Intervals found.

Computes the mean time of the event cube by taking the mean between start and stop time. Computes also the ontime by summing up of all good time intervals.

Reimplemented from GEventCube.

Definition at line 1038 of file GCOSEventCube.cpp.

References G_SET_TIMES, GEvents::m_gti, m_ontime, m_time, GGti::ontime(), GGti::size(), GGti::tstart(), and GGti::tstop().

Referenced by read(), and set().

◆ size()

int GCOSEventCube::size ( void ) const

virtual

Return number of bins in event cube.

Returns: Number of bins in event cube.

Implements GEventCube.

Definition at line 282 of file GCOSEventCube.cpp.

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

Referenced by fill(), number(), print(), set_bin(), and write().

◆ solidangle()

const double & GCOSEventCube::solidangle ( void ) const

inline

Return event cube pixels solid angles.

Returns: Event cube pixels solid angles.

Definition at line 211 of file GCOSEventCube.hpp.

References m_solidangle.

◆ time()

const GTime & GCOSEventCube::time ( void ) const

inline

Return event cube time.

Returns: Event cube time.

Definition at line 187 of file GCOSEventCube.hpp.

References m_time.

Referenced by fill().

◆ write()

void GCOSEventCube::write ( GFits & fits ) const

virtual

Write COSI event cube into FITS file.

Parameters

[in] fits FITS file.

Writes the COSI event cube into a FITS file. The method does nothing if size() is not positive.

Implements GEventCube.

Definition at line 469 of file GCOSEventCube.cpp.

References GFitsHDU::card(), m_cube, GEvents::m_ebounds, GEvents::m_gti, m_num_events_checked, m_num_events_used, m_num_outside_ebounds, m_num_outside_gti, m_num_outside_phibounds, m_phibounds, size(), GBounds::write(), GEbounds::write(), GGti::write(), and GSkyMap::write().

Referenced by save().

Member Data Documentation

◆ m_bin

GCOSEventBin GCOSEventCube::m_bin

protected

Current event bin.

Definition at line 123 of file GCOSEventCube.hpp.

Referenced by init_bin(), init_members(), operator[](), operator[](), and set_bin().

◆ m_cube

GSkyMap GCOSEventCube::m_cube

protected

Event cube.

Definition at line 121 of file GCOSEventCube.hpp.

Referenced by copy_members(), cube(), dim(), fill(), init_members(), naxis(), number(), read(), set(), set_bin(), set_scatter_directions(), size(), and write().

◆ m_dir

GCOSInstDir GCOSEventCube::m_dir

protected

Current event direction.

Definition at line 124 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_bin(), init_members(), and set_bin().

◆ m_dirs

std::vector<GSkyDir> GCOSEventCube::m_dirs

protected

Cube pixel scatter directions.

Definition at line 130 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_scatter_directions().

◆ m_energies

std::vector<GEnergy> GCOSEventCube::m_energies

protected

Cube energy bin mean energies.

Definition at line 133 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_energies().

◆ m_ewidths

std::vector<GEnergy> GCOSEventCube::m_ewidths

protected

Cube energy bin widths.

Definition at line 134 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_energies().

◆ m_nphi

int GCOSEventCube::m_nphi

protected

Number of Phi layers.

Definition at line 129 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_scatter_angles().

◆ m_npix

int GCOSEventCube::m_npix

protected

Number of HealPix pixels.

Definition at line 128 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), print(), set_bin(), and set_scatter_directions().

◆ m_num_events_checked

int GCOSEventCube::m_num_events_checked

protected

Number of checked events.

Definition at line 137 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), read(), and write().

◆ m_num_events_used

int GCOSEventCube::m_num_events_used

protected

Number of used events.

Definition at line 138 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), read(), and write().

◆ m_num_outside_ebounds

int GCOSEventCube::m_num_outside_ebounds

protected

Number of events outside energy boundaries.

Definition at line 140 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), read(), and write().

◆ m_num_outside_gti

int GCOSEventCube::m_num_outside_gti

protected

Number of events outside GTI.

Definition at line 139 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), read(), and write().

◆ m_num_outside_phibounds

int GCOSEventCube::m_num_outside_phibounds

protected

Number of events outside scatter angle bounds.

Definition at line 141 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), read(), and write().

◆ m_ontime

double GCOSEventCube::m_ontime

protected

Event cube ontime (sec)

Definition at line 126 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_bin(), init_members(), ontime(), print(), and set_times().

◆ m_phibounds

GBounds GCOSEventCube::m_phibounds

protected

Phi layer boundaries.

Definition at line 122 of file GCOSEventCube.hpp.

Referenced by copy_members(), fill(), init_members(), phibounds(), print(), read(), set(), set_scatter_angles(), and write().

◆ m_phis

std::vector<double> GCOSEventCube::m_phis

protected

Array of scatter angles.

Definition at line 131 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_scatter_angles().

◆ m_phiwidths

std::vector<double> GCOSEventCube::m_phiwidths

protected

Array of scatter angles bin widths.

Definition at line 132 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_members(), set_bin(), and set_scatter_angles().

◆ m_solidangle

double GCOSEventCube::m_solidangle

protected

Event bin solid angle (sr)

Definition at line 127 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_bin(), init_members(), set_scatter_directions(), and solidangle().

◆ m_time

GTime GCOSEventCube::m_time

protected

Event cube mean time.

Definition at line 125 of file GCOSEventCube.hpp.

Referenced by copy_members(), init_bin(), init_members(), print(), set_times(), and time().

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

inst/cos/include/GCOSEventCube.hpp
inst/cos/src/GCOSEventCube.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GCOSEventCube() [1/4]

◆ GCOSEventCube() [2/4]

◆ GCOSEventCube() [3/4]

◆ GCOSEventCube() [4/4]

◆ ~GCOSEventCube()

Member Function Documentation

◆ classname()

◆ clear()

◆ clone()

◆ copy_members()

◆ cube()

◆ dim()

◆ fill()

◆ free_members()

◆ init_bin()

◆ init_members()

◆ load()

◆ naxis()

◆ number()

◆ ontime()

◆ operator=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ phibounds()

◆ print()

◆ read()

◆ save()

◆ set()

◆ set_bin()

◆ set_energies()

◆ set_scatter_angles()

◆ set_scatter_directions()

◆ set_times()

◆ size()

◆ solidangle()

◆ time()

◆ write()

Member Data Documentation

◆ m_bin

◆ m_cube

◆ m_dir

◆ m_dirs

◆ m_energies

◆ m_ewidths

◆ m_nphi

◆ m_npix

◆ m_num_events_checked

◆ m_num_events_used

◆ m_num_outside_ebounds

◆ m_num_outside_gti

◆ m_num_outside_phibounds

◆ m_ontime

◆ m_phibounds

◆ m_phis

◆ m_phiwidths

◆ m_solidangle

◆ m_time