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

Abstract base class for the CTA effective area. More...

#include <GCTAAeff.hpp>

Inheritance diagram for GCTAAeff:
GBase GCTAAeff2D GCTAAeffArf GCTAAeffPerfTable

Public Member Functions

 GCTAAeff (void)
 Void constructor. More...
 
 GCTAAeff (const GCTAAeff &aeff)
 Copy constructor. More...
 
virtual ~GCTAAeff (void)
 Destructor. More...
 
virtual double operator() (const double &logE, const double &theta=0.0, const double &phi=0.0, const double &zenith=0.0, const double &azimuth=0.0, const bool &etrue=true) const =0
 
GCTAAeffoperator= (const GCTAAeff &aeff)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTAAeffclone (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 double max (const double &logE, const double &zenith, const double &azimuth, const bool &etrue=true) const =0
 
virtual GEbounds ebounds (void) 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 GCTAAeff &aeff)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Detailed Description

Abstract base class for the CTA effective area.

This class implements the abstract base class for the CTA effective area. The effective area is accessed using the following arguments logE - log10 of true (or measured) energy in TeV theta - Offset angle of true photon direction in camera system (rad) phi - Azimuth angle of true photon direction in camera system (rad) zenith - Zenith angle of pointing in Earth system (rad) azimuth - Azimuth angle of pointing in Earth system (rad) etrue - Use true or measured energy

Definition at line 54 of file GCTAAeff.hpp.

Constructor & Destructor Documentation

GCTAAeff::GCTAAeff ( void  )

Void constructor.

Definition at line 53 of file GCTAAeff.cpp.

References init_members().

GCTAAeff::GCTAAeff ( const GCTAAeff aeff)

Copy constructor.

Parameters
[in]aeffEffective area.

Definition at line 68 of file GCTAAeff.cpp.

References copy_members(), and init_members().

GCTAAeff::~GCTAAeff ( void  )
virtual

Destructor.

Definition at line 84 of file GCTAAeff.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTAAeff::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 GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

virtual void GCTAAeff::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 GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

virtual GCTAAeff* GCTAAeff::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 GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

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

void GCTAAeff::copy_members ( const GCTAAeff aeff)
protected

Copy class members.

Parameters
[in]aeffEffective area.

Definition at line 154 of file GCTAAeff.cpp.

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

virtual GEbounds GCTAAeff::ebounds ( void  ) const
pure virtual

Implemented in GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

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

Implemented in GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

Referenced by GCTAResponseIrf::write().

void GCTAAeff::free_members ( void  )
protected

Delete class members.

Definition at line 164 of file GCTAAeff.cpp.

Referenced by GCTAAeffPerfTable::clear(), GCTAAeffArf::clear(), GCTAAeff2D::clear(), operator=(), and ~GCTAAeff().

void GCTAAeff::init_members ( void  )
protected

Initialise class members.

Definition at line 142 of file GCTAAeff.cpp.

Referenced by GCTAAeffPerfTable::clear(), GCTAAeffArf::clear(), GCTAAeff2D::clear(), GCTAAeff(), and operator=().

virtual void GCTAAeff::load ( const GFilename filename)
pure virtual

Implemented in GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

virtual double GCTAAeff::max ( const double &  logE,
const double &  zenith,
const double &  azimuth,
const bool &  etrue = true 
) const
pure virtual
virtual double GCTAAeff::operator() ( const double &  logE,
const double &  theta = 0.0,
const double &  phi = 0.0,
const double &  zenith = 0.0,
const double &  azimuth = 0.0,
const bool &  etrue = true 
) const
pure virtual

Implemented in GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

GCTAAeff & GCTAAeff::operator= ( const GCTAAeff aeff)

Assignment operator.

Parameters
[in]aeffEffective area.
Returns
Effective area.

Definition at line 106 of file GCTAAeff.cpp.

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

Referenced by GCTAAeffPerfTable::operator=(), GCTAAeffArf::operator=(), and GCTAAeff2D::operator=().

virtual std::string GCTAAeff::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 GCTAAeff2D, GCTAAeffArf, and GCTAAeffPerfTable.

Referenced by GCTAResponseIrf::print().


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