GFits.cpp
12.3 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
/***************************************************************************
* GFits.cpp - FITS file access 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 "GException.hpp"
#include "GFits.hpp"
#include "GTools.hpp"
#include <iostream> // cout, cerr
/* __ Namespaces _________________________________________________________ */
/* __ Method name definitions ____________________________________________ */
#define G_OPEN "GFits::open(std::string)"
#define G_SAVETO "GFits::saveto(const std::string, int)"
#define G_FREE_MEM "GFits::free_members()"
/* __ Macros _____________________________________________________________ */
/* __ Coding definitions _________________________________________________ */
/* __ Debug definitions __________________________________________________ */
/*==========================================================================
= =
= GFits constructors/destructors =
= =
==========================================================================*/
/***************************************************************************
* Constructor *
* ----------------------------------------------------------------------- *
***************************************************************************/
GFits::GFits()
{
// Initialise class members for clean destruction
init_members();
// Return
return;
}
/***************************************************************************
* Copy constructor *
* ----------------------------------------------------------------------- *
***************************************************************************/
GFits::GFits(const GFits& fits)
{
// Initialise class members for clean destruction
init_members();
// Copy members
copy_members(fits);
// Return
return;
}
/***************************************************************************
* Destructor *
* ----------------------------------------------------------------------- *
***************************************************************************/
GFits::~GFits()
{
// Free members
free_members();
// Return
return;
}
/*==========================================================================
= =
= GFits operators =
= =
==========================================================================*/
/***************************************************************************
* Assignment operator *
* ----------------------------------------------------------------------- *
***************************************************************************/
GFits& GFits::operator= (const GFits& fits)
{
// Execute only if object is not identical
if (this != &fits) {
// Free members
free_members();
// Initialise private members for clean destruction
init_members();
// Copy members
copy_members(fits);
} // endif: object was not identical
// Return this object
return *this;
}
/*==========================================================================
= =
= GFits public methods =
= =
==========================================================================*/
/***************************************************************************
* Open FITS file *
* ----------------------------------------------------------------------- *
***************************************************************************/
void GFits::open(const std::string filename)
{
// Don't allow opening if another file is already open
if (m_fitsfile != NULL)
throw GException::fits_already_opened(G_OPEN, m_filename);
// Open FITS file
int status = 0;
status = __ffopen(&m_fitsfile, filename.c_str(), 1, &status);
if (status != 0)
throw GException::fits_open_error(G_OPEN, filename, status);
// Store FITS file attributes
m_filename = filename;
// Determine number of HDUs
status = __ffthdu(m_fitsfile, &m_num_hdu, &status);
if (status != 0)
throw GException::fits_error(G_OPEN, status);
// Allocate HDUs
if (m_hdu != NULL) delete [] m_hdu;
m_hdu = new GFitsHDU[m_num_hdu];
// Open all HDUs
for (int i = 0; i < m_num_hdu; ++i)
m_hdu[i].open(m_fitsfile, i+1);
// Return
return;
}
/***************************************************************************
* Save FITS file *
* ----------------------------------------------------------------------- *
***************************************************************************/
void GFits::save(void)
{
// Save all HDUs
for (int i = 0; i < m_num_hdu; ++i)
m_hdu[i].save();
// Return
return;
}
/***************************************************************************
* Save to specified FITS file *
* ----------------------------------------------------------------------- *
***************************************************************************/
void GFits::saveto(const std::string filename, int clobber)
{
// Create a copy of existing object. Recall that the copy does not
// carry over the FITS filename and pointer. Those will be automatically
// reset to the initial values in the new object.
GFits new_fits = *this;
// Check if specified FITS file exists. If yes, saving will only be
// allowed if clobber is true ...
int status = 0;
status = __ffopen(&(new_fits.m_fitsfile), filename.c_str(), 1, &status);
if (status == 0) {
if (!clobber) {
throw GException::fits_open_error(G_SAVETO, filename, status);
//throw file_exists ...
}
//delete existing file
//...
}
// ... otherwise create a new FITS file now
else {
// ...
}
// Save all HDUs
for (int i = 0; i < m_num_hdu; ++i)
new_fits.m_hdu[i].save();
// Return
return;
}
/***************************************************************************
* Close FITS file *
* ----------------------------------------------------------------------- *
* Closing detaches a FITS file from the GFits object and returns a clean *
* empty object. *
***************************************************************************/
void GFits::close(void)
{
// Close file and free all members
free_members();
// Initialise members
init_members();
// Return
return;
}
/***************************************************************************
* Get pointer to HDU *
* ----------------------------------------------------------------------- *
***************************************************************************/
GFitsHDU* GFits::hdu(const std::string extname)
{
// Initialise result to NULL pointer
GFitsHDU* ptr = NULL;
// Search for specified extension
for (int i = 0; i < m_num_hdu; ++i) {
if (m_hdu[i].extname() == extname) {
ptr = &(m_hdu[i]);
break;
}
}
// Return pointer
return ptr;
}
/*==========================================================================
= =
= GFits private methods =
= =
==========================================================================*/
/***************************************************************************
* Initialise class members *
* ----------------------------------------------------------------------- *
***************************************************************************/
void GFits::init_members(void)
{
// Initialise GFits members
m_filename.clear();
m_fitsfile = NULL;
m_num_hdu = 0;
m_hdu = NULL;
// Return
return;
}
/***************************************************************************
* Copy class members *
* ----------------------------------------------------------------------- *
* The function does not copy the FITS filename and FITS file pointer. *
* This prevents that several copies of the FITS file pointer exist in *
* different instances of GFits, which would lead to confusion since one *
* instance could close the file while for another it still would be *
* opened. The rule ONE INSTANCE - ONE FILE applies. *
***************************************************************************/
void GFits::copy_members(const GFits& fits)
{
// Reset FITS file attributes
m_filename.clear();
m_fitsfile = NULL;
// Copy HDUs
if (fits.m_hdu != NULL && fits.m_num_hdu > 0) {
m_num_hdu = fits.m_num_hdu;
m_hdu = new GFitsHDU[fits.m_num_hdu];
for (int i = 0; i < fits.m_num_hdu; ++i)
m_hdu[i] = fits.m_hdu[i];
}
// Return
return;
}
/***************************************************************************
* Delete class members *
* ----------------------------------------------------------------------- *
***************************************************************************/
void GFits::free_members(void)
{
// If FITS file has been opened then close it now
if (m_fitsfile != NULL) {
int status = 0;
status = __ffclos(m_fitsfile, &status);
if (status != 0)
throw GException::fits_error(G_FREE_MEM, status);
}
// Free memory
if (m_hdu != NULL) delete [] m_hdu;
// Properly mark as free
m_hdu = NULL;
// Return
return;
}
/*==========================================================================
= =
= GFits friends =
= =
==========================================================================*/
/*==========================================================================
= =
= Other functions used by GFits =
= =
==========================================================================*/