GIRAFFE Pipeline Reference Manual

giwlcalibration.h
1 /* $Id$
2  *
3  * This file is part of the GIRAFFE Pipeline
4  * Copyright (C) 2002-2006 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 02110-1301 USA
19  */
20 
21 /*
22  * $Author$
23  * $Date$
24  * $Revision$
25  * $Name$
26  */
27 
28 #ifndef GIWLCALIBRATION_H
29 #define GIWLCALIBRATION_H
30 
31 #include <cxtypes.h>
32 
33 #include <cpl_macros.h>
34 #include <cpl_parameterlist.h>
35 
36 #include <gitable.h>
37 #include <girange.h>
38 #include <gilinedata.h>
39 #include <gilocalization.h>
40 #include <giextraction.h>
41 #include <giwlsolution.h>
42 
43 
44 #ifdef __cplusplus
45 extern "C" {
46 #endif
47 
48 
57 struct GiWCalConfig {
58 
63  cxint line_nwidths;
64 
69  cxint *line_widths;
70 
77  cxdouble line_separation;
78 
84  cxdouble line_fluxratio;
85 
91  cxdouble line_brightness;
92 
98  cxint line_count;
99 
104  GiRange *line_wlrange;
105 
106 
114  cxchar *line_model;
115 
122  cxchar *line_residuals;
123 
129  cxdouble line_threshold;
130 
135  cxdouble line_offset;
136 
142  cxint line_niter;
143 
149  cxint line_ntest;
150 
156  cxdouble line_dchisq;
157 
164 
171 
176  cxdouble line_saturation;
177 
182  cxint16 slit_position;
183 
188  cxdouble slit_dx;
189 
194  cxdouble slit_dy;
195 
200  cxdouble slit_phi;
201 
209  cxchar *opt_model;
210 
216 
222  cxbool opt_solution;
223 
229  cxbool opt_subslits;
230 
235  cxint16 opt_flags;
236 
242  cxint opt_niter;
243 
249  cxint opt_ntest;
250 
256  cxdouble opt_dchisq;
257 
263  cxdouble pxw_cliplevel;
264 
271 
277  cxdouble pxw_clipmfrac;
278 
283  cxint pxw_xorder;
284 
289  cxint pxw_yorder;
290 
296  cxdouble xws_cliplevel;
297 
304 
310  cxdouble xws_clipmfrac;
311 
316  cxint xws_xorder;
317 
322  cxint xws_yorder;
323 
324 };
325 
326 typedef struct GiWCalConfig GiWCalConfig;
327 
328 
329 struct GiWCalData {
330  GiTable *coeffs;
331  GiTable *lines;
332  GiLineData *linedata;
333 };
334 
335 typedef struct GiWCalData GiWCalData;
336 
337 
338 GiWCalData *giraffe_wcaldata_new(void);
339 void giraffe_wcaldata_delete(GiWCalData *self);
340 
341 
342 cxint giraffe_calibrate_wavelength(GiWCalData *result,
343  GiExtraction *extraction,
344  GiLocalization *localization,
345  GiTable *fibers, GiTable *slitgeometry,
346  GiTable *grating, GiTable *lines,
347  GiTable *initial, GiWCalConfig *config);
348 
351 void giraffe_wlcalibration_config_add(cpl_parameterlist *);
352 
353 
354 #ifdef __cplusplus
355 }
356 #endif
357 
358 #endif /* GIWLCALIBRATION_H */
cxchar * opt_model
cxdouble line_saturation
GiWCalConfig * giraffe_wlcalibration_config_create(cpl_parameterlist *)
Creates a setup structure for the wavelength calibration.
cxdouble line_dchisq
GiRange * line_wlrange
cxchar * line_model
Wavelength calibration configuration data structure.
cxdouble line_brightness
cxdouble slit_dx
cxdouble line_widthexponent
cxdouble line_rwidthratio
cxdouble slit_dy
cxdouble line_offset
cxint16 slit_position
cxdouble line_fluxratio
void giraffe_wlcalibration_config_add(cpl_parameterlist *)
Adds parameters for the wavelength calibration.
void giraffe_wlcalibration_config_destroy(GiWCalConfig *)
Destroys a wavelength calibration setup structure.
cxdouble line_threshold
cxint giraffe_calibrate_wavelength(GiWCalData *result, GiExtraction *extraction, GiLocalization *localization, GiTable *fibers, GiTable *slitgeometry, GiTable *grating, GiTable *lines, GiTable *initial, GiWCalConfig *config)
Compute the wavelength solution for the given extracted arc-lamp spectra.
cxdouble slit_phi
cxdouble pxw_clipmfrac
cxdouble xws_clipmfrac
cxint * line_widths
cxdouble opt_dchisq
cxdouble xws_cliplevel
cxdouble line_separation
cxchar * line_residuals
cxdouble pxw_cliplevel

This file is part of the GIRAFFE Pipeline Reference Manual 2.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Mar 11 2015 13:19:42 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2004