GPha.hpp
8.29 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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/***************************************************************************
* GPha.hpp - XSPEC Pulse Height Analyzer class *
* ----------------------------------------------------------------------- *
* copyright (C) 2013-2014 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 GPha.hpp
* @brief XSPEC Pulse Height Analyzer class definition
* @author Juergen Knoedlseder
*/
#ifndef GPHA_HPP
#define GPHA_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GEnergy.hpp"
#include "GEbounds.hpp"
#include "GFits.hpp"
#include "GFitsTable.hpp"
/***********************************************************************//**
* @class GPha
*
* @brief Pulse Height Analyzer class
*
* This class implements a Pulse Height Analyzer (PHA) spectrum that is used
* as data container for an XSPEC analysis. A PHA spectrum is a vector that
* provides the number of measured counts as function of the channel number.
*
* As an extension to the PHA format, the GPha class may also store the
* energy boundaries for all PHA channels. If defined, the energy boundaries
* will be written as a EBOUNDS extension to the same file where the PHA
* spectrum resides. Upon loading, GPha will also load the energy boundaries
* from an EBOUNDS extension if they are present.
***************************************************************************/
class GPha : public GBase {
public:
// Constructors and destructors
GPha(void);
explicit GPha(const std::string& filename);
explicit GPha(const GEbounds& ebds);
explicit GPha(const int& bins);
GPha(const GPha& pha);
virtual ~GPha(void);
// Operators
GPha& operator=(const GPha& pha);
double& operator[](const int& index);
const double& operator[](const int& index) const;
// Methods
void clear(void);
GPha* clone(void) const;
std::string classname(void) const;
int size(void) const;
double& at(const int& index);
const double& at(const int& index) const;
const GEbounds& ebounds(void) const;
double counts(void) const;
const double& underflow(void) const;
const double& overflow(void) const;
const double& outflow(void) const;
void fill(const GEnergy& energy, const double& value = 1.0);
void load(const std::string& filename);
void save(const std::string& filename,
const bool& clobber = false) const;
void read(const GFitsTable& table);
void write(GFits& fits) const;
const std::string& filename(void) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GPha& pha);
void free_members(void);
// Protected members
mutable std::string m_filename; //!< Filename of origin
std::vector<double> m_counts; //!< Counts data
double m_underflow; //!< Number of underflowing events
double m_overflow; //!< Number of overflowing events
double m_outflow; //!< Number of outflowing events
GEbounds m_ebounds; //!< Energy boundaries
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GPha").
***************************************************************************/
inline
std::string GPha::classname(void) const
{
return ("GPha");
}
/***********************************************************************//**
* @brief Return content of spectral bin
*
* @param[in] index Bin index [0,...,size()-1].
*
* Returns reference to content of spectral bin with specified @p index.
***************************************************************************/
inline
double& GPha::operator[](const int& index)
{
return (m_counts[index]);
}
/***********************************************************************//**
* @brief Return content of spectral bin (const version)
*
* @param[in] index Bin index [0,...,size()-1].
*
* Returns reference to content of spectral bin with specified @p index.
***************************************************************************/
inline
const double& GPha::operator[](const int& index) const
{
return (m_counts[index]);
}
/***********************************************************************//**
* @brief Return number of bins in spectrum
*
* @return Number of bins in spectrum.
*
* Returns the number of bins in the spectrum.
***************************************************************************/
inline
int GPha::size(void) const
{
return (m_counts.size());
}
/***********************************************************************//**
* @brief Return energy boundaries
*
* @return Energy boundaries for all spectral bins.
*
* Returns the energy boundaries for all spectral bins.
***************************************************************************/
inline
const GEbounds& GPha::ebounds(void) const
{
return m_ebounds;
}
/***********************************************************************//**
* @brief Return number of underflow counts
*
* @return Number of counts with energies lower than the first energy bin.
*
* Returns the number of counts with energies lower than the first energy
* bin.
***************************************************************************/
inline
const double& GPha::underflow(void) const
{
return m_underflow;
}
/***********************************************************************//**
* @brief Return number of overflow counts
*
* @return Number of counts with energies larger than the last energy bin.
*
* Returns the number of counts with energies larger than the last energy
* bin.
***************************************************************************/
inline
const double& GPha::overflow(void) const
{
return m_overflow;
}
/***********************************************************************//**
* @brief Return number of outflow counts
*
* @return Number of counts with energies between energy bins.
*
* Returns the number of counts with energies between energy bins.
***************************************************************************/
inline
const double& GPha::outflow(void) const
{
return m_outflow;
}
/***********************************************************************//**
* @brief Return file name
*
* @return File name from which the PHA information has been read or into
* which PHA information has been saved.
*
* Returns the file name from which the PHA information has been read or into
* which PHA information has been saved. The returned string will be empty if
* no load() or save() method has been called before.
***************************************************************************/
inline
const std::string& GPha::filename(void) const
{
return (m_filename);
}
#endif /* GPHA_HPP */