GammaLib 2.0.0
Loading...
Searching...
No Matches
GLATInstDir Class Reference

Fermi/LAT instrument direction class. More...

#include <GLATInstDir.hpp>

Inheritance diagram for GLATInstDir:
GInstDir GBase

Public Member Functions

 GLATInstDir (void)
 Void constructor.
 
 GLATInstDir (const GSkyDir &dir)
 GSkyDir constructor.
 
 GLATInstDir (const GLATInstDir &dir)
 Copy constructor.
 
virtual ~GLATInstDir (void)
 Destructor.
 
GLATInstDiroperator= (const GLATInstDir &dir)
 Assignment operator.
 
virtual void clear (void)
 Clear Fermi/LAT instrument direction.
 
virtual GLATInstDirclone (void) const
 Clone Fermi/LAT instrument direction.
 
virtual std::string classname (void) const
 Return class name.
 
virtual u_int64_t hash (void) const
 Return instrument direction hash value.
 
virtual std::string print (const GChatter &chatter=NORMAL) const
 Print instrument direction information.
 
void dir (const GSkyDir &dir)
 Set sky direction.
 
GSkyDirdir (void)
 Returns reference to sky direction.
 
const GSkyDirdir (void) const
 Returns reference to sky direction (const version)
 
- Public Member Functions inherited from GInstDir
 GInstDir (void)
 Void constructor.
 
 GInstDir (const GInstDir &dir)
 Copy constructor.
 
virtual ~GInstDir (void)
 Destructor.
 
virtual GInstDiroperator= (const GInstDir &dir)
 Assignment operator.
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor.
 

Protected Member Functions

void init_members (void)
 Initialise class members.
 
void copy_members (const GLATInstDir &dir)
 Copy class members.
 
void free_members (void)
 Delete class members.
 
- Protected Member Functions inherited from GInstDir
void init_members (void)
 Initialise class members.
 
void copy_members (const GInstDir &dir)
 Copy class members.
 
void free_members (void)
 Delete class members.
 

Protected Attributes

GSkyDir m_dir
 Observed incident direction of event.
 

Detailed Description

Fermi/LAT instrument direction class.

The LAT instrument direction is an encapsulation of a sky direction as LAT is an imaging device.

Definition at line 48 of file GLATInstDir.hpp.

Constructor & Destructor Documentation

◆ GLATInstDir() [1/3]

GLATInstDir::GLATInstDir ( void )

Void constructor.

Definition at line 55 of file GLATInstDir.cpp.

References init_members().

Referenced by clone().

◆ GLATInstDir() [2/3]

GLATInstDir::GLATInstDir ( const GSkyDir & dir)
explicit

GSkyDir constructor.

Parameters
[in]dirSky direction.

Construct LAT instrument direction from sky direction.

Definition at line 72 of file GLATInstDir.cpp.

References dir(), init_members(), and m_dir.

◆ GLATInstDir() [3/3]

GLATInstDir::GLATInstDir ( const GLATInstDir & dir)

Copy constructor.

Parameters
[in]dirInstrument direction.

Definition at line 90 of file GLATInstDir.cpp.

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

◆ ~GLATInstDir()

GLATInstDir::~GLATInstDir ( void )
virtual

Destructor.

Definition at line 106 of file GLATInstDir.cpp.

References free_members().

Member Function Documentation

◆ classname()

std::string GLATInstDir::classname ( void ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GLATInstDir").

Implements GInstDir.

Definition at line 89 of file GLATInstDir.hpp.

◆ clear()

void GLATInstDir::clear ( void )
virtual

Clear Fermi/LAT instrument direction.

Implements GInstDir.

Definition at line 161 of file GLATInstDir.cpp.

References GInstDir::free_members(), free_members(), GInstDir::init_members(), and init_members().

Referenced by GLATEventAtom::init_members(), and GLATRoi::init_members().

◆ clone()

GLATInstDir * GLATInstDir::clone ( void ) const
virtual

Clone Fermi/LAT instrument direction.

Returns
Pointer to deep copy of Fermi/LAT instrument direction.

Implements GInstDir.

Definition at line 181 of file GLATInstDir.cpp.

References GLATInstDir().

◆ copy_members()

void GLATInstDir::copy_members ( const GLATInstDir & dir)
protected

Copy class members.

Parameters
[in]dirInstrument direction.

Definition at line 260 of file GLATInstDir.cpp.

References dir(), and m_dir.

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

◆ dir() [1/3]

void GLATInstDir::dir ( const GSkyDir & dir)
inline

Set sky direction.

Parameters
[in]dirSky direction.

Set the sky direction.

Definition at line 131 of file GLATInstDir.hpp.

References dir(), and m_dir.

Referenced by GLATRoi::contains(), and GLATResponse::irf().

◆ dir() [2/3]

GSkyDir & GLATInstDir::dir ( void )
inline

Returns reference to sky direction.

Returns
Reference to sky direction.

Returns reference to the sky direction.

Definition at line 103 of file GLATInstDir.hpp.

References m_dir.

Referenced by copy_members(), dir(), GLATInstDir(), GLATInstDir(), operator=(), and print().

◆ dir() [3/3]

const GSkyDir & GLATInstDir::dir ( void ) const
inline

Returns reference to sky direction (const version)

Returns
Reference to sky direction.

Returns reference to the sky direction.

Definition at line 117 of file GLATInstDir.hpp.

References m_dir.

◆ free_members()

void GLATInstDir::free_members ( void )
protected

Delete class members.

Definition at line 273 of file GLATInstDir.cpp.

Referenced by clear(), operator=(), and ~GLATInstDir().

◆ hash()

u_int64_t GLATInstDir::hash ( void ) const
virtual

Return instrument direction hash value.

Returns
Hash value.

Returns a hash value that can be used in the response cache.

Implements GInstDir.

Definition at line 194 of file GLATInstDir.cpp.

References GSkyDir::dec(), hash(), m_dir, and GSkyDir::ra().

Referenced by hash().

◆ init_members()

void GLATInstDir::init_members ( void )
protected

Initialise class members.

Definition at line 245 of file GLATInstDir.cpp.

References GSkyDir::clear(), and m_dir.

Referenced by clear(), GLATInstDir(), GLATInstDir(), GLATInstDir(), and operator=().

◆ operator=()

GLATInstDir & GLATInstDir::operator= ( const GLATInstDir & dir)

Assignment operator.

Parameters
[in]dirInstrument direction.
Returns
Instrument direction.

Definition at line 128 of file GLATInstDir.cpp.

References copy_members(), dir(), free_members(), init_members(), and GInstDir::operator=().

◆ print()

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

Print instrument direction information.

Parameters
[in]chatterChattiness.
Returns
String containing instrument direction information.

Implements GInstDir.

Definition at line 217 of file GLATInstDir.cpp.

References dir(), SILENT, and gammalib::str().

Referenced by GLATEventAtom::print(), and GLATRoi::print().

Member Data Documentation

◆ m_dir

GSkyDir GLATInstDir::m_dir
protected

Observed incident direction of event.

Definition at line 79 of file GLATInstDir.hpp.

Referenced by copy_members(), dir(), dir(), dir(), GLATInstDir(), hash(), and init_members().


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