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
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
|
/* $Id: vmwindowtable.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
*/
/*
* $Author: cgarcia $
* $Date: 2013-03-25 11:43:04 $
* $Revision: 1.2 $
* $Name: not supported by cvs2svn $
*/
#ifndef VM_WINDOWTABLE_H
#define VM_WINDOWTABLE_H
#include <fitsio.h>
#include <pilmacros.h>
#include <vmextractiontable.h>
PIL_BEGIN_DECLS
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
defines of name strings for the Window Tables
Description:
The following strings are defined to use in the Window Tables for
identifying the name of the table and of the columns
Values:
VM_WIN string giving the name of the Extraction Table
VM_WIN_SLIT name of slit ID column
VM_WIN_SPC_LEN name of column of spectrum length
VM_WIN_OBJ_NO name of column of object number
more to follow.......
Updates:
03 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
#define VM_WIN "WIN"
/* Column names */
#define VM_WIN_SLIT "SLIT"
#define VM_WIN_SPC_LEN "SPC LEN"
#define VM_WIN_OBJ_NO "OBJ NO"
/* more to follow ... */
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
stucture VimosWindowObject
Description:
Linked list structure that contains the information of objects in one slit,
as needed by the Window Table. VimosWindowObjects are pointed to in a
VimosWindowSlit
Layout:
int objStart;
int objEnd;
int objNo;
float objPos;
float objWidth;
double objX;
double objY;
VimosFloatArray *objProfile;
Bool posDef;
double objRA;
double objDec;
Bool parDef;
VimosWindowObject *prev;
VimosWindowObject *next;
Updates:
09 Nov 98: Created (TAO)
03 Feb 00: Removed objWidth, objPeak, skyLevel, as they are not used (MS)
12 Aug 02: Addes objWidth and objProfile (PF)
--------------------------------------------------------------------------------
*/
typedef struct _VIMOS_WINDOW_OBJ_
{
int objStart;
int objEnd;
int objNo;
float objPos;
float objWidth;
float objX;
float objY;
VimosFloatArray *objProfile;
VimosBool posDef;
double objRA;
double objDec;
VimosBool parDef;
/* float objPeak;
float skyLevel; */
/**/
struct _VIMOS_WINDOW_OBJ_ *prev;
struct _VIMOS_WINDOW_OBJ_ *next;
} VimosWindowObject;
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
structure VimosWindowSlit
Description:
Linked list structure that contains the information of the slits defined in
a Vimos spectroscopic observation.
Layout:
int slitNo;
int IFUslitNo;
int IFUfibNo;
float IFUfibTrans;
VimosBool specLong;
int specStart;
int specEnd;
VimosWindowSlit *prev;
VimosWindowSlit *next;
int numObj;
VimosWindowObject *objs;
Updates:
09 Nov 98: Created (TAO)
03 Feb 00: Added IFU slit and fiber number information (MS)
03 Sept 02: Added IFU fib. trans column, defaulted to zero for MOS, will
be updated by VmIfuWindowTable for IFU (AZ)
--------------------------------------------------------------------------------
*/
typedef struct _VIMOS_WINDOW_SLIT_
{
int slitNo;
int IFUslitNo;
int IFUfibNo;
float IFUfibTrans;
VimosBool specLong;
int specStart;
int specEnd;
struct _VIMOS_WINDOW_SLIT_ *prev;
struct _VIMOS_WINDOW_SLIT_ *next;
/* Number of objects in this slit */
int numObj;
VimosWindowObject *objs;
} VimosWindowSlit;
typedef struct _VIMOS_WINDOW_TABLE_
{
char name[VM_DESC_LENGTH];
VimosDescriptor *descs;
VimosWindowSlit *slits;
fitsfile *fptr;
} VimosWindowTable;
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosWindowObject *newWindowObject()
Description:
Returns a pointer to a new WindowObject structure.
Input:
void
Return Value (succes):
Pointer to a newly allocated WindowObject structure. All fields are
initialized to 0
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
24 Nov 98: call exit(-1) on error (TAO)
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosWindowObject *newWindowObject();
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteWindowObject(VimosWindowObject *wObject)
Description:
Deletes all VimosWindowObejcts contained in the linked list wObject
Input:
VimosWindowObject *wObject
Pointer to VimosWindowObject list to be deleted
Return Value:
void
Updates:
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
void deleteWindowObject(VimosWindowObject *wObj);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosWindowSlit *newWindowSlit()
Description:
Returns a pointer to a new VimosWindowSlit structure.
Input:
void
Return Value (success):
Pointer to a newly allocated VimosWindowSlit structure. All fields are
initialized to 0
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
24 Nov 98: call exit(-1) on error (TAO)
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosWindowSlit *newWindowSlit();
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteWindowSlit(VimosWindowSlit *wSlit)
Description:
Deletes all VimosWindowSlits (and VimosWindowObjects contained in the
VimosWindowSlits) contained in the linked list wSlit
Input:
VimosWindowSlit *wSlit
Pointer to VimosWindowSlit list to be deleted
Return Value:
void
Updates:
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
void deleteWindowSlit(VimosWindowSlit *wSlit);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosWindowTable *newWindowTable()
Description:
Allocate a new Window Table. All fields are initialized to 0, except the
name field is set to VM_WIN
Input:
void
Return Value (success):
Pointer to the new VimosWindowTable
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
24 Nov 98: call exit(-1) on error (TAO)
20 Nov 98: Adapted for new declaration of VimosWindowTable
06 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosWindowTable *newWindowTable();
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteWindowTable(VimosWindowTable *wTable)
Description:
Delete a Window Table.
Input:
VimosWindowTable *wTable
Pointer of Window Table to be deleted
Return Value:
void
Updates:
09 Nov 98: Created (TAO)
20 Nov 98: Adapted for new declaration of VimosWindowTable
--------------------------------------------------------------------------------
*/
void deleteWindowTable(VimosWindowTable *wTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool copyExtTab2WinTab(VimosExtractionTable *extTable,
VimosWindowTable *winTable)
Description:
Copy ALL descriptors (including those that may not be relevant) of an
Extraction Table into Window Table.
Input:
VimosTable *extTable
Pointer to the Extraction Table to copy the descriptors from
VimosWindowTable *winTable
Pointer to the Window 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)
06 Nov 98: Created (TAO)
20 Nov 98: Adapted for new declaration of VimosWindowTable
--------------------------------------------------------------------------------
*/
VimosBool copyExtTab2WinTab(VimosExtractionTable *extTable,
VimosWindowTable *winTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numSlitsInWindowTable(VimosWindowTable *wTable)
Description:
Return number of slits in a Window Table.
Input:
VimosWindowTable *wtable
Pointer to the Window Table.
Return Value:
Number of slits in the Window Table
Updates:
06 Nov 98: Created (TAO)
20 Nov 98: Adapted for new declaration of VimosWindowTable
--------------------------------------------------------------------------------
*/
int numSlitsInWindowTable(VimosWindowTable *wTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numObjsInWindowTable(VimosWindowTable *wTable)
Description:
Return number of objects in a Window Table.
Input:
VimosWindowTable *wtable
Pointer to the Window Table.
Return Value:
Number of objects in the Window Table
Updates:
09 Nov 98: Created (TAO)
20 Nov 98: Adapted for new declaration of VimosWindowTable
--------------------------------------------------------------------------------
*/
int numObjsInWindowTable(VimosWindowTable *wTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numObjectsInObject(VimosWindowObject *wObject)
Description:
Return number of objects in a Window Object. Since a Window Object is a
linked list of Window Objects, more than one objects can be contained in the
list.
Input:
VimosWindowObject *wObject
Pointer to the Window Object for which the number of objects has to be
counted.
Return Value:
Number of objects in the Window Object
Updates:
09 Nov 98: Created (TAO)
-------------------------------------------------------------------------------- */
int numObjectsInWindowObject(VimosWindowObject *wObject);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numObjectInWindowSlit(VimosWindowSlit *wSlit)
Description:
Return number of objects in a Window Slit. Since a Window Slit is a
linked list of Window Slits, more than one slit can be contained in the
list. The sum of all objects in all slits is returned.
Input:
VimosWindowSlit *wSlit
Pointer to the Window Slit for which the number of objects has to be
counted.
Return Value:
Number of objects in the Window Slit
Updates:
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
int numObjectsInWindowSlit(VimosWindowSlit *wSlit);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
int numSlitsInWindowSlit(VimosWindowSlit *wSlit)
Description:
Return number of slits in a Window Slit. Since a Window Slit is a linked
list of Window Slits, more than one slit can be contained in the list.
Input:
VimosWindowSlit *wSlit
Pointer to the Window Slit for which the number of slits has to be counted.
Return Value:
Number of slits in the Window Slit
Updates:
09 Nov 98: Created (TAO)
--------------------------------------------------------------------------------
*/
int numEmptySlitsInWindowSlit(VimosWindowSlit *wSlit);
int numSlitsInWindowSlit(VimosWindowSlit *wSlit);
VimosBool windowObjectInRow(VimosWindowSlit *slit, int row);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool shiftWindowObjects(VimosWindowTable *refWinTable,
VimosWindowTable *winTable, float offSet);
Description:
Add an offSet to objects in refWinTable and put them in winTable
Input:
VimosWindowTable *refWinTable -
Pointer to the Window Table to be used as reference
VimosWindowTable *winTable -
Pointer to the Window Table in which the 'shifted' window objects
are put
float offSet -
offset to be added
Return Value:
VM_TRUE
Updates:
12 Aug 02 Created (PF)
--------------------------------------------------------------------------------
*/
VimosBool shiftWindowObjects(VimosWindowTable *refWinTable, VimosWindowTable *winTable, float offSet);
/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool readFitsWindowTable(VimosWindowTable *winTable, fitsfile *fptr)
Description:
Read a FITS Table into a Window Table. This requires the FITS file to
be already open, and does not close it at the end.
Input:
VimosWindowTable *winTable
Pointer to the Window 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 readFitsWindowTable(VimosWindowTable *winTable, fitsfile *fptr);
/*
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool writeFitsWindowTable(VimosWindowTable *winTable, fitsfile *fptr)
Description:
Write a Window 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:
VimosWindowTable *winTable
Pointer to the Window 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 writeFitsWindowTable(VimosWindowTable *winTable, fitsfile *fptr);
PIL_END_DECLS
#endif /* VM_WINDOWTABLE_H */
|
