GModelSpectral.hpp
4.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
/***************************************************************************
* GModelSpectral.hpp - Abstract spectral model base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2009-2013 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* *
***************************************************************************/
/**
* @file GModelSpectral.hpp
* @brief Abstract spectral model base class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMODELSPECTRAL_HPP
#define GMODELSPECTRAL_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include <vector>
#include "GBase.hpp"
#include "GModelPar.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
#include "GRan.hpp"
#include "GXmlElement.hpp"
/***********************************************************************//**
* @class GModelSpectral
*
* @brief Abstract spectral model base class
*
* This class implements the spectral component of the factorized source
* model
*
* \f[
* S_{\rm E}(E | t)
* \f]
*
* where
* - \f$E\f$ is the true photon energy, and
* - \f$t\f$ is the true photon arrival time.
*
* The spectral component describes the spatially integrated time dependent
* spectral distribution of the source. It satisfies
* \f[
* \int_{E} S_{\rm E}(E | t) dE = \Phi
* \f]
* for all \f$t\f$, where \f$\Phi\f$ is the spatially and spectrally
* integrated total source flux. The spectral component does not impact
* the temporal properties of the integrated flux \f$\Phi\f$.
***************************************************************************/
class GModelSpectral : public GBase {
public:
// Constructors and destructors
GModelSpectral(void);
GModelSpectral(const GModelSpectral& model);
virtual ~GModelSpectral(void);
// Operators
virtual GModelSpectral& operator=(const GModelSpectral& model);
virtual GModelPar& operator[](const int& index);
virtual const GModelPar& operator[](const int& index) const;
virtual GModelPar& operator[](const std::string& name);
virtual const GModelPar& operator[](const std::string& name) const;
// Pure virtual methods
virtual void clear(void) = 0;
virtual GModelSpectral* clone(void) const = 0;
virtual std::string type(void) const = 0;
virtual double eval(const GEnergy& srcEng,
const GTime& srcTime) const = 0;
virtual double eval_gradients(const GEnergy& srcEng,
const GTime& srcTime) = 0;
virtual double flux(const GEnergy& emin,
const GEnergy& emax) const = 0;
virtual double eflux(const GEnergy& emin,
const GEnergy& emax) const = 0;
virtual GEnergy mc(const GEnergy& emin, const GEnergy& emax,
const GTime& time, GRan& ran) 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;
// Methods
int size(void) const;
void autoscale(void);
protected:
// Protected methods
void init_members(void);
void copy_members(const GModelSpectral& model);
void free_members(void);
// Proteced members
std::vector<GModelPar*> m_pars; //!< Parameter pointers
};
#endif /* GMODELSPECTRAL_HPP */