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

Abstract base class for the CTA point spread function. More...

#include <GCTAPsf.hpp>

Inheritance diagram for GCTAPsf:
GBase GCTAPsf2D GCTAPsfKing GCTAPsfPerfTable GCTAPsfTable GCTAPsfVector

Public Member Functions

 GCTAPsf (void)
 Void constructor. More...
 
 GCTAPsf (const GCTAPsf &psf)
 Copy constructor. More...
 
virtual ~GCTAPsf (void)
 Destructor. More...
 
virtual double operator() (const double &delta, 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
 
GCTAPsfoperator= (const GCTAPsf &psf)
 Assignment operator. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTAPsfclone (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 mc (GRan &ran, 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
 
virtual double delta_max (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
 
virtual double containment_radius (const double &fraction, 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
 
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 GCTAPsf &psf)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Detailed Description

Abstract base class for the CTA point spread function.

This class implements the abstract base class for the CTA point spread function.

Definition at line 47 of file GCTAPsf.hpp.

Constructor & Destructor Documentation

GCTAPsf::GCTAPsf ( void  )

Void constructor.

Definition at line 53 of file GCTAPsf.cpp.

References init_members().

GCTAPsf::GCTAPsf ( const GCTAPsf psf)

Copy constructor.

Parameters
[in]psfPoint spread function.

Definition at line 68 of file GCTAPsf.cpp.

References copy_members(), and init_members().

GCTAPsf::~GCTAPsf ( void  )
virtual

Destructor.

Definition at line 84 of file GCTAPsf.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTAPsf::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 GCTAPsf2D, GCTAPsfKing, GCTAPsfTable, GCTAPsfPerfTable, and GCTAPsfVector.

virtual void GCTAPsf::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 GCTAPsf2D, GCTAPsfKing, GCTAPsfTable, GCTAPsfPerfTable, and GCTAPsfVector.

virtual GCTAPsf* GCTAPsf::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 GCTAPsf2D, GCTAPsfKing, GCTAPsfTable, GCTAPsfPerfTable, and GCTAPsfVector.

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

virtual double GCTAPsf::containment_radius ( const double &  fraction,
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
void GCTAPsf::copy_members ( const GCTAPsf psf)
protected

Copy class members.

Parameters
[in]psfPoint spread function.

Definition at line 154 of file GCTAPsf.cpp.

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

virtual double GCTAPsf::delta_max ( 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
virtual GFilename GCTAPsf::filename ( void  ) const
pure virtual
void GCTAPsf::free_members ( void  )
protected
void GCTAPsf::init_members ( void  )
protected
virtual void GCTAPsf::load ( const GFilename filename)
pure virtual
virtual double GCTAPsf::mc ( GRan ran,
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
virtual double GCTAPsf::operator() ( const double &  delta,
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
GCTAPsf & GCTAPsf::operator= ( const GCTAPsf psf)

Assignment operator.

Parameters
[in]psfPoint spread function.
Returns
Point spread function.

Definition at line 106 of file GCTAPsf.cpp.

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

Referenced by GCTAPsfPerfTable::operator=(), GCTAPsfVector::operator=(), GCTAPsfTable::operator=(), GCTAPsf2D::operator=(), and GCTAPsfKing::operator=().

virtual std::string GCTAPsf::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 GCTAPsfKing, GCTAPsf2D, GCTAPsfTable, GCTAPsfPerfTable, and GCTAPsfVector.

Referenced by GCTAResponseIrf::print().


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