COMPTEL region of interest class. More...

#include <GCOMRoi.hpp>

Inheritance diagram for GCOMRoi:

Public Member Functions
	GCOMRoi (void)
	Void constructor.

	GCOMRoi (const GCOMRoi &roi)
	Copy constructor.

	GCOMRoi (const GCOMInstDir &centre, const double &radius, const double &phibar_min, const double &phibar_max)
	Region of interest constructor.

virtual	~GCOMRoi (void)
	Destructor.

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

virtual void	clear (void)
	Clear region of interest.

virtual GCOMRoi *	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 GCOMInstDir &	centre (void) const
	Return centre of region of interest.

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

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

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

const double &	phibar_min (void) const
	Return minimum Phibar of region of interest.

void	phibar_min (const double &phibar_min)
	Set minimum Phibar of region of interest.

const double &	phibar_max (void) const
	Return maximum Phibar of region of interest.

void	phibar_max (const double &phibar_max)
	Set maximum Phibar 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 GCOMRoi &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
GCOMInstDir	m_centre
	Centre of RoI in instrument coordinates.

double	m_radius
	Radius of region of interest.

double	m_phibar_min
	Minimum Phibar of region of interest.

double	m_phibar_max
	Minimum Phibar of region of interest.

Detailed Description

COMPTEL region of interest class.

The COMPTEL region of interest class defines the event direction region that is used for unbinned data analysis.

Definition at line 44 of file GCOMRoi.hpp.

Constructor & Destructor Documentation

◆ GCOMRoi() [1/3]

GCOMRoi::GCOMRoi ( void )

Void constructor.

Definition at line 54 of file GCOMRoi.cpp.

References init_members().

Referenced by clone().

◆ GCOMRoi() [2/3]

GCOMRoi::GCOMRoi ( const GCOMRoi & roi )

Copy constructor.

Parameters

[in] roi COMPTEL region of interest.

Definition at line 69 of file GCOMRoi.cpp.

References copy_members(), and init_members().

◆ GCOMRoi() [3/3]

GCOMRoi::GCOMRoi	(	const GCOMInstDir &	centre,
		const double &	radius,
		const double &	phibar_min,
		const double &	phibar_max )

Region of interest constructor.

Parameters

[in]	centre	Instrument direction centre.
[in]	radius	Instrument direction radius.
[in]	phibar_min	Phibar minimum (deg).
[in]	phibar_max	Phibar maximum (deg).

Definition at line 90 of file GCOMRoi.cpp.

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

◆ ~GCOMRoi()

GCOMRoi::~GCOMRoi ( void )

virtual

Destructor.

Definition at line 111 of file GCOMRoi.cpp.

References free_members().

Member Function Documentation

◆ centre() [1/2]

void GCOMRoi::centre ( const GCOMInstDir & centre )

inline

Set centre of region of interest.

Parameters

[in] centre Instrument direction.

Set the instrument direction of the centre of the region of interest.

Definition at line 122 of file GCOMRoi.hpp.

References centre(), and m_centre.

◆ centre() [2/2]

const GCOMInstDir & GCOMRoi::centre ( void ) const

inline

Return centre of region of interest.

Returns: Centre of region of interest centre.

Returns the instrument direction of the centre of the region of interest.

Definition at line 108 of file GCOMRoi.hpp.

References m_centre.

Referenced by centre(), and GCOMRoi().

◆ classname()

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

inlinevirtual

Return class name.

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

Implements GRoi.

Definition at line 94 of file GCOMRoi.hpp.

◆ clear()

void GCOMRoi::clear ( void )

virtual

Clear region of interest.

Implements GRoi.

Definition at line 166 of file GCOMRoi.cpp.

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

Referenced by GCOMEventList::init_members().

◆ clone()

GCOMRoi * GCOMRoi::clone ( void ) const

virtual

Clone region of interest.

Returns: Pointer to deep copy of COMPTEL region of interest.

Implements GRoi.

Definition at line 186 of file GCOMRoi.cpp.

References GCOMRoi().

◆ contains()

bool GCOMRoi::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 197 of file GCOMRoi.cpp.

References contains(), GCOMInstDir::dir(), m_centre, m_phibar_max, m_phibar_min, m_radius, and GCOMInstDir::phibar().

Referenced by contains().

◆ copy_members()

void GCOMRoi::copy_members ( const GCOMRoi & roi )

protected

Copy class members.

Parameters

[in] roi COMPTEL region of interest.

Definition at line 282 of file GCOMRoi.cpp.

References m_centre, m_phibar_max, m_phibar_min, and m_radius.

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

◆ free_members()

void GCOMRoi::free_members ( void )

