GFitsImage.cpp
15.4 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
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
/***************************************************************************
* GFitsImage.cpp - FITS image class *
* ----------------------------------------------------------------------- *
* copyright : (C) 2008 by Jurgen Knodlseder *
* ----------------------------------------------------------------------- *
* *
* 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 2 of the License, or *
* (at your option) any later version. *
* *
* ----------------------------------------------------------------------- *
***************************************************************************/
/* __ Includes ___________________________________________________________ */
#include <iostream>
#include "GException.hpp"
#include "GFitsImage.hpp"
/* __ Method name definitions ____________________________________________ */
#define G_NAXES "GFitsImage::naxes(int)"
#define G_OPEN_IMAGE "GFitsImage::open(fitsfile*)"
#define G_LOAD_IMAGE "GFitsImage::load_image(int, const void*, const void*, int*)"
#define G_SAVE_IMAGE "GFitsImage::save_image(int, const void*)"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= GFitsImage constructors/destructors =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Constructor
***************************************************************************/
GFitsImage::GFitsImage() : GFitsData()
{
// Initialise class members for clean destruction
init_members();
// Return
return;
}
/***********************************************************************//**
* @brief Constructor
*
* @param naxis Image dimensions (0,1,2,3,4)
* @param naxes Number of pixels in each dimension
*
* Construct instance of GFitsImage by specifying the image dimension and
* the number of pixels in each dimension. Note that this constructor does
* not allocate any memory for the actual image.
***************************************************************************/
GFitsImage::GFitsImage(int naxis, const int* naxes) : GFitsData()
{
// Initialise class members for clean destruction
init_members();
// Store number of axis and bitpix
m_naxis = naxis;
// Copy number of pixels in each dimension and calculate the total
// number of pixels
if (m_naxis > 0) {
m_naxes = new long[m_naxis];
m_num_pixels = 1;
for (int i = 0; i < m_naxis; ++i) {
m_naxes[i] = naxes[i];
m_num_pixels *= naxes[i];
}
}
// Return
return;
}
/***********************************************************************//**
* @brief Copy constructor
*
* @param image FITS image which should be used for construction
***************************************************************************/
GFitsImage::GFitsImage(const GFitsImage& image) : GFitsData(image)
{
// Initialise class members for clean destruction
init_members();
// Copy members
copy_members(image);
// Return
return;
}
/***********************************************************************//**
* @brief Destructor
***************************************************************************/
GFitsImage::~GFitsImage()
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= GFitsImage operators =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Assignment operator
*
* @param[in] image FITS image to be assigned
***************************************************************************/
GFitsImage& GFitsImage::operator= (const GFitsImage& image)
{
// Execute only if object is not identical
if (this != &image) {
// Copy base class members
this->GFitsData::operator=(image);
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(image);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= GFitsImage public methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Return number of Bits per pixel (negative=floating point)
***************************************************************************/
int GFitsImage::bitpix(void) const
{
// Return number of Bits per pixel
return m_bitpix;
}
/***********************************************************************//**
* @brief Return image dimension
***************************************************************************/
int GFitsImage::naxis(void) const
{
// Return dimension
return m_naxis;
}
/***********************************************************************//**
* @brief Return axis dimension
*
* @param[in] axis Axis for which the dimension should be returned
* (starting from 0)
***************************************************************************/
int GFitsImage::naxes(int axis) const
{
// Check if axis is within the range
if (axis < 0 || axis >= m_naxis)
throw GException::out_of_range(G_NAXES, axis, 0, m_naxis-1);
// Get axis dimension
int dim = m_naxes[axis];
// Return axis dimension
return dim;
}
/***********************************************************************//**
* @brief Return number of pixels
***************************************************************************/
int GFitsImage::num_pixels(void) const
{
// Return number of pixels
return m_num_pixels;
}
/*==========================================================================
= =
= GFitsImage private methods =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Initialise class members
***************************************************************************/
void GFitsImage::init_members(void)
{
// Initialise members
m_fitsfile.HDUposition = 0;
m_fitsfile.Fptr = NULL;
m_bitpix = 8;
m_naxis = 0;
m_naxes = NULL;
m_num_pixels = 0;
// Return
return;
}
/***********************************************************************//**
* @brief Copy class members
*
* @param[in] image FITS image to copy
***************************************************************************/
void GFitsImage::copy_members(const GFitsImage& image)
{
// Copy attributes
m_fitsfile = image.m_fitsfile;
m_bitpix = image.m_bitpix;
m_naxis = image.m_naxis;
m_naxes = NULL;
m_num_pixels = image.m_num_pixels;
// Copy axes
if (image.m_naxes != NULL && m_naxis > 0) {
m_naxes = new long[m_naxis];
memcpy(m_naxes, image.m_naxes, m_naxis*sizeof(long));
}
// Return
return;
}
/***********************************************************************//**
* @brief Delete class members
***************************************************************************/
void GFitsImage::free_members(void)
{
// Free memory
if (m_naxes != NULL) delete [] m_naxes;
// Mark memory as free
m_naxes = NULL;
// Return
return;
}
/***********************************************************************//**
* @brief Open Image
*
* @param[in] fptr FITS file pointer
*
* Open FITS image in FITS file. Opening means connecting the FITS file
* pointer to the image and reading the image and axes dimensions.
***************************************************************************/
void GFitsImage::open_image(__fitsfile* fptr)
{
// Move to HDU
int status = 0;
status = __ffmahd(fptr, (fptr->HDUposition)+1, NULL, &status);
if (status != 0)
throw GException::fits_error(G_OPEN_IMAGE, status);
// Save FITS file pointer
m_fitsfile = *fptr;
// Get the image dimensions
status = __ffgidm(&m_fitsfile, &m_naxis, &status);
if (status != 0)
throw GException::fits_error(G_OPEN_IMAGE, status);
// Reset number of image pixels
m_num_pixels = 0;
// Get the axes dimensions
if (m_naxis > 0) {
// Allocate memory for axes dimensions
if (m_naxes != NULL) delete [] m_naxes;
m_naxes = new long[m_naxis];
// Get the axes dimensions
status = __ffgisz(&m_fitsfile, m_naxis, m_naxes, &status);
if (status != 0)
throw GException::fits_error(G_OPEN_IMAGE, status);
// Calculate number of image pixels
m_num_pixels = 1;
for (int i = 0; i < m_naxis; ++i)
m_num_pixels *= m_naxes[i];
} // endif: there is an image
// Return
return;
}
/***********************************************************************//**
* @brief Load FITS image
*
* @param[in] datatype Datatype of pixels to be saved
* @param[in] pixels Pixel array to be saved
*
* Save image pixels into FITS file. In case that the HDU does not exist it
* is created.
***************************************************************************/
void GFitsImage::load_image(int datatype, const void* pixels, const void* nulval,
int* anynul)
{
// Move to HDU
int status = 0;
status = __ffmahd(&m_fitsfile, (m_fitsfile.HDUposition)+1, NULL, &status);
if (status != 0)
throw GException::fits_error(G_LOAD_IMAGE, status);
// Load the image pixels (if there are some ...)
if (m_naxis > 0) {
long* fpixel = new long[m_naxis];
long* lpixel = new long[m_naxis];
long* inc = new long[m_naxis];
for (int i = 0; i < m_naxis; ++i) {
fpixel[i] = 1;
lpixel[i] = m_naxes[i];
inc[i] = 1;
}
status = __ffgsv(&m_fitsfile, datatype, fpixel, lpixel, inc, (void*)nulval,
(void*)pixels, anynul, &status);
if (status != 0)
throw GException::fits_error(G_LOAD_IMAGE, status);
delete [] fpixel;
delete [] lpixel;
delete [] inc;
}
// Return
return;
}
/***********************************************************************//**
* @brief Save FITS image
*
* @param[in] datatype Datatype of pixels to be saved
* @param[in] pixels Pixel array to be saved
*
* Save image pixels into FITS file. In case that the HDU does not exist it
* is created. In case that the pixel array is empty no data are saved; all
* image pixels will be empty in this case.
***************************************************************************/
void GFitsImage::save_image(int datatype, const void* pixels)
{
// Move to HDU
int status = 0;
status = __ffmahd(&m_fitsfile, (m_fitsfile.HDUposition)+1, NULL, &status);
// If HDU does not yet exist in file then create it now
if (status == 107) {
status = 0;
status = __ffcrim(&m_fitsfile, m_bitpix, m_naxis, m_naxes, &status);
if (status != 0)
throw GException::fits_error(G_SAVE_IMAGE, status);
}
else if (status != 0)
throw GException::fits_error(G_SAVE_IMAGE, status);
// If HDU seems to be empty then create it now. This is only needed for the
// primary HDU, since __ffmahd gives no error if the primary HDU is empty.
// By checking the number of keywords in the HDU we detect an empty HDU ...
int num = 0;
status = __ffghsp(&m_fitsfile, &num, NULL, &status);
if (status != 0)
throw GException::fits_error(G_SAVE_IMAGE, status);
if (num == 0) {
status = __ffcrim(&m_fitsfile, m_bitpix, m_naxis, m_naxes, &status);
if (status != 0)
throw GException::fits_error(G_SAVE_IMAGE, status);
}
// Save the image pixels (if there are some ...)
if (m_naxis > 0 && pixels != NULL) {
long* fpixel = new long[m_naxis];
long* lpixel = new long[m_naxis];
for (int i = 0; i < m_naxis; ++i) {
fpixel[i] = 1;
lpixel[i] = m_naxes[i];
}
status = __ffpss(&m_fitsfile, datatype, fpixel, lpixel, (void*)pixels, &status);
if (status != 0)
throw GException::fits_error(G_SAVE_IMAGE, status);
delete [] fpixel;
delete [] lpixel;
}
// Return
return;
}
/*==========================================================================
= =
= GFitsImage friends =
= =
==========================================================================*/
/***********************************************************************//**
* @brief Output operator
*
* @param os Output stream into which the result will be writted
* @param image FITS image which should be put in the output stream
***************************************************************************/
std::ostream& operator<< (std::ostream& os, const GFitsImage& image)
{
// Put header in stream
os << "=== GFitsImage ===" << std::endl;
os << " Number of dimensions ......: " << image.m_naxis << std::endl;
os << " Number of image pixels ....: " << image.m_num_pixels << std::endl;
for (int i = 0; i < image.m_naxis; ++i)
os << " Number of bins in " << i << " .......: " << image.m_naxes[i] << std::endl;
// Return output stream
return os;
}
/*==========================================================================
= =
= Other functions used by GFitsImage =
= =
==========================================================================*/