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

#include <GCTAPsf.hpp>

Inheritance diagram for GCTAPsf:

Public Member Functions
	GCTAPsf (void)
	Void constructor.

	GCTAPsf (const GCTAPsf &psf)
	Copy constructor.

virtual	~GCTAPsf (void)
	Destructor.

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

GCTAPsf &	operator= (const GCTAPsf &psf)
	Assignment operator.

virtual void	clear (void)=0
	Clear object.

virtual GCTAPsf *	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 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.

Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor.

Protected Member Functions
void	init_members (void)
	Initialise class members.

void	copy_members (const GCTAPsf &psf)
	Copy class members.

void	free_members (void)
	Delete class members.

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() [1/2]

GCTAPsf::GCTAPsf ( void )

Void constructor.

Definition at line 53 of file GCTAPsf.cpp.

References init_members().

◆ GCTAPsf() [2/2]

GCTAPsf::GCTAPsf ( const GCTAPsf & psf )

Copy constructor.

Parameters

[in] psf Point spread function.

Definition at line 68 of file GCTAPsf.cpp.

References copy_members(), and init_members().

◆ ~GCTAPsf()

GCTAPsf::~GCTAPsf ( void )

virtual

Destructor.

Definition at line 84 of file GCTAPsf.cpp.

References free_members().

Member Function Documentation

◆ classname()

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, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ clear()

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, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ clone()

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, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

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

◆ containment_radius()

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

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ copy_members()

void GCTAPsf::copy_members ( const GCTAPsf & psf )

protected

Copy class members.

Parameters

[in] psf Point spread function.

Definition at line 154 of file GCTAPsf.cpp.

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

◆ delta_max()

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

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

Referenced by GCTAResponseIrf::psf_delta_max().

◆ filename()

virtual GFilename GCTAPsf::filename ( void ) const

pure virtual

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ free_members()

void GCTAPsf::free_members ( void )

protected

Delete class members.

Definition at line 164 of file GCTAPsf.cpp.

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

◆ init_members()

void GCTAPsf::init_members ( void )

protected

Initialise class members.

Definition at line 142 of file GCTAPsf.cpp.

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

◆ load()

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

pure virtual

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ mc()

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

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

Referenced by GCTAResponseIrf::mc().

◆ operator()()

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

Implemented in GCTAPsf2D, GCTAPsfKing, GCTAPsfPerfTable, GCTAPsfTable, and GCTAPsfVector.

◆ operator=()

GCTAPsf & GCTAPsf::operator= ( const GCTAPsf & psf )

Assignment operator.

Parameters

[in] psf Point spread function.

Returns: Point spread function.

Definition at line 106 of file GCTAPsf.cpp.

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

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

◆ print()

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

Referenced by GCTAResponseIrf::print().

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

inst/cta/include/GCTAPsf.hpp
inst/cta/src/GCTAPsf.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ GCTAPsf() [1/2]

◆ GCTAPsf() [2/2]

◆ ~GCTAPsf()

Member Function Documentation

◆ classname()

◆ clear()

◆ clone()

◆ containment_radius()

◆ copy_members()

◆ delta_max()

◆ filename()

◆ free_members()

◆ init_members()

◆ load()

◆ mc()

◆ operator()()

◆ operator=()

◆ print()