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

Abstract radial acceptance model class. More...

#include <GCTAModelRadial.hpp>

Inheritance diagram for GCTAModelRadial:
GCTAModelSpatial GBase GCTAModelRadialGauss GCTAModelRadialPolynom GCTAModelRadialProfile

Public Member Functions

 GCTAModelRadial (void)
 Void constructor. More...
 
 GCTAModelRadial (const GCTAModelRadial &model)
 Copy constructor. More...
 
virtual ~GCTAModelRadial (void)
 Destructor. More...
 
virtual GCTAModelRadialoperator= (const GCTAModelRadial &model)
 Assignment operator. More...
 
virtual double eval (const GCTAInstDir &dir, const GEnergy &energy, const GTime &time, const bool &gradients=false) const
 Evaluate function. More...
 
virtual GCTAInstDir mc (const GEnergy &energy, const GTime &time, const GCTAObservation &obs, GRan &ran) const
 Returns MC instrument direction. More...
 
virtual void clear (void)=0
 Clear object. More...
 
virtual GCTAModelRadialclone (void) const =0
 Clones object. More...
 
virtual std::string classname (void) const =0
 Return class name. More...
 
virtual std::string type (void) const =0
 
virtual double omega (void) const =0
 
virtual double mc_max_value (const GCTAObservation &obs) const =0
 
virtual void read (const GXmlElement &xml)=0
 
virtual void write (GXmlElement &xml) const =0
 
virtual std::string print (const GChatter &chatter=NORMAL) const =0
 Print content of object. More...
 
virtual double eval (const double &offset, const bool &gradients=false) const =0
 
virtual GCTAInstDir mc (GRan &ran) const =0
 
- Public Member Functions inherited from GCTAModelSpatial
 GCTAModelSpatial (void)
 Void constructor. More...
 
 GCTAModelSpatial (const GCTAModelSpatial &model)
 Copy constructor. More...
 
virtual ~GCTAModelSpatial (void)
 Destructor. More...
 
virtual GCTAModelSpatialoperator= (const GCTAModelSpatial &model)
 Assignment operator. More...
 
virtual GModelParoperator[] (const int &index)
 Returns model parameter. More...
 
virtual const GModelParoperator[] (const int &index) const
 Returns model parameter (const version) More...
 
virtual GModelParoperator[] (const std::string &name)
 Returns reference to model parameter. More...
 
virtual const GModelParoperator[] (const std::string &name) const
 Returns reference to model parameter (const version) More...
 
int size (void) const
 Return number of model parameters. More...
 
virtual double npred (const GEnergy &energy, const GTime &time, const GObservation &obs) const
 Return integral of spatial model component. 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 GCTAModelRadial &model)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 
- Protected Member Functions inherited from GCTAModelSpatial
void init_members (void)
 Initialise class members. More...
 
void copy_members (const GCTAModelSpatial &model)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Additional Inherited Members

- Protected Attributes inherited from GCTAModelSpatial
std::vector< GModelPar * > m_pars
 Parameter pointers. More...
 

Detailed Description

Abstract radial acceptance model class.

This class implements the radial component of the CTA radial acceptance model.

Definition at line 50 of file GCTAModelRadial.hpp.

Constructor & Destructor Documentation

GCTAModelRadial::GCTAModelRadial ( void  )

Void constructor.

Definition at line 55 of file GCTAModelRadial.cpp.

References init_members().

GCTAModelRadial::GCTAModelRadial ( const GCTAModelRadial model)

Copy constructor.

Parameters
[in]modelRadial background model.

Definition at line 70 of file GCTAModelRadial.cpp.

References copy_members(), and init_members().

GCTAModelRadial::~GCTAModelRadial ( void  )
virtual

Destructor.

Definition at line 86 of file GCTAModelRadial.cpp.

References free_members().

Member Function Documentation

virtual std::string GCTAModelRadial::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 GCTAModelSpatial.

Implemented in GCTAModelRadialProfile, GCTAModelRadialPolynom, and GCTAModelRadialGauss.

virtual void GCTAModelRadial::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 GCTAModelSpatial.

Implemented in GCTAModelRadialProfile, GCTAModelRadialPolynom, and GCTAModelRadialGauss.

virtual GCTAModelRadial* GCTAModelRadial::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 GCTAModelSpatial.

Implemented in GCTAModelRadialProfile, GCTAModelRadialPolynom, and GCTAModelRadialGauss.

Referenced by GCTAModelRadialAcceptance::copy_members(), GCTAModelRadialAcceptance::GCTAModelRadialAcceptance(), and GCTAModelRadialAcceptance::radial().

void GCTAModelRadial::copy_members ( const GCTAModelRadial model)
protected

Copy class members.

Parameters
[in]modelRadial acceptance model.

Definition at line 216 of file GCTAModelRadial.cpp.

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

double GCTAModelRadial::eval ( const GCTAInstDir dir,
const GEnergy energy,
const GTime time,
const bool &  gradients = false 
) const
virtual

Evaluate function.

Parameters
[in]dirEvent direction.
[in]energyEvent energy (not used).
[in]timeEvent time (not used).
[in]gradientsCompute gradients?
Returns
Function value

Evaluate radial model for a given event direction. The energy and time of the event are not used.

Implements GCTAModelSpatial.

Definition at line 146 of file GCTAModelRadial.cpp.

References gammalib::rad2deg, and GCTAInstDir::theta().

Referenced by GCTAModelRadialAcceptance::eval(), and GCTAModelRadialAcceptance::roi_kern::eval().

virtual double GCTAModelRadial::eval ( const double &  offset,
const bool &  gradients = false 
) const
pure virtual
void GCTAModelRadial::free_members ( void  )
protected
void GCTAModelRadial::init_members ( void  )
protected
GCTAInstDir GCTAModelRadial::mc ( const GEnergy energy,
const GTime time,
const GCTAObservation obs,
GRan ran 
) const
virtual

Returns MC instrument direction.

Parameters
[in]energyEvent energy (not used).
[in]timeEvent time (not used).
[in]obsCTA observation.
[in,out]ranRandom number generator.
Returns
Instrument direction

Return random instrument direction. The method sets the sky direction and the instrument coordinates of the instrument direction.

The energy and time of the event are not used.

Reimplemented from GCTAModelSpatial.

Definition at line 176 of file GCTAModelRadial.cpp.

References GCTAInstDir::dir(), and GCTAObservation::pointing().

Referenced by GCTAModelRadialAcceptance::mc().

virtual GCTAInstDir GCTAModelRadial::mc ( GRan ran) const
pure virtual
virtual double GCTAModelRadial::mc_max_value ( const GCTAObservation obs) const
pure virtual
virtual double GCTAModelRadial::omega ( void  ) const
pure virtual
GCTAModelRadial & GCTAModelRadial::operator= ( const GCTAModelRadial model)
virtual

Assignment operator.

Parameters
[in]modelRadial background model.

Definition at line 107 of file GCTAModelRadial.cpp.

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

Referenced by GCTAModelRadialGauss::operator=(), GCTAModelRadialPolynom::operator=(), and GCTAModelRadialProfile::operator=().

virtual std::string GCTAModelRadial::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 GCTAModelSpatial.

Implemented in GCTAModelRadialProfile, GCTAModelRadialPolynom, and GCTAModelRadialGauss.

virtual void GCTAModelRadial::read ( const GXmlElement xml)
pure virtual
virtual std::string GCTAModelRadial::type ( void  ) const
pure virtual
virtual void GCTAModelRadial::write ( GXmlElement xml) const
pure virtual

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