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
|
/* $Id: vmgrismtable.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_GRISMTABLE_H
#define VM_GRISMTABLE_H
#include <fitsio.h>
#include <pilmacros.h>
#include <vmtable.h>
PIL_BEGIN_DECLS
#define VM_GRS "GRS"
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosTable *newGrismTable()
Description:
Allocate a new Grism Table. This is a VimosTable with name VM_GRS (which
has value "GRS").
Only a Descriptor "TABLE" is present, with value "GRS".
Input:
void
Return Value (success):
Pointer to the new VimosTable
Return Value (error):
NULL
Updates:
13 Jun 00: Return NULL on error instead of exiting (Maura)
24 Nov 98: Call exit(-1) instead of return(NULL) on error (TAO)
03 Nov 98: Created (TAO)
10 Nov 98: Changed to fit new table structure (TAO)
--------------------------------------------------------------------------------
*/
VimosTable *newGrismTable(/* void */);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
void deleteWindowTable(VimosTable *gTable)
Description:
Delete a Grism Table. This is just an esthetic wrapper for
deleteTable(gTable)
Input:
VimosTable *gTable
Pointer of Grism Table to be deleted
Return Value:
void
Updates:
10 Nov 98: Created (TAO)
-------------------------------------------------------------------------------- */
void deleteGrismTable(VimosTable *gTable);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool readSkyLines(VimosDescriptor desc, int *numSkyLines,
VimosFloatArray **skyLines);
Description:
Read the information on sky lines from the Descriptors
Input:
VimosDescriptor *desc
Pointer to the VimosDescriptors to read from
Output:
int *numSkyLines
Number of sky lines found
VimosFloatArray **skyLines;
Array containg the wavelengths of the sky lines. This VimosFloatArray is
constructed by readSkyLines.
Return Value (succes):
VM_TRUE
Return Value (error):
VM_FALSE
Updates:
13 Jun 00: Return VimosBool instead of void (Maura)
30 Mar 99: Created (TAO)
--------------------------------------------------------------------------------
*/
VimosBool readSkyLines(VimosDescriptor *desc, int *numSkyLines,
VimosFloatArray **skyLines);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool readFitsGrismTable(VimosTable *grsTable, fitsfile *fptr)
Description:
Read a FITS Table into a Grism Table. This function is just an esthetic
wrapper for readMidasTable, except that it checks that the type of the
VimosTable is VM_GRS (=="GRS"). It requires the FITS file to
be already open, and does not close it at the end.
Input:
VimosTable *grsTable
Pointer to the Grism 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 readFitsGrismTable(VimosTable *grsTable, fitsfile *fptr);
/*
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
VimosBool writeFitsGrismTable(VimosTable *grsTable, fitsfile *fptr)
Description:
Write a Grism Table into a FITS Table. This function is just an esthetic
wrapper for writeFitsTable, except that it checks that the type of the
VimosTable is VM_GRS (=="GRS"). It requires the FITS file
to be already open, and does not close it at the end. If a Grism
Table extension is already present in the file, it is first removed, and
then the new one is written into a new extension.
Input:
VimosTable *grsTable
Pointer to the Grism 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 writeFitsGrismTable(VimosTable *grsTable, fitsfile *fptr);
PIL_END_DECLS
#endif /* VM_GRISMTABLE_H */
|
