GSkyPixel.cpp
11.1 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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
/***************************************************************************
* GSkyPixel.cpp - Sky map pixel class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-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 GSkyPixel.hpp
* @brief Sky map pixel class implementation
* @author Juergen Knoedlseder
*/
/* __ Includes ___________________________________________________________ */
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include "GSkyPixel.hpp"
#include "GTools.hpp"
#include "GException.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_INT "GSkyPixel::operator int()"
#define G_DOUBLE "GSkyPixel::operator double()"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/* __ Prototype __________________________________________________________ */
/*==========================================================================
= =
= Constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Void constructor
***************************************************************************/
GSkyPixel::GSkyPixel(void)
{
// Initialise members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief 1D pixel constructor (integer version)
*
* @param[in] index Pixel index.
***************************************************************************/
GSkyPixel::GSkyPixel(const int& index)
{
// Set members
m_size = 1;
m_x = double(index);
m_y = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief 1D pixel constructor (double precision version)
*
* @param[in] index Pixel index.
***************************************************************************/
GSkyPixel::GSkyPixel(const double& index)
{
// Set members
m_size = 1;
m_x = index;
m_y = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief 2D pixel constructor (integer version)
*
* @param[in] x Pixel X index.
* @param[in] y Pixel Y index.
***************************************************************************/
GSkyPixel::GSkyPixel(const int& x, const int& y)
{
// Set members
m_size = 2;
m_x = double(x);
m_y = double(y);
// Return
return;
}
/***********************************************************************//**
* @brief 2D pixel constructor (double precision version)
*
* @param[in] x Pixel X index.
* @param[in] y Pixel Y index.
***************************************************************************/
GSkyPixel::GSkyPixel(const double& x, const double& y)
{
// Set members
m_size = 2;
m_x = x;
m_y = y;
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param[in] pixel Sky pixel.
***************************************************************************/
GSkyPixel::GSkyPixel(const GSkyPixel& pixel)
{
// Initialise members
init_members();
// Copy members
copy_members(pixel);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GSkyPixel::~GSkyPixel(void)
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= Operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] pixel Sky map pixel.
* @return Sky map pixel.
***************************************************************************/
GSkyPixel& GSkyPixel::operator=(const GSkyPixel& pixel)
{
// Execute only if object is not identical
if (this != &pixel) {
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(pixel);
} // endif: object was not identical
// Return this object
return *this;
}
/***********************************************************************//**
* @brief To integer type conversion
*
* @return Pixel index.
*
* Converts the sky map pixel into an integer value.
***************************************************************************/
GSkyPixel::operator int() const
{
// Throw an exception if pixel is not 1D
if (!is_1D()) {
std::string msg = "Sky map pixel is not 1-dimensional.\n"
"Conversion from GSkyPixel to int is only allowed"
" for 1-dimensional sky map pixels.";
throw GException::invalid_value(G_INT, msg);
}
// Round pixel to integer value
int value = int(m_x + 0.5);
// Return value
return value;
}
/***********************************************************************//**
* @brief To double type conversion
*
* @return Pixel index.
*
* Converts the sky map pixel into a double precision value.
***************************************************************************/
GSkyPixel::operator double() const
{
// Throw an exception if pixel is not 1D
if (!is_1D()) {
std::string msg = "Sky map pixel is not 1-dimensional.\n"
"Conversion from GSkyPixel to double is only allowed"
" for 1-dimensional sky map pixels.";
throw GException::invalid_value(G_DOUBLE, msg);
}
// Return value
return m_x;
}
/*==========================================================================
= =
= Public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Clear instance
*
* Set sky map pixel to a clean initial state.
***************************************************************************/
void GSkyPixel::clear(void)
{
// Free members
free_members();
// Initialise private members
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Clone sky map pixel
*
* @return Pointer to deep copy of sky map pixel.
*
* Returns a pointer to a deep copy of a sky map pixel.
***************************************************************************/
GSkyPixel* GSkyPixel::clone(void) const
{
// Clone pixel
return new GSkyPixel(*this);
}
/***********************************************************************//**
* @brief Print pixel
*
* @param[in] chatter Chattiness (defaults to NORMAL).
* @return String containing pixel information.
***************************************************************************/
std::string GSkyPixel::print(const GChatter& chatter) const
{
// Initialise result string
std::string result;
// Continue only if chatter is not silent
if (chatter != SILENT) {
// Append pixel
if (is_1D()) {
result.append(gammalib::str(x()));
}
else if (is_2D()) {
result.append("(");
result.append(gammalib::str(x()));
result.append(",");
result.append(gammalib::str(y()));
result.append(")");
}
} // endif: chatter was not silent
// Return result
return result;
}
/*==========================================================================
= =
= Private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GSkyPixel::init_members(void)
{
// Initialise members
m_size = 0;
m_x = 0.0;
m_y = 0.0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] pixel Sky pixel.
***************************************************************************/
void GSkyPixel::copy_members(const GSkyPixel& pixel)
{
// Copy attributes
m_size = pixel.m_size;
m_x = pixel.m_x;
m_y = pixel.m_y;
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GSkyPixel::free_members(void)
{
// Return
return;
}