GCTABackground Class Reference

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

#include <GCTABackground.hpp>

Inheritance diagram for GCTABackground:

Public Member Functions
	GCTABackground (void)
	Void constructor.
	GCTABackground (const GCTABackground &bgd)
	Copy constructor.
virtual	~GCTABackground (void)
	Destructor.
virtual double	operator() (const double &logE, const double &detx, const double &dety) const =0
GCTABackground &	operator= (const GCTABackground &bgd)
	Assignment operator.
virtual void	clear (void)=0
	Clear object.
virtual GCTABackground *	clone (void) const =0
	Clones object.
virtual std::string	classname (void) const =0
	Return class name.
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.
Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor.

Protected Member Functions
void	init_members (void)
	Initialise class members.
void	copy_members (const GCTABackground &bgd)
	Copy class members.
void	free_members (void)
	Delete class members.

Detailed Description

Abstract base class for the CTA background model.

Definition at line 48 of file GCTABackground.hpp.

Constructor & Destructor Documentation

GCTABackground() [1/2]

GCTABackground::GCTABackground

(

void

)

Void constructor.

Definition at line 53 of file GCTABackground.cpp.

References init_members().

GCTABackground() [2/2]

GCTABackground::GCTABackground

(

const GCTABackground &

bgd

)

Copy constructor.

Parameters

[in]

bgd

CTA background.

Definition at line 68 of file GCTABackground.cpp.

References copy_members(), and init_members().

~GCTABackground()

GCTABackground::~GCTABackground ( void )

virtual

Destructor.

Definition at line 84 of file GCTABackground.cpp.

References free_members().

Member Function Documentation

classname()

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.

clear()

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.

clone()

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().

copy_members()

void GCTABackground::copy_members ( const GCTABackground & bgd )

protected

Copy class members.

Parameters

[in]

bgd

CTA background.

Definition at line 154 of file GCTABackground.cpp.

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

filename()

virtual GFilename GCTABackground::filename ( void ) const

pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

free_members()

void GCTABackground::free_members ( void )

protected

Delete class members.

Definition at line 164 of file GCTABackground.cpp.

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

init_members()

void GCTABackground::init_members ( void )

protected

Initialise class members.

Definition at line 142 of file GCTABackground.cpp.

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

load()

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

pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

mc()

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().

operator()()

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

pure virtual

Implemented in GCTABackground2D, GCTABackground3D, and GCTABackgroundPerfTable.

operator=()

GCTABackground & GCTABackground::operator=

(

const GCTABackground &

bgd

)

Assignment operator.

Parameters

[in]

bgd

CTA background.

Returns

CTA background.

Definition at line 106 of file GCTABackground.cpp.

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

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

print()

virtual std::string GCTABackground::print ( const GChatter & chatter = NORMAL ) const

pure virtual

Print content of object.

Parameters

[in]

chatter

Chattiness (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().

rate_ebin()

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().

spectrum()

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:

• inst/cta/include/GCTABackground.hpp
• inst/cta/src/GCTABackground.cpp