GResponse.hpp
5.85 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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/***************************************************************************
* GResponse.hpp - Abstract response base class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2015 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 GResponse.hpp
* @brief Abstract response base class definition
* @author Juergen Knoedlseder
*/
#ifndef GRESPONSE_HPP
#define GRESPONSE_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GFunction.hpp"
#include "GTime.hpp"
/* __ Forward declarations _______________________________________________ */
class GEvent;
class GPhoton;
class GSource;
class GEnergy;
class GEbounds;
class GObservation;
class GModelSky;
/***********************************************************************//**
* @class GResponse
*
* @brief Abstract instrument response base class
*
* The response function provides conversion between physical parameters
* (such as source position, flux, ...) and the measured instrumental
* parameters (such as measured energy, photon interaction, ...).
*
* For a given observation, the irf method returns the instrument response
* for a given event and photon. An alternative method exists that returns
* the response for a specific source.
*
* The nroi method returns the spatial integral of the instrument response
* function times the sky model over the region of interest. This method is
* only required for unbinned analysis.
*
* The ebounds method returns the true energy boundaries for a specified
* measured event energy. This method is used for computing the energy
* dispersion.
***************************************************************************/
class GResponse : public GBase {
public:
// Constructors and destructors
GResponse(void);
GResponse(const GResponse& rsp);
virtual ~GResponse(void);
// Operators
virtual GResponse& operator=(const GResponse& rsp);
// Pure virtual methods
virtual void clear(void) = 0;
virtual GResponse* clone(void) const = 0;
virtual std::string classname(void) const = 0;
virtual bool use_edisp(void) const = 0;
virtual bool use_tdisp(void) const = 0;
virtual double irf(const GEvent& event,
const GPhoton& photon,
const GObservation& obs) const = 0;
virtual double irf(const GEvent& event,
const GSource& source,
const GObservation& obs) const = 0;
virtual double nroi(const GModelSky& model,
const GEnergy& obsEng,
const GTime& obsTime,
const GObservation& obs) const = 0;
virtual GEbounds ebounds(const GEnergy& obsEng) const = 0;
virtual std::string print(const GChatter& chatter = NORMAL) const = 0;
// Virtual methods
virtual double convolve(const GModelSky& model,
const GEvent& event,
const GObservation& obs,
const bool& grad = true) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GResponse& rsp);
void free_members(void);
double eval_prob(const GModelSky& model,
const GEvent& event,
const GEnergy& srcEng,
const GTime& srcTime,
const GObservation& obs,
const bool& grad) const;
// Protected classes
class edisp_kern : public GFunction {
public:
edisp_kern(const GResponse* parent,
const GObservation* obs,
const GModelSky* model,
const GEvent* event,
const GTime& srcTime,
const bool& grad) :
m_parent(parent),
m_obs(obs),
m_model(model),
m_event(event),
m_srcTime(srcTime),
m_grad(grad) { }
double eval(const double& x);
protected:
const GResponse* m_parent; //!< Response
const GObservation* m_obs; //!< Observation
const GModelSky* m_model; //!< Sky model
const GEvent* m_event; //!< Event
GTime m_srcTime; //!< True arrival time
bool m_grad; //!< Gradient flag
};
};
#endif /* GRESPONSE_HPP */