GIRAFFE Pipeline Reference Manual

gisgcalibration.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 GISGCALIBRATION_H
21 #define GISGCALIBRATION_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 #include <cpl_parameterlist.h>
27 
28 #include <girange.h>
29 #include <giimage.h>
30 #include <gitable.h>
31 #include <gilocalization.h>
32 #include <giextraction.h>
33 #include <girebinning.h>
34 
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 
49 struct GiSGCalConfig {
50 
55  cxint repeat;
56 
62  cxdouble zmax;
63 
68  cxdouble cc_step;
69 
75  cxbool cc_wdomain;
76 
82  GiRange* cc_domain;
83 
88  GiRange* rv_limits;
89 
94  cxint rv_niter;
95 
100  cxdouble rv_wfactor;
101 
106  cxint pf_niter;
107 
112  cxint pf_ntest;
113 
118  cxdouble pf_dchisq;
119 
120 };
121 
122 typedef struct GiSGCalConfig GiSGCalConfig;
123 
124 
125 cxint giraffe_calibrate_slit(GiTable* result, const GiExtraction* extraction,
126  const GiLocalization* localization,
127  const GiTable* fibers, const GiTable* wlsolution,
128  const GiTable* slitgeometry,
129  const GiTable* grating, const GiTable* mask,
130  const GiSGCalConfig* config);
131 
132 cxint giraffe_compute_offsets(GiTable* fibers,
133  const GiRebinning* rebinning,
134  const GiTable* grating,
135  const GiTable* mask,
136  const GiSGCalConfig* config);
137 
138 GiSGCalConfig* giraffe_sgcalibration_config_create(cpl_parameterlist* list);
140 void giraffe_sgcalibration_config_add(cpl_parameterlist* list);
141 
142 
143 #ifdef __cplusplus
144 }
145 #endif
146 
147 #endif /* GISGCALIBRATION_H */
GiSGCalConfig * giraffe_sgcalibration_config_create(cpl_parameterlist *list)
Creates a setup structure for the slit geometry calibration.
cxint giraffe_compute_offsets(GiTable *fibers, const GiRebinning *rebinning, const GiTable *grating, const GiTable *mask, const GiSGCalConfig *config)
Compute wavelength offsets for a set of rebinned input spectrum.
void giraffe_sgcalibration_config_destroy(GiSGCalConfig *config)
Destroys a sgcalibration field setup structure.
void giraffe_sgcalibration_config_add(cpl_parameterlist *list)
Adds parameters for the sgcalibration correction computation.
cxint giraffe_calibrate_slit(GiTable *result, const GiExtraction *extraction, const GiLocalization *localization, const GiTable *fibers, const GiTable *wlsolution, const GiTable *slitgeometry, const GiTable *grating, const GiTable *mask, const GiSGCalConfig *config)
Compute a slit geometry corresponding to the given rebinned spectrum.
Slit geometry calibration configuration data structure.
GiRange * cc_domain
cxdouble pf_dchisq
GiRange * rv_limits
cxdouble rv_wfactor
cxdouble cc_step

This file is part of the GIRAFFE Pipeline Reference Manual 2.16.10.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Thu Dec 15 2022 21:18:51 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2004