GPhoton.hpp
6.93 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
/***************************************************************************
* GPhoton.hpp - Photon class *
* ----------------------------------------------------------------------- *
* copyright (C) 2011-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 GPhoton.hpp
* @brief Photon class definition
* @author Juergen Knoedlseder
*/
#ifndef GPHOTON_HPP
#define GPHOTON_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
#include "GSkyDir.hpp"
#include "GEnergy.hpp"
#include "GTime.hpp"
/***********************************************************************//**
* @class GPhoton
*
* @brief Class that handles photons.
*
* The GPhoton class stores the physical attributes of a photon such as the
* photon arrival direction, its energy and its arrival time. This class is
* mainly used for Monte Carlo simulations.
***************************************************************************/
class GPhoton : public GBase {
// Operator friends
friend bool operator==(const GPhoton &a, const GPhoton &b);
friend bool operator!=(const GPhoton &a, const GPhoton &b);
public:
// Constructors and destructors
GPhoton(void);
GPhoton(const GSkyDir& dir, const GEnergy& energy, const GTime& time,
const int& mcid = -1);
GPhoton(const GPhoton& photon);
virtual ~GPhoton(void);
// Operators
GPhoton& operator=(const GPhoton& photon);
// Methods
void clear(void);
GPhoton* clone(void) const;
const GSkyDir& dir(void) const;
const GEnergy& energy(void) const;
const GTime& time(void) const;
const int& mcid(void) const;
void dir(const GSkyDir& dir);
void energy(const GEnergy& energy);
void time(const GTime& time);
void mcid(const int& mcid);
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GPhoton& photon);
void free_members(void);
// Protected data members
GSkyDir m_dir; //!< Photon arrival direction
GEnergy m_energy; //!< Photon energy
GTime m_time; //!< Photon arrival time
int m_mc_id; //!< Monte Carlo simulation origin
};
/***********************************************************************//**
* @brief Return photon sky direction
*
* @return Sky direction of photon.
***************************************************************************/
inline
const GSkyDir& GPhoton::dir(void) const
{
return m_dir;
}
/***********************************************************************//**
* @brief Return photon energy
*
* @return Energy of photon.
***************************************************************************/
inline
const GEnergy& GPhoton::energy(void) const
{
return m_energy;
}
/***********************************************************************//**
* @brief Return photon time
*
* @return Time of photon.
***************************************************************************/
inline
const GTime& GPhoton::time(void) const
{
return m_time;
}
/***********************************************************************//**
* @brief Return photon Monte-Carlo identifier
*
* @return Photon Monte-Carlo identifier.
***************************************************************************/
inline
const int& GPhoton::mcid(void) const
{
return m_mc_id;
}
/***********************************************************************//**
* @brief Set photon sky direction
*
* @param[in] dir Sky direction of photon.
***************************************************************************/
inline
void GPhoton::dir(const GSkyDir& dir)
{
m_dir = dir;
return;
}
/***********************************************************************//**
* @brief Set photon energy
*
* @param[in] energy Photon energy.
***************************************************************************/
inline
void GPhoton::energy(const GEnergy& energy)
{
m_energy = energy;
return;
}
/***********************************************************************//**
* @brief Set photon time
*
* @param[in] time Photon time.
***************************************************************************/
inline
void GPhoton::time(const GTime& time)
{
m_time = time;
return;
}
/***********************************************************************//**
* @brief Set photon Monte-Carlo identifier
*
* @param[in] mcid Photon Monte-Carlo identifier.
***************************************************************************/
inline
void GPhoton::mcid(const int& mcid)
{
m_mc_id = mcid;
return;
}
/***********************************************************************//**
* @brief Equality friend operator
*
* @param[in] a First photon.
* @param[in] b Second photon.
* @return True is first photon is identical to second photon
***************************************************************************/
inline
bool operator==(const GPhoton &a, const GPhoton &b)
{
return (a.m_energy == b.m_energy && a.m_time == b.m_time &&
a.m_dir.dist(b.m_dir) == 0.0);
}
/***********************************************************************//**
* @brief Non-equality friend operator
*
* @param[in] a First photon.
* @param[in] b Second photon.
* @return True is first photon is not identical to second photon
***************************************************************************/
inline
bool operator!=(const GPhoton &a, const GPhoton &b)
{
return (a.m_energy != b.m_energy || a.m_time != b.m_time ||
a.m_dir.dist(b.m_dir) > 0.0);
}
#endif /* GPHOTON_HPP */