GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GRoi Class Referenceabstract

Interface for the region of interest classes. More...

#include <GRoi.hpp>

Inheritance diagram for GRoi:
GBase GCOMRoi GCTARoi GLATRoi

Public Member Functions

 GRoi (void)
 Void constructor. More...
 
 GRoi (const GRoi &roi)
 Copy constructor. More...
 
virtual ~GRoi (void)
 Destructor. More...
 
virtual GRoioperator= (const GRoi &roi)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GRoiclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual bool contains (const GEvent &event) const =0
 
virtual std::string print (const GChatter &chatter=NORMAL) const =0
 Print content of object. 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 GRoi &roi)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Friends

class GObservation
 

Detailed Description

Interface for the region of interest classes.

The region of interest class holds instrument specific information about the spatial region in detector or telescopes coordinates that is used for an analysis. In particular, the definition of a region of interest is required for an unbinned analysis.

Definition at line 48 of file GRoi.hpp.

Constructor & Destructor Documentation

GRoi::GRoi ( void  )

Void constructor.

Definition at line 52 of file GRoi.cpp.

References init_members().

GRoi::GRoi ( const GRoi roi)

Copy constructor.

Parameters
[in]roiRegion of interest from which the instance should be built.

Definition at line 67 of file GRoi.cpp.

References copy_members(), and init_members().

GRoi::~GRoi ( void  )
virtual

Destructor.

Definition at line 83 of file GRoi.cpp.

References free_members().

Member Function Documentation

virtual std::string GRoi::classname ( void  ) const
pure virtual

Return class name.

Returns
String containing the class name.

Returns the class name for non-abstract classes in a human readable way.

Implements GBase.

Implemented in GCTARoi, GCOMRoi, and GLATRoi.

virtual void GRoi::clear ( void  )
pure virtual

Clear object.

Sets the object to a clean initial state. After calling the method the object will be in the same state as it were if an empty instance of the object would have been created.

Implements GBase.

Implemented in GCTARoi, GCOMRoi, and GLATRoi.

virtual GRoi* GRoi::clone ( void  ) const
pure virtual

Clones object.

Returns
Pointer to deep copy of object.

Creates a deep copy of the object and returns a pointer to the object.

Implements GBase.

Implemented in GCTARoi, GCOMRoi, and GLATRoi.

virtual bool GRoi::contains ( const GEvent event) const
pure virtual

Implemented in GCTARoi, GCOMRoi, and GLATRoi.

void GRoi::copy_members ( const GRoi roi)
protected

Copy class members.

Parameters
[in]roiRegion of interest from which members should be copied.

Definition at line 153 of file GRoi.cpp.

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

void GRoi::free_members ( void  )
protected

Delete class members.

Definition at line 163 of file GRoi.cpp.

Referenced by GCOMRoi::clear(), GLATRoi::clear(), GCTARoi::clear(), operator=(), and ~GRoi().

void GRoi::init_members ( void  )
protected

Initialise class members.

Definition at line 141 of file GRoi.cpp.

Referenced by GCOMRoi::clear(), GLATRoi::clear(), GCTARoi::clear(), GRoi(), and operator=().

GRoi & GRoi::operator= ( const GRoi roi)
virtual

Assignment operator.

Parameters
[in]roiRegion of interest which should be assigned.

Definition at line 104 of file GRoi.cpp.

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

Referenced by GCOMRoi::operator=(), GLATRoi::operator=(), and GCTARoi::operator=().

virtual std::string GRoi::print ( const GChatter chatter = NORMAL) const
pure virtual

Print content of object.

Parameters
[in]chatterChattiness (defaults to NORMAL).
Returns
String containing the content of the object.

Formats the content in a standard way and puts this content in a C++ string that is returned.

Implements GBase.

Implemented in GCTARoi, GCOMRoi, and GLATRoi.

Friends And Related Function Documentation

friend class GObservation
friend

Definition at line 51 of file GRoi.hpp.


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