IIINSTRUMENT Pipeline Reference Manual 4.4.3
visir_dfs.h
1/* $Id: visir_dfs.h,v 1.96 2013-05-14 12:59:23 jtaylor Exp $
2 *
3 * This file is part of the VISIR Pipeline
4 * Copyright (C) 2002,2003 European Southern Observatory
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA
19 */
20
21/*
22 * $Author: jtaylor $
23 * $Date: 2013-05-14 12:59:23 $
24 * $Revision: 1.96 $
25 * $Name: not supported by cvs2svn $
26 */
27
28#ifndef VISIR_DFS_H
29#define VISIR_DFS_H
30
31/*-----------------------------------------------------------------------------
32 Includes
33 -----------------------------------------------------------------------------*/
34
35#include <cpl.h>
36
37/*-----------------------------------------------------------------------------
38 Defines
39 -----------------------------------------------------------------------------*/
40
41/* Define here the PRO.CATG keywords */
42
43#define VISIR_IMG_COMBINE_COMBINED_PROCATG_CNJ "IMG_OBS_COMBINED_CNJ"
44#define VISIR_IMG_COMBINE_COMBINED_PROCATG_CJ "IMG_OBS_COMBINED_CJ"
45#define VISIR_IMG_COMBINE_COMBINED_PROCATG_NJ "IMG_OBS_COMBINED_NJ"
46#define VISIR_IMG_COMBINE_COMBINED_PROCATG_DJ "IMG_OBS_COMBINED_DJ"
47
48#define VISIR_IMG_COMBINE_ONEBEAM_PROCATG_CNJ "IMG_OBS_ONEBEAM_CNJ"
49#define VISIR_IMG_COMBINE_ONEBEAM_PROCATG_CJ "IMG_OBS_ONEBEAM_CJ"
50#define VISIR_IMG_COMBINE_ONEBEAM_PROCATG_NJ "IMG_OBS_ONEBEAM_NJ"
51#define VISIR_IMG_COMBINE_ONEBEAM_PROCATG_DJ "IMG_OBS_ONEBEAM_DJ"
52
53#define VISIR_IMG_PFOV_TAB_PROCATG_BIN "IMG_PFOV_TAB_BIN"
54#define VISIR_IMG_PFOV_TAB_PROCATG_TEL "IMG_PFOV_TAB_TEL"
55#define VISIR_IMG_PSF_TAB_PROCATG "IMG_PSF_TAB"
56#define VISIR_IMG_FOCFWHM_TAB_PROCATG "IMG_FOCUS_TAB"
57#define VISIR_IMG_ILLU_FITTED_PROCATG "IMG_ILLU_MAP"
58#define VISIR_IMG_ILLU_TAB_PROCATG "IMG_ILLU_TAB"
59#define VISIR_IMG_TRANS_TAB_PROCATG "IMG_TRANS_TAB"
60#define VISIR_IMG_ACHRO_TAB_PROCATG "IMG_ACHRO_TAB"
61#define VISIR_IMG_PHOT_COMBINED_PROCATG "IMG_PHOT_COMBINED"
62#define VISIR_IMG_PHOT_ONEBEAM_PROCATG "IMG_PHOT_ONEBEAM"
63#define VISIR_IMG_OBJ_COMBINED_PROCATG "IMG_OBJ_COMBINED"
64#define VISIR_IMG_OBJ_ONEBEAM_PROCATG "IMG_OBJ_ONEBEAM"
65#define VISIR_IMG_OBJ_CALIBRATED_PROCATG "IMG_OBJ_CALIBRATED"
66#define VISIR_IMG_FF_PROCATG "IMG_FF"
67#define VISIR_IMG_FF_BPM_PROCATG "IMG_BPM"
68#define VISIR_IMG_TECH_FF_PROCATG "IMG_FF_TECH"
69#define VISIR_IMG_TECH_FF_BPM_PROCATG "IMG_BPM_TECH"
70#define VISIR_IMG_DARK_AVG_PROCATG "IMG_DARK_AVG"
71#define VISIR_IMG_DARK_HOT_PROCATG "IMG_DARK_HOT"
72#define VISIR_IMG_DARK_COLD_PROCATG "IMG_DARK_COLD"
73#define VISIR_IMG_DARK_DEV_PROCATG "IMG_DARK_DEV"
74
75#define VISIR_SPC_OBS_TAB_PROCATG "SPC_OBS_LMR_TAB"
76#define VISIR_SPC_OBS_COMBINED_PROCATG "SPC_OBS_LMR_COMBINED"
77#define VISIR_SPC_OBS_WEIGHT_PROCATG "SPC_OBS_LMR_WEIGHT"
78#define VISIR_SPC_PHOT_COMBINED_PROCATG "SPC_PHOT_COMBINED"
79#define VISIR_SPC_PHOT_TAB_PROCATG "SPC_PHOT_TAB"
80#define VISIR_SPC_PHOT_WEIGHT_PROCATG "SPC_PHOT_WEIGHT"
81#define VISIR_SPC_PHOT_ECH_COMBINED_PROCATG "SPC_PHOT_HRG_COMBINED"
82#define VISIR_SPC_PHOT_ECH_TAB_PROCATG "SPC_PHOT_HRG_TAB"
83#define VISIR_SPC_PHOT_ECH_WEIGHT_PROCATG "SPC_PHOT_HRG_WEIGHT"
84#define VISIR_SPC_WCAL_TAB_PROCATG "SPC_WCAL_LMR_TAB"
85#define VISIR_SPC_OBS_ECH_TAB_PROCATG "SPC_OBS_HRG_TAB"
86#define VISIR_SPC_OBS_ECH_COMBINED_PROCATG "SPC_OBS_HRG_COMBINED"
87#define VISIR_SPC_OBS_ECH_WEIGHT_PROCATG "SPC_OBS_HRG_WEIGHT"
88#define VISIR_SPC_WCAL_ECH_TAB_PROCATG "SPC_WCAL_HRG_TAB"
89#define VISIR_SPC_FF_PROCATG "SPEC_FF"
90#define VISIR_SPC_FF_BPM_PROCATG "SPEC_BPM"
91#define VISIR_SPC_TECH_FF_PROCATG "SPEC_FF_TECH"
92#define VISIR_SPC_TECH_FF_BPM_PROCATG "SPEC_BPM_TECH"
93#define VISIR_SPC_DARK_AVG_PROCATG "SPEC_DARK_AVG"
94#define VISIR_SPC_DARK_HOT_PROCATG "SPEC_DARK_HOT"
95#define VISIR_SPC_DARK_COLD_PROCATG "SPEC_DARK_COLD"
96#define VISIR_SPC_DARK_DEV_PROCATG "SPEC_DARK_DEV"
97
98#define VISIR_IMG_COADDED_IMG "COADDED_IMAGE_COMBINED"
99#define VISIR_IMG_COADDED_WGT "COADDED_WEIGHT_COMBINED"
100#define VISIR_IMG_COADDED_CTR "COADDED_CONTRIBUTION_COMBINED"
101
102#define VISIR_UTIL_INPUTS_COMBINED_PROCATG "IMG_COMBINED"
103#define VISIR_UTIL_REPACK_A_ON_PROCATG "IMG_REPACKED_A_ON"
104#define VISIR_UTIL_REPACK_A_OFF_PROCATG "IMG_REPACKED_A_OFF"
105#define VISIR_UTIL_REPACK_MEAN_PROCATG "IMG_REPACKED_MEAN"
106#define VISIR_UTIL_REPACK_MEAN_A_PROCATG "IMG_REPACKED_MEAN_A"
107#define VISIR_UTIL_REPACK_MEAN_A_ON_PROCATG "IMG_REPACKED_MEAN_A_ON"
108#define VISIR_UTIL_REPACK_MEAN_A_OFF_PROCATG "IMG_REPACKED_MEAN_A_OFF"
109#define VISIR_UTIL_REPACK_B_ON_PROCATG "IMG_REPACKED_B_ON"
110#define VISIR_UTIL_REPACK_B_OFF_PROCATG "IMG_REPACKED_B_OFF"
111#define VISIR_UTIL_REPACK_MEAN_B_PROCATG "IMG_REPACKED_MEAN_B"
112#define VISIR_UTIL_REPACK_MEAN_B_ON_PROCATG "IMG_REPACKED_MEAN_B_ON"
113#define VISIR_UTIL_REPACK_MEAN_B_OFF_PROCATG "IMG_REPACKED_MEAN_B_OFF"
114#define VISIR_UTIL_DETECT_SHIFT_PROCATG "BEAM_DETECTED"
115#define VISIR_UTIL_DETECT_SHIFT_TEMPLATE_PROCATG "CORRELATION_TEMPLATE"
116#define VISIR_UTIL_CONVERT_PROCATG "IMG_CONVERTED"
117#define VISIR_UTIL_CONVERT_AUX_PROCATG "AUX_CONVERTED"
118#define VISIR_UTIL_UNDISTORT_PROCATG "UNDISTORTED"
119#define VISIR_IMA_STD_CAT_PROCATG "IMG_STD_CATALOG"
120#define VISIR_SPEC_STD_CAT_PROCATG "SPEC_STD_CATALOG"
121#define VISIR_SPEC_CAL_LINES_PROCATG "SPEC_CAL_LINES"
122#define VISIR_SPEC_CAL_QEFF_PROCATG "SPEC_CAL_QEFF"
123
124#define VISIR_IMG_CLIPPED_PROCATG "BPM"
125#define VISIR_IMG_CLIPPED_MAP_PROCATG "CONTRIBUTION_MAP"
126
127#define VISIR_UTIL_WEIGHT2ERROR_PROCATG "ERROR_MAP"
128#define VISIR_UTIL_ERROR_MAP_PROCATG "ERROR_MAP"
129#define VISIR_UTIL_WEIGHT_MAP_PROCATG "WEIGHT_MAP"
130#define VISIR_UTIL_VARIANCE_MAP_PROCATG "VARIANCE_MAP"
131#define VISIR_UTIL_NODDED "NODDED"
132#define VISIR_UTIL_NODDED_REFINED_POS "NODDED_REFINED"
133
134#define VISIR_UTIL_JOIN_PROCATG "JOIN"
135#define VISIR_UTIL_QC_PROCATG "QC_HEADER"
136
137/* Define here the DO.CATG keywords */
138
139#define VISIR_UTIL_DATA "DATA"
140#define VISIR_CALIB_FLAT "FLAT"
141#define VISIR_CALIB_BPM "BPM"
142#define VISIR_CALIB_STATIC_MASK "STATIC_MASK"
143#define VISIR_CALIB_STDSTAR_IMG "IMG_STD_CATALOG"
144#define VISIR_CALIB_STDSTAR_SPC "SPEC_STD_CATALOG"
145#define VISIR_CALIB_LINES_SPC "SPEC_CAL_LINES"
146#define VISIR_CALIB_QEFF_SPC "SPEC_CAL_QEFF"
147#define VISIR_CALIB_LIN "LINEARITY_TABLE"
148
149#define VISIR_EXTN_ERROR "ERROR MAP"
150#define VISIR_EXTN_WEIGHT "WEIGHT MAP"
151#define VISIR_EXTN_BPM "BAD PIXEL MAP"
152
153#define VISIR_ACQ_CNJ "ACQ_OBS_CHO_NOD_JIT"
154#define VISIR_IMG_BURST "BURST"
155#define VISIR_IMG_ACHRO_RAW "IM_CAL_ACHRO"
156#define VISIR_IMG_COMBINE_CN "IM_OBS_CHO_NOD"
157#define VISIR_IMG_COMBINE_CN_BURST "IM_OBS_CHO_NOD_BURST"
158#define VISIR_IMG_COMBINE_CNJ "IM_OBS_CHO_NOD_JIT"
159#define VISIR_IMG_COMBINE_CNJ_BURST "IM_OBS_CHO_NOD_JIT_BURST"
160#define VISIR_IMG_COMBINE_CJ "IM_OBS_CHO_JIT"
161#define VISIR_IMG_COMBINE_NJ "IM_OBS_NOD_JIT"
162#define VISIR_IMG_COMBINE_DJ "IM_OBS_DIR_JIT"
163#define VISIR_IMG_CAL_PHOT "IM_CAL_PHOT"
164#define VISIR_IMG_CAL_PHOT_PP "IM_CAL_PHOT_PREPROCESSED"
165#define VISIR_IMG_CAL_PHOT_BURST "IM_CAL_PHOT_BURST"
166#define VISIR_IMG_CAL_OBJ "IM_CAL_OBJECT"
167#define VISIR_IMG_CAL_OBJ_BURST "IM_CAL_OBJECT_BURST"
168#define VISIR_IMG_FF_RAW "IM_CAL_FLAT"
169#define VISIR_IMG_TECH_FF_RAW "IM_TECH_FLAT"
170#define VISIR_IMG_FOCFWHM_RAW "IM_TEC_FOCUS"
171#define VISIR_IMG_ILLU_RAW "IM_CAL_ILLU"
172#define VISIR_IMG_PFOV_BIN "IM_CAL_PFOV_BIN"
173#define VISIR_IMG_PFOV_TEL "IM_CAL_PFOV_TEL"
174#define VISIR_IMG_PHOT_RAW "IM_CAL_PHOT"
175#define VISIR_IMG_PSF_RAW "IM_CAL_PSF"
176#define VISIR_IMG_TRANS_RAW "IM_TEC_TRANS"
177#define VISIR_IMG_DARK_RAW "IM_CAL_DARK"
178#define VISIR_SPC_OBS_ECH_RAW "SPEC_OBS_HRG"
179#define VISIR_SPC_OBS_RAW "SPEC_OBS_LMR"
180#define VISIR_SPC_OBS_PP "SPEC_OBS_LMR_PREPROCESSED"
181#define VISIR_SPC_OBS_SKYFRAME "SPEC_OBS_LMR_SKYFRAME"
182#define VISIR_SPC_OBS_ECH_PP "SPEC_OBS_HRG_PREPROCESSED"
183#define VISIR_SPC_OBS_HR_RAW "SPEC_OBS_HR"
184#define VISIR_SPC_PHOT_RAW "SPEC_CAL_PHOT"
185#define VISIR_SPC_PHOT_PP "SPEC_CAL_PHOT_PREPROCESSED"
186#define VISIR_SPC_PHOT_ECH_RAW "SPEC_CAL_PHOT_HRG"
187#define VISIR_SPC_PHOT_ECH_PP "SPEC_CAL_PHOT_HRG_PREPROCESSED"
188#define VISIR_SPC_WCAL_ECH_RAW "SPEC_CAL_HRG_WCAL"
189#define VISIR_SPC_WCAL_RAW "SPEC_CAL_LMR_WCAL"
190#define VISIR_SPC_FF_RAW "SPEC_CAL_FLAT"
191#define VISIR_SPC_TECH_FF_RAW "SPEC_TECH_FLAT"
192#define VISIR_SPC_DARK_RAW "SPEC_CAL_DARK"
193
194#define VISIR_SAM_CAL_N_RAW "SAM_CAL_N"
195#define VISIR_SAM_CAL_CN_RAW "SAM_CAL_CN"
196#define VISIR_SAM_CAL_NJ_RAW "SAM_CAL_NJ"
197#define VISIR_SAM_CAL_CNJ_RAW "SAM_CAL_CNJ"
198#define VISIR_CORO_CAL_CNJ_RAW "CORO_CAL_CNJ"
199#define VISIR_SAM_OBS_N_RAW "SAM_OBS_N"
200#define VISIR_SAM_OBS_CN_RAW "SAM_OBS_CN"
201#define VISIR_SAM_OBS_NJ_RAW "SAM_OBS_NJ"
202#define VISIR_SAM_OBS_CNJ_RAW "SAM_OBS_CNJ"
203#define VISIR_CORO_OBS_CNJ_RAW "CORO_OBS_CNJ"
204
205#define VISIR_UTIL_WEIGHT2ERROR "WEIGHT_MAP"
206#define VISIR_UTIL_WEIGHT_MAP "WEIGHT_MAP"
207#define VISIR_UTIL_ERROR_MAP "ERROR_MAP"
208#define VISIR_UTIL_VARIANCE_MAP "VARIANCE_MAP"
209#define VISIR_UTIL_INPUTS_RAW "RAW"
210#define VISIR_UTIL_CORRECTED "BKG_CORRECTED"
211#define VISIR_UTIL_REPACK_RAW "CUBE2"
212#define VISIR_UTIL_CONVERT_RAW "POS_CONVERT"
213#define VISIR_UTIL_CONVERT_TAB "POS_TABLE"
214#define VISIR_UTIL_CONVERT_INV "INV_CONVERT"
215#define VISIR_UTIL_CONVERT_POS_AUX "POS_AUX"
216#define VISIR_UTIL_CONVERT_INV_AUX "INV_AUX"
217#define VISIR_UTIL_UNDISTORT_RAW "CHOPNOD_CORRECTED"
218#define VISIR_IMG_LINES_ASCII "IMG_LINES_ASCII"
219#define VISIR_SPC_LINES_ASCII "SPC_LINES_ASCII"
220#define VISIR_SPC_QEFF_ASCII "SPC_QEFF_ASCII"
221#define VISIR_SPC_CAT_ASCII "SPC_CAT_ASCII"
222
223#define MAN_VISIR_CALIB_BPM_IMG "\nAdditionally, a bad pixel map with a " \
224"PRO.CATG of " VISIR_IMG_FF_BPM_PROCATG "\nmay be added to the Set Of Frames " \
225"with tag: " VISIR_CALIB_BPM "."
226
227#define MAN_VISIR_CALIB_BPM_SPC "\nAdditionally, a bad pixel map with a " \
228"PRO.CATG of " VISIR_SPC_FF_BPM_PROCATG "\nmay be added to the Set Of Frames " \
229"with tag: " VISIR_CALIB_BPM "."
230
231
232/*-----------------------------------------------------------------------------
233 Functions prototypes
234 -----------------------------------------------------------------------------*/
235
236int visir_dfs_set_groups(cpl_frameset *);
237const char *
238visir_dfs_output_catg(const char *, const char *);
239cpl_error_code visir_dfs_check_framelist_tag(const irplib_framelist *);
240void visir_dfs_update_header(cpl_propertylist* plist);
241
242#endif
cpl_error_code visir_dfs_check_framelist_tag(const irplib_framelist *)
Check the tags in a frameset (group raw only)
Definition: visir_dfs.c:234
int visir_dfs_set_groups(cpl_frameset *)
Set the group as RAW or CALIB in a frameset.
Definition: visir_dfs.c:72