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

Abstract base class for the CTA energy dispersion. More...

#include <GCTAEdisp.hpp>

Inheritance diagram for GCTAEdisp:
GBase GCTAEdisp2D GCTAEdispPerfTable GCTAEdispRmf

Public Member Functions

 GCTAEdisp (void)
 Void constructor. More...
 
 GCTAEdisp (const GCTAEdisp &edisp)
 Copy constructor. More...
 
virtual ~GCTAEdisp (void)
 Destructor. More...
 
virtual double operator() (const GEnergy &ereco, const GEnergy &etrue, const double &theta=0.0, const double &phi=0.0, const double &zenith=0.0, const double &azimuth=0.0) const =0
 
GCTAEdispoperator= (const GCTAEdisp &edisp)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTAEdispclone (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 GEnergy mc (GRan &ran, const GEnergy &etrue, const double &theta=0.0, const double &phi=0.0, const double &zenith=0.0, const double &azimuth=0.0) const =0
 
virtual GEbounds ereco_bounds (const GEnergy &etrue, const double &theta=0.0, const double &phi=0.0, const double &zenith=0.0, const double &azimuth=0.0) const =0
 
virtual GEbounds etrue_bounds (const GEnergy &ereco, const double &theta=0.0, const double &phi=0.0, const double &zenith=0.0, const double &azimuth=0.0) const =0
 
virtual double prob_erecobin (const GEnergy &ereco_min, const GEnergy &ereco_max, const GEnergy &etrue, const double &theta) 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 GCTAEdisp &edisp)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Detailed Description

Abstract base class for the CTA energy dispersion.

This class implements the abstract base class for the CTA energy dispersion.

Definition at line 49 of file GCTAEdisp.hpp.

Constructor & Destructor Documentation

GCTAEdisp::GCTAEdisp ( void  )

Void constructor.

Definition at line 53 of file GCTAEdisp.cpp.

References init_members().

GCTAEdisp::GCTAEdisp ( const GCTAEdisp edisp)

Copy constructor.

Parameters
[in]edispEnergy dispersion.

Definition at line 68 of file GCTAEdisp.cpp.

References copy_members(), and init_members().

GCTAEdisp::~GCTAEdisp ( void  )
virtual

Destructor.

Definition at line 84 of file GCTAEdisp.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTAEdisp::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 GCTAEdisp2D, GCTAEdispPerfTable, and GCTAEdispRmf.

virtual void GCTAEdisp::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 GCTAEdisp2D, GCTAEdispPerfTable, and GCTAEdispRmf.

virtual GCTAEdisp* GCTAEdisp::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 GCTAEdisp2D, GCTAEdispPerfTable, and GCTAEdispRmf.

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

void GCTAEdisp::copy_members ( const GCTAEdisp edisp)
protected

Copy class members.

Parameters
[in]edispEnergy dispersion.

Definition at line 154 of file GCTAEdisp.cpp.

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

virtual GEbounds GCTAEdisp::ereco_bounds ( const GEnergy etrue,
const double &  theta = 0.0,
const double &  phi = 0.0,
const double &  zenith = 0.0,
const double &  azimuth = 0.0 
) const
pure virtual
virtual GEbounds GCTAEdisp::etrue_bounds ( const GEnergy ereco,
const double &  theta = 0.0,
const double &  phi = 0.0,
const double &  zenith = 0.0,
const double &  azimuth = 0.0 
) const
pure virtual
virtual GFilename GCTAEdisp::filename ( void  ) const
pure virtual
void GCTAEdisp::free_members ( void  )
protected

Delete class members.

Definition at line 164 of file GCTAEdisp.cpp.

Referenced by GCTAEdispRmf::clear(), GCTAEdispPerfTable::clear(), GCTAEdisp2D::clear(), operator=(), and ~GCTAEdisp().

void GCTAEdisp::init_members ( void  )
protected

Initialise class members.

Definition at line 142 of file GCTAEdisp.cpp.

Referenced by GCTAEdispRmf::clear(), GCTAEdispPerfTable::clear(), GCTAEdisp2D::clear(), GCTAEdisp(), and operator=().

virtual void GCTAEdisp::load ( const GFilename filename)
pure virtual
virtual GEnergy GCTAEdisp::mc ( GRan ran,
const GEnergy etrue,
const double &  theta = 0.0,
const double &  phi = 0.0,
const double &  zenith = 0.0,
const double &  azimuth = 0.0 
) const
pure virtual

Implemented in GCTAEdisp2D, GCTAEdispPerfTable, and GCTAEdispRmf.

Referenced by GCTAResponseIrf::mc().

virtual double GCTAEdisp::operator() ( const GEnergy ereco,
const GEnergy etrue,
const double &  theta = 0.0,
const double &  phi = 0.0,
const double &  zenith = 0.0,
const double &  azimuth = 0.0 
) const
pure virtual
GCTAEdisp & GCTAEdisp::operator= ( const GCTAEdisp edisp)

Assignment operator.

Parameters
[in]edispEnergy dispersion.
Returns
Energy dispersion.

Definition at line 106 of file GCTAEdisp.cpp.

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

Referenced by GCTAEdispRmf::operator=(), GCTAEdispPerfTable::operator=(), and GCTAEdisp2D::operator=().

virtual std::string GCTAEdisp::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 GCTAEdisp2D, GCTAEdispPerfTable, and GCTAEdispRmf.

Referenced by GCTAResponseIrf::print().

virtual double GCTAEdisp::prob_erecobin ( const GEnergy ereco_min,
const GEnergy ereco_max,
const GEnergy etrue,
const double &  theta 
) const
pure virtual

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