GammaLib  2.1.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | List of all members
GCTABackground Class Referenceabstract

Abstract base class for the CTA background model. More...

#include <GCTABackground.hpp>

Inheritance diagram for GCTABackground:
GBase GCTABackground2D GCTABackground3D GCTABackgroundPerfTable

Public Member Functions

 GCTABackground (void)
 Void constructor. More...
 
 GCTABackground (const GCTABackground &bgd)
 Copy constructor. More...
 
virtual ~GCTABackground (void)
 Destructor. More...
 
virtual double operator() (const double &logE, const double &detx, const double &dety) const =0
 
GCTABackground & operator= (const GCTABackground &bgd)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTABackground * clone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual void load (const GFilename &filename)=0
 
virtual GFilename filename (void) const =0
 
virtual GCTAInstDir mc (const GEnergy &energy, const GTime &time, GRan &ran) const =0
 
virtual const GModelSpectralNodes & spectrum (void) const =0
 
virtual double rate_ebin (const GCTAInstDir &dir, const GEnergy &emin, const GEnergy &emax) 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 GCTABackground &bgd)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Detailed Description

Abstract base class for the CTA background model.

Definition at line 48 of file GCTABackground.hpp.

Constructor & Destructor Documentation

GCTABackground::GCTABackground ( void  )

Void constructor.

Definition at line 53 of file GCTABackground.cpp.

References init_members().

GCTABackground::GCTABackground ( const GCTABackground &  bgd)

Copy constructor.

Parameters
[in]bgdCTA background.

Definition at line 68 of file GCTABackground.cpp.

References copy_members(), and init_members().

GCTABackground::~GCTABackground ( void  )
virtual

Destructor.

Definition at line 84 of file GCTABackground.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTABackground::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 GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

virtual void GCTABackground::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 GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

virtual GCTABackground* GCTABackground::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 GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

Referenced by GCTAResponseIrf::background(), and GCTAResponseIrf::copy_members().

void GCTABackground::copy_members ( const GCTABackground &  bgd)
protected

Copy class members.

Parameters
[in]bgdCTA background.

Definition at line 154 of file GCTABackground.cpp.

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

virtual GFilename GCTABackground::filename ( void  ) const
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

void GCTABackground::free_members ( void  )
protected

Delete class members.

Definition at line 164 of file GCTABackground.cpp.

Referenced by GCTABackgroundPerfTable::clear(), GCTABackground3D::clear(), GCTABackground2D::clear(), operator=(), and ~GCTABackground().

void GCTABackground::init_members ( void  )
protected

Initialise class members.

Definition at line 142 of file GCTABackground.cpp.

Referenced by GCTABackgroundPerfTable::clear(), GCTABackground3D::clear(), GCTABackground2D::clear(), GCTABackground(), and operator=().

virtual void GCTABackground::load ( const GFilename &  filename)
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

virtual GCTAInstDir GCTABackground::mc ( const GEnergy &  energy,
const GTime &  time,
GRan &  ran 
) const
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

Referenced by GCTAModelIrfBackground::mc().

virtual double GCTABackground::operator() ( const double &  logE,
const double &  detx,
const double &  dety 
) const
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

GCTABackground & GCTABackground::operator= ( const GCTABackground &  bgd)

Assignment operator.

Parameters
[in]bgdCTA background.
Returns
CTA background.

Definition at line 106 of file GCTABackground.cpp.

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

Referenced by GCTABackgroundPerfTable::operator=(), GCTABackground2D::operator=(), and GCTABackground3D::operator=().

virtual std::string GCTABackground::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 GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

Referenced by GCTAResponseIrf::print().

virtual double GCTABackground::rate_ebin ( const GCTAInstDir &  dir,
const GEnergy &  emin,
const GEnergy &  emax 
) const
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

Referenced by GCTAModelIrfBackground::eval().

virtual const GModelSpectralNodes& GCTABackground::spectrum ( void  ) const
pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

Referenced by GCTAModelIrfBackground::mc().

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