ctulimit.hpp
5.52 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
/***************************************************************************
* ctulimit - Upper limit calculation tool *
* ----------------------------------------------------------------------- *
* copyright (C) 2015-2018 by Michael Mayer *
* ----------------------------------------------------------------------- *
* *
* 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 ctulimit.hpp
* @brief Upper limit calculation tool interface definition
* @author Michael Mayer
*/
#ifndef CTULIMIT_HPP
#define CTULIMIT_HPP
/* __ Includes ___________________________________________________________ */
#include "ctlikelihood.hpp"
/* __Definitions _________________________________________________________ */
#define CTULIMIT_NAME "ctulimit"
/***********************************************************************//**
* @class ctulimit
*
* @brief Upper limit calculation tool
*
* This class computes and upper limit for a given source.
*
* The class operates on predefined observation containers, an individual
* event list or an observation definition XML file.
*
* During the computation the likelihood function is inspected to find the
* best value for the upper limit.
***************************************************************************/
class ctulimit : public ctlikelihood {
public:
// Constructors and destructors
ctulimit(void);
explicit ctulimit(const GObservations& obs);
ctulimit(int argc, char *argv[]);
ctulimit(const ctulimit& app);
virtual ~ctulimit(void);
// Operators
ctulimit& operator=(const ctulimit& app);
// Methods
void clear(void);
void run(void);
void save(void);
const double& diff_ulimit(void) const;
const double& flux_ulimit(void) const;
const double& eflux_ulimit(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const ctulimit& app);
void free_members(void);
void get_parameters(void);
void get_model_parameter(void);
void ulimit_bisection(const double& parmin, const double& parmax);
void compute_ulimit(void);
// User parameters
std::string m_srcname; //!< Name of source which is moved around
double m_confidence; //!< Confidence level
double m_sigma_min; //!< Starting value minimum (multiple fit errors above fit values)
double m_sigma_max; //!< Starting value maximum (multiple fit errors above fit values)
double m_eref; //!< Reference energy for flux limits (TeV)
double m_emin; //!< Minimum energy for flux limits (TeV)
double m_emax; //!< Maximum energy for flux limits (TeV)
double m_tol; //!< Tolerance for limit determination
int m_max_iter; //!< Maximum number of iterations
bool m_apply_edisp; //!< Apply energy dispersion?
GChatter m_chatter; //!< Chattiness
// Protected members
double m_dlogL; //!< Likelihood difference for upper limit computation
GModelSky* m_skymodel; //!< Pointer to sky model
GModelPar* m_model_par; //!< Pointer to model parameter
double m_best_logL; //!< Best fit log likelihood of given model
double m_diff_ulimit; //!< Differential upper limit value
double m_flux_ulimit; //!< Flux upper limit value
double m_eflux_ulimit; //!< Energy flux upper limits
};
/***********************************************************************//**
* @brief Return differential upper limit
*
* @return Differential upper flux limit.
***************************************************************************/
inline
const double& ctulimit::diff_ulimit(void) const
{
return m_diff_ulimit;
}
/***********************************************************************//**
* @brief Return flux upper limit
*
* @return Upper flux limit.
***************************************************************************/
inline
const double& ctulimit::flux_ulimit(void) const
{
return m_flux_ulimit;
}
/***********************************************************************//**
* @brief return energy flux upper limit
*
* @return Upper energy flux limit.
***************************************************************************/
inline
const double& ctulimit::eflux_ulimit(void) const
{
return m_eflux_ulimit;
}
#endif /* CTULIMIT_HPP */