protected

Delete class members.

Definition at line 298 of file GCOMRoi.cpp.

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

◆ init_members()

void GCOMRoi::init_members ( void )

protected

Initialise class members.

Definition at line 264 of file GCOMRoi.cpp.

References GCOMInstDir::clear(), m_centre, m_phibar_max, m_phibar_min, and m_radius.

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

◆ operator=()

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

Assignment operator.

Parameters

[in] roi COMPTEL region of interest.

Returns: COMPTEL region of interest.

Definition at line 133 of file GCOMRoi.cpp.

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

◆ phibar_max() [1/2]

void GCOMRoi::phibar_max ( const double & phibar_max )

inline

Set maximum Phibar of region of interest.

Parameters

[in] phibar_max Maximum Phibar of region of interest (deg).

Set the maximum Phibar of region of interest.

Definition at line 209 of file GCOMRoi.hpp.

References m_phibar_max, and phibar_max().

◆ phibar_max() [2/2]

const double & GCOMRoi::phibar_max ( void ) const

inline

Return maximum Phibar of region of interest.

Returns: Maximum Phibar of region of interest (deg).

Returns the maximum Phibar of region of interest.

Definition at line 195 of file GCOMRoi.hpp.

References m_phibar_max.

Referenced by GCOMRoi(), and phibar_max().

◆ phibar_min() [1/2]

void GCOMRoi::phibar_min ( const double & phibar_min )

inline

Set minimum Phibar of region of interest.

Parameters

[in] phibar_min Minimum Phibar of region of interest (deg).

Set the minimum Phibar of region of interest.

Definition at line 180 of file GCOMRoi.hpp.

References m_phibar_min, and phibar_min().

◆ phibar_min() [2/2]

const double & GCOMRoi::phibar_min ( void ) const

inline

Return minimum Phibar of region of interest.

Returns: Minimum Phibar of region of interest (deg).

Returns the minimum Phibar of region of interest.

Definition at line 166 of file GCOMRoi.hpp.

References m_phibar_min.

Referenced by GCOMRoi(), and phibar_min().

◆ print()

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

virtual

Print region of interest information.

Parameters

[in] chatter Chattiness.

Returns: String containing region of interest information.

Todo: Implement method.

Implements GRoi.

Definition at line 228 of file GCOMRoi.cpp.

References m_centre, m_phibar_max, m_phibar_min, m_radius, gammalib::parformat(), GCOMInstDir::print(), SILENT, and gammalib::str().

◆ radius() [1/2]

void GCOMRoi::radius ( const double & radius )

inline

Set radius of region of interest.

Parameters

[in] radius Radius of region of interest (deg).

Set the radius of the region of interest.

Definition at line 151 of file GCOMRoi.hpp.

References m_radius, and radius().

◆ radius() [2/2]

const double & GCOMRoi::radius ( void ) const

inline

Return radius of region of interest.

Returns: Radius of region of interest (deg).

Returns the radius of the region of interest.

Definition at line 137 of file GCOMRoi.hpp.

References m_radius.

Referenced by GCOMRoi(), and radius().

Member Data Documentation

◆ m_centre

GCOMInstDir GCOMRoi::m_centre

protected

Centre of RoI in instrument coordinates.

Definition at line 81 of file GCOMRoi.hpp.

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

◆ m_phibar_max

double GCOMRoi::m_phibar_max

protected

Minimum Phibar of region of interest.

Definition at line 84 of file GCOMRoi.hpp.

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

◆ m_phibar_min

double GCOMRoi::m_phibar_min

protected

Minimum Phibar of region of interest.

Definition at line 83 of file GCOMRoi.hpp.

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

◆ m_radius

double GCOMRoi::m_radius

protected

Radius of region of interest.

Definition at line 82 of file GCOMRoi.hpp.

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

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

inst/com/include/GCOMRoi.hpp
inst/com/src/GCOMRoi.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GCOMRoi() [1/3]

◆ GCOMRoi() [2/3]

◆ GCOMRoi() [3/3]

◆ ~GCOMRoi()

Member Function Documentation

◆ centre() [1/2]

◆ centre() [2/2]

◆ classname()

◆ clear()

◆ clone()

◆ contains()

◆ copy_members()

◆ free_members()

◆ init_members()

◆ operator=()

◆ phibar_max() [1/2]

◆ phibar_max() [2/2]

◆ phibar_min() [1/2]

◆ phibar_min() [2/2]

◆ print()

◆ radius() [1/2]

◆ radius() [2/2]

Member Data Documentation

◆ m_centre

◆ m_phibar_max

◆ m_phibar_min

◆ m_radius