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
|
/* $Id: vmobjecttable.h,v 1.2 2013-03-25 11:43:04 cgarcia Exp $
*
* This file is part of the VIMOS Pipeline
* Copyright (C) 2002-2004 European Southern Observatory
*
* 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.
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef VM_OBJECTTABLE_H
#define VM_OBJECTTABLE_H
#include <fitsio.h>
#include <pilmacros.h>
#include <vmwindowtable.h>
PIL_BEGIN_DECLS
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
defines of name strings for the Object Tables
Description:
The following strings are defined to use in the Oject Tables for
identifying the name of the table and other things
Values:
VM_OBJ string giving the name of the Object Table
more to follow.......
Updates:
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
#define VM_OBJ "OBJ"
/* more to follow ... */
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
stucture VimosObjectObject
Description:
Linked list structure that contains the information of one object
in an Object Table. An Object Table is simply a listof VimosObjectObjects
plus descriptors.
Layout:
int slitNo;
int IFUslitNo;
int IFUfibNo;
int rowNum;
int objNo;
float objX;
float objY;
double objRA;
double objDec;
VimosObjectObject *prev;
VimosObjectObject *next;
Updates:
11 Feb 99: Created (TAO)
03 Feb 00: Added IFU slit and fiber bumber information (MS)
--------------------------------------------------------------------------------
*/
typedef struct _VIMOS_OBJECT_OBJ_
{
int slitNo;
int IFUslitNo;
int IFUfibNo;
int rowNum;
int objNo;
float objX;
float objY;
double objRA;
double objDec;
/**/
struct _VIMOS_OBJECT_OBJ_ *prev;
struct _VIMOS_OBJECT_OBJ_ *next;
} VimosObjectObject;
typedef struct _VIMOS_OBJECT_TABLE_
{
char name[VM_DESC_LENGTH];
VimosDescriptor *descs;
VimosObjectObject *objs;
fitsfile *fptr;
} VimosObjectTable;
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosWindowObject *newObjectObject()
Description:
Returns a pointer to a new VimosObjectObject structure.
Input:
void
Return Value (succes):
Pointer to a newly allocated VimosobjectObject structure. All fields are
initialized to 0
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosObjectObject *newObjectObject();
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteObjectObject(VimosObjectObject *oObject)
Description:
Deletes all VimosObjectObejcts contained in the linked list oObject
Input:
VimosObjectObject *oObject
Pointer to VimosObjectObject list to be deleted
Return Value:
void
Updates:
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
void deleteObjectObject(VimosObjectObject *oObject);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosObjectTable *newObjectTable()
Description:
Allocate a new Object Table. All fields are initialized to 0, except the
name field is set to VM_OBJ
Input:
void
Return Value (success):
Pointer to the new VimosObjectTable
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosObjectTable *newObjectTable();
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteObjectTable(VimosObjectTable *oTable)
Description:
Delete a Object Table.
Input:
VimosObjectTable *oTable
Pointer of Object Table to be deleted
Return Value:
void
Updates:
11 feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
void deleteObjectTable(VimosObjectTable *oTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool copyWinTab2ObjTab(VimosWindowTable *winTable,
VimosObjectTable *objTable)
Description:
Copy ALL descriptors (including those that may not be relevant) of an
Window Table into Object Table.
Input:
VimosWindowTable *winTable
Pointer to the Window Table to copy the descriptors from
VimosObjectTable *objTable
Pointer to the Object Table to copy the descriptors to
Return Value (succes):
VM_TRUE
Return Value (error):
VM_FALSE
Updates:
13 Jun 00: Return VimosBool instead of void (Maura)
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosBool copyWinTab2ObjTab(VimosWindowTable *winTable,
VimosObjectTable *objTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numObjectsInObjectObject(VimosObjectObject *obj)
Description:
Return number of object in a VimosObjectObject.
Input:
VimosObjectObject *obj
Pointer to the Object .
Return Value:
Number of objects in the VimosObjectObject
Updates:
11 Feb 99: Created (TAO)
--------------------------------------------------------------------------------
*/
int numObjectsInObjectObject(VimosObjectObject *obj);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool readFitsObjectTable(VimosObjectTable *objTable, fitsfile *fptr)
Description:
Read a FITS Table into an Object Table. This requires the FITS file to
be already open, and does not close it at the end.
Input:
VimosObjectTable *objTable
Pointer to the Object Table to copy the FITS table into.
fitsfile *fptr
Pointer to the FITS file where the table is to be found
Return Value:
VimosBool (true if the read is succesful, false otherwise)
Updates:
15 Dec 99: Created (BG)
02 Feb 00: Changed the handling of the table, from a standalone FITS file,
to an extension of the primary FITS file (MS)
--------------------------------------------------------------------------------
*/
VimosBool readFitsObjectTable(VimosObjectTable *objTable, fitsfile *fptr);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool writeFitsObjectTable(VimosObjectTable *winTable, fitsfile *fptr)
Description:
Write a Object Table into a FITS Table. This requires the FITS file
to be already open, and does not close it at the end. If an Extraction
Table extension is already present in the file, it is first removed, and
then the new one is written into a new extension.
Input:
VimosObjectTable *objTable
Pointer to the Object Table to write to a FITS Table
fitsfile *fptr
Pointer to the FITS file where the table is to be found
Return Value:
VimosBool (true if the write is succesful, false otherwise)
Updates:
15 Dec 99: Created (BG)
02 Feb 00: Changed the handling of the table, from a standalone FITS file,
to an extension of the primary FITS file (MS)
--------------------------------------------------------------------------------
*/
VimosBool writeFitsObjectTable(VimosObjectTable *objTable, fitsfile *fptr);
PIL_END_DECLS
#endif /* VM_OBJECTTABLE_H */
|
