GMWLSpectrum.hpp
6.23 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
/***************************************************************************
* GMWLSpectrum.hpp - Multi-wavelength spectrum class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-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 GMWLSpectrum.hpp
* @brief Multi-wavelength spectrum class interface definition
* @author Juergen Knoedlseder
*/
#ifndef GMWLSPECTRUM_HPP
#define GMWLSPECTRUM_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GEventCube.hpp"
#include "GMWLDatum.hpp"
#include "GFitsTable.hpp"
#include "GEnergy.hpp"
/***********************************************************************//**
* @class GMWLSpectrum
*
* @brief Multi-wavelength spectrum class interface
*
* This class defines a multi-wavelength spectrum and is a container for
* spectral points of type GMWLDatum. It derives from the abstract
* GEventCube base class.
***************************************************************************/
class GMWLSpectrum : public GEventCube {
public:
// Constructors and destructors
GMWLSpectrum(void);
explicit GMWLSpectrum(const std::string& filename);
GMWLSpectrum(const GMWLSpectrum& spec);
virtual ~GMWLSpectrum(void);
// Operators
virtual GMWLSpectrum& operator=(const GMWLSpectrum& spec);
virtual GMWLDatum* operator[](const int& index);
virtual const GMWLDatum* operator[](const int& index) const;
// Implemented pure virtual methods
virtual void clear(void);
virtual GMWLSpectrum* clone(void) const;
virtual std::string classname(void) const;
virtual int size(void) const;
virtual int dim(void) const;
virtual int naxis(const int& axis) const;
virtual void load(const std::string& filename);
virtual void save(const std::string& filename,
const bool& clobber = false) const;
virtual void read(const GFits& file);
virtual void write(GFits& file) const;
virtual int number(void) const;
virtual std::string print(const GChatter& chatter = NORMAL) const;
// Other methods
void read(const GFits& file, const std::string& extname);
void read(const GFits& file, const int& extno);
const std::string& telescope(void) const;
const std::string& instrument(void) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GMWLSpectrum& spec);
void free_members(void);
void set_ebounds(void);
void read_fits(const GFitsTable& table);
GEnergy conv_energy(const double& energy, const std::string& unit);
double conv_flux(const GEnergy& energy, const double& flux,
const std::string& unit);
// Protected members
std::string m_telescope; //!< Telescope name
std::string m_instrument; //!< Instrument name
std::vector<GMWLDatum> m_data; //!< Spectral data
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GMWLSpectrum").
***************************************************************************/
inline
std::string GMWLSpectrum::classname(void) const
{
return ("GMWLSpectrum");
}
/***********************************************************************//**
* @brief Return number of spectral bins
*
* @return Number of bins in spectrum.
***************************************************************************/
inline
int GMWLSpectrum::size(void) const
{
return (int)m_data.size();
}
/***********************************************************************//**
* @brief Return dimension of spectrum
*
* @return Dimension of spectrum (always 1).
***************************************************************************/
inline
int GMWLSpectrum::dim(void) const
{
return 1;
}
/***********************************************************************//**
* @brief Return number of spectral bins per dimension
*
* @param[in] axis Axis (ignored).
* @return Number of bins in spectrum.
***************************************************************************/
inline
int GMWLSpectrum::naxis(const int& axis) const
{
return (int)m_data.size();
}
/***********************************************************************//**
* @brief Return telescope name
*
* @return Telescope name.
***************************************************************************/
inline
const std::string& GMWLSpectrum::telescope(void) const
{
return m_telescope;
}
/***********************************************************************//**
* @brief Return instrument name
*
* @return Instrument name.
***************************************************************************/
inline
const std::string& GMWLSpectrum::instrument(void) const
{
return m_instrument;
}
#endif /* GMWLSPECTRUM_HPP */