File: vmidstable.h

package info (click to toggle)
cpl-plugin-vimos 4.1.1%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 28,228 kB
  • sloc: ansic: 169,271; cpp: 16,177; sh: 4,344; python: 3,678; makefile: 1,138; perl: 10
file content (158 lines) | stat: -rw-r--r-- 4,643 bytes parent folder | download | duplicates (5)
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
/* $Id: vmidstable.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_IDSTABLE_H
#define VM_IDSTABLE_H

#include <pilmacros.h>

#include <vmtable.h>


PIL_BEGIN_DECLS

#define    VM_IDS     "IDS"

/* 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   VimosTable *newIdsTable()

   Description:
   Allocate a new IDS Table. This is a VimosTable with name VM_IDS (which
   has value "IDS").
   Only a Descriptor "TABLE" is present, with value "IDS".
   
   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  *newIdsTable(void);


/* 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   void deleteWindowTable(VimosTable *gTable)
   
   Description:
   Delete a IDS Table. This is just an esthetic wrapper for
   deleteTable(gTable)
   
   Input: 
   VimosTable *gTable
   Pointer of IDS Table to be deleted
   
   Return Value:
   void
   
   Updates:
   10 Nov 98: Created (TAO)

-------------------------------------------------------------------------------- */
void        deleteIdsTable(VimosTable *gTable);


/* 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   VimosBool readFitsIdsTable(VimosTable *idsTable, fitsfile *fptr)
   Description:
   Read a FITS Table into a IDS Table. This function is just an esthetic
   wrapper for readMidasTable, except that it checks that the type of the
   VimosTable is VM_IDS (=="IDS"). It requires the FITS file to 
   be already open, and does not close it at the end.
   
   Input:
   VimosTable *idsTable  
   Pointer to the IDS 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 readFitsIdsTable(VimosTable *idsTable, fitsfile *fptr);



/* 
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

   VimosBool writeFitsIdsTable(VimosTable *idsTable, fitsfile *fptr)

   Description:
   Write a IDS 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_IDS (=="IDS"). It requires the FITS file
   to be already open, and does not close it at the end. If a IDS
   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 *idsTable  
   Pointer to the IDS 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 writeFitsIdsTable(VimosTable *idsTable, fitsfile *fptr);

PIL_END_DECLS

#endif /* VM_IDSTABLE_H */