GIRAFFE Pipeline Reference Manual

giwlcalibration.h
1/*
2 * This file is part of the GIRAFFE Pipeline
3 * Copyright (C) 2002-2019 European Southern Observatory
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
20#ifndef GIWLCALIBRATION_H
21#define GIWLCALIBRATION_H
22
23#include <cxtypes.h>
24
25#include <cpl_macros.h>
26#include <cpl_parameterlist.h>
27
28#include <gitable.h>
29#include <girange.h>
30#include <gilinedata.h>
31#include <gilocalization.h>
32#include <giextraction.h>
33#include <giwlsolution.h>
34
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40
50
56
62
70
77
84
91
96 GiRange *line_wlrange;
97
98
106 cxchar *line_model;
107
115
122
127 cxdouble line_offset;
128
135
142
148 cxdouble line_dchisq;
149
156
163
169
175
180 cxdouble slit_dx;
181
186 cxdouble slit_dy;
187
192 cxdouble slit_phi;
193
201 cxchar *opt_model;
202
208
215
222
227 cxint16 opt_flags;
228
235
242
248 cxdouble opt_dchisq;
249
256
263
270
276
282
289
296
303
309
315
316};
317
318typedef struct GiWCalConfig GiWCalConfig;
319
320
321struct GiWCalData {
322 GiTable *coeffs;
323 GiTable *lines;
324 GiLineData *linedata;
325};
326
327typedef struct GiWCalData GiWCalData;
328
329
330GiWCalData *giraffe_wcaldata_new(void);
331void giraffe_wcaldata_delete(GiWCalData *self);
332
333
334cxint giraffe_calibrate_wavelength(GiWCalData *result,
335 GiExtraction *extraction,
336 GiLocalization *localization,
337 GiTable *fibers, GiTable *slitgeometry,
338 GiTable *grating, GiTable *lines,
339 GiTable *initial, GiWCalConfig *config);
340
343void giraffe_wlcalibration_config_add(cpl_parameterlist *);
344
345
346#ifdef __cplusplus
347}
348#endif
349
350#endif /* GIWLCALIBRATION_H */
void giraffe_wlcalibration_config_add(cpl_parameterlist *)
Adds parameters for the wavelength calibration.
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.
GiWCalConfig * giraffe_wlcalibration_config_create(cpl_parameterlist *)
Creates a setup structure for the wavelength calibration.
void giraffe_wlcalibration_config_destroy(GiWCalConfig *)
Destroys a wavelength calibration setup structure.
Wavelength calibration configuration data structure.
cxchar * line_model
GiRange * line_wlrange
cxdouble line_widthexponent
cxdouble slit_dy
cxdouble line_brightness
cxdouble pxw_clipmfrac
cxdouble slit_dx
cxdouble pxw_cliplevel
cxdouble line_rwidthratio
cxdouble line_offset
cxdouble line_fluxratio
cxdouble slit_phi
cxdouble line_dchisq
cxdouble line_saturation
cxdouble xws_cliplevel
cxint * line_widths
cxdouble line_threshold
cxdouble opt_dchisq
cxdouble xws_clipmfrac
cxchar * line_residuals
cxint16 slit_position
cxchar * opt_model
cxdouble line_separation

This file is part of the GIRAFFE Pipeline Reference Manual 2.16.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Mon Feb 24 2025 09:27:59 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2004