Fermi/LAT region of interest class. More...

#include <GLATRoi.hpp>

Inheritance diagram for GLATRoi:

Public Member Functions
	GLATRoi (void)
	Void constructor.

	GLATRoi (const GLATInstDir &centre, const double &radius)
	Region of interest constructor.

	GLATRoi (const GLATRoi &roi)
	Copy constructor.

virtual	~GLATRoi (void)
	Destructor.

GLATRoi &	operator= (const GLATRoi &roi)
	Assignment operator.

virtual void	clear (void)
	Clear region of interest.

virtual GLATRoi *	clone (void) const
	Clone region of interest.

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

virtual bool	contains (const GEvent &event) const
	Check if region of interest contains an event.

virtual std::string	print (const GChatter &chatter=NORMAL) const
	Print region of interest information.

const GLATInstDir &	centre (void) const
	Returns region of interest centre.

const double &	radius (void) const
	Returns radius of region of interest in degrees.

void	centre (const GLATInstDir &centre)
	Set region of interest centre.

void	radius (const double &radius)
	Set radius of region of interest.

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

	GRoi (const GRoi &roi)
	Copy constructor.

virtual	~GRoi (void)
	Destructor.

virtual GRoi &	operator= (const GRoi &roi)
	Assignment operator.

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

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

void	copy_members (const GLATRoi &roi)
	Copy class members.

void	free_members (void)
	Delete class members.

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

void	copy_members (const GRoi &roi)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Attributes
GLATInstDir	m_centre
	Centre of ROI in instrument coordinates.

double	m_radius
	Radius of ROI in degrees.

Detailed Description

Fermi/LAT region of interest class.

The Fermi/LAT region of interest class defines the region of photon arrival directions that is used for unbinned data analysis. A circular region on the sky has been implemented.

Definition at line 45 of file GLATRoi.hpp.

Constructor & Destructor Documentation

◆ GLATRoi() [1/3]

GLATRoi::GLATRoi ( void )

Void constructor.

Definition at line 54 of file GLATRoi.cpp.

References init_members().

Referenced by clone().

◆ GLATRoi() [2/3]

GLATRoi::GLATRoi	(	const GLATInstDir &	centre,
		const double &	radius )

Region of interest constructor.

Parameters

[in]	centre	Region of interest centre.
[in]	radius	Radius of region of interest (degrees).

Definition at line 70 of file GLATRoi.cpp.

References centre(), init_members(), and radius().

◆ GLATRoi() [3/3]

GLATRoi::GLATRoi ( const GLATRoi & roi )

Copy constructor.

Parameters

[in] roi Region of interest.

Definition at line 89 of file GLATRoi.cpp.

References copy_members(), and init_members().

◆ ~GLATRoi()

GLATRoi::~GLATRoi ( void )

virtual

Destructor.

Definition at line 105 of file GLATRoi.cpp.

References free_members().

Member Function Documentation

◆ centre() [1/2]

void GLATRoi::centre ( const GLATInstDir & centre )

inline

Set region of interest centre.

Parameters

[in] centre Region of interest centre instrument direction.

Set the instrument direction of the region of interest centre.

Definition at line 130 of file GLATRoi.hpp.

References centre(), and m_centre.

◆ centre() [2/2]

const GLATInstDir & GLATRoi::centre ( void ) const

inline

Returns region of interest centre.

Returns: Region of interest centre instrument direction.

Returns the instrument direction of the region of interest centre.

Definition at line 102 of file GLATRoi.hpp.

References m_centre.

Referenced by centre(), and GLATRoi().

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GRoi.

Definition at line 88 of file GLATRoi.hpp.

◆ clear()

void GLATRoi::clear ( void )

virtual

Clear region of interest.

Implements GRoi.

Definition at line 160 of file GLATRoi.cpp.

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

Referenced by GLATEventList::init_members().

◆ clone()

GLATRoi * GLATRoi::clone ( void ) const

virtual

Clone region of interest.

Returns: Pointer to deep copy of region of interest

Implements GRoi.

Definition at line 180 of file GLATRoi.cpp.

References GLATRoi().

◆ contains()

bool GLATRoi::contains ( const GEvent & event ) const

virtual

Check if region of interest contains an event.

Returns: True if region of interest contains event, false otherwise

Implements GRoi.

Definition at line 191 of file GLATRoi.cpp.

References contains(), GLATInstDir::dir(), m_centre, and m_radius.

Referenced by contains().

◆ copy_members()

void GLATRoi::copy_members ( const GLATRoi & roi )

protected

Copy class members.

Parameters

[in] roi Region of interest from which members should be copied.

Definition at line 267 of file GLATRoi.cpp.

References m_centre, and m_radius.

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

◆ free_members()

void GLATRoi::free_members ( void )

protected

Delete class members.

Definition at line 281 of file GLATRoi.cpp.

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

◆ init_members()

void GLATRoi::init_members ( void )

protected

Initialise class members.

Definition at line 251 of file GLATRoi.cpp.

References GLATInstDir::clear(), m_centre, and m_radius.

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

◆ operator=()

GLATRoi & GLATRoi::operator= ( const GLATRoi & roi )

Assignment operator.

Parameters

[in] roi Region of interest.

Returns: Region of interest.

Definition at line 127 of file GLATRoi.cpp.

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

◆ print()

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

virtual

Print region of interest information.

Parameters

[in] chatter Chattiness.

Returns: String containing region of interest information.

Implements GRoi.

Definition at line 218 of file GLATRoi.cpp.

References m_centre, m_radius, gammalib::parformat(), GLATInstDir::print(), SILENT, and gammalib::str().

◆ radius() [1/2]

void GLATRoi::radius ( const double & radius )

inline

Set radius of region of interest.

Parameters

[in] radius Region of interest radius (degrees).

Set the radius of the region of interest.

Definition at line 145 of file GLATRoi.hpp.

References m_radius, and radius().

◆ radius() [2/2]

const double & GLATRoi::radius ( void ) const

inline

Returns radius of region of interest in degrees.

Returns: Region of interest radius (degrees).

Returns the radius of the region of interest in degrees.

Definition at line 116 of file GLATRoi.hpp.

References m_radius.

Referenced by GLATRoi(), and radius().

Member Data Documentation

◆ m_centre

GLATInstDir GLATRoi::m_centre

protected

Centre of ROI in instrument coordinates.

Definition at line 77 of file GLATRoi.hpp.

Referenced by centre(), centre(), contains(), copy_members(), init_members(), and print().

◆ m_radius

double GLATRoi::m_radius

protected

Radius of ROI in degrees.

Definition at line 78 of file GLATRoi.hpp.

Referenced by contains(), copy_members(), init_members(), print(), radius(), and radius().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GLATRoi() [1/3]

◆ GLATRoi() [2/3]

◆ GLATRoi() [3/3]

◆ ~GLATRoi()

Member Function Documentation

◆ centre() [1/2]

◆ centre() [2/2]

◆ classname()

◆ clear()

◆ clone()

◆ contains()

◆ copy_members()

◆ free_members()

◆ init_members()

◆ operator=()

◆ print()

◆ radius() [1/2]

◆ radius() [2/2]

Member Data Documentation

◆ m_centre

◆ m_radius