GIRAFFE Pipeline Reference Manual

giwlsolution.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 GIWLSOLUTION_H
21 #define GIWLSOLUTION_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 #include <cpl_table.h>
27 
28 #include <gimodel.h>
29 #include <gigrating.h>
30 #include <giwlresiduals.h>
31 
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 
38 typedef struct GiWlSolution GiWlSolution;
39 
40 
41 GiWlSolution *giraffe_wlsolution_new(const cxchar *name, cxint orientation,
42  cxint npixels, cxdouble pixelsize,
43  GiGrating *grating);
44 GiWlSolution *giraffe_wlsolution_clone(const GiWlSolution *other);
45 GiWlSolution *giraffe_wlsolution_create(GiTable *solution, GiImage *spectra,
46  GiGrating *grating);
47 void giraffe_wlsolution_delete(GiWlSolution *self);
48 
49 const cxchar *giraffe_wlsolution_name(const GiWlSolution *self);
50 GiModel *giraffe_wlsolution_model(const GiWlSolution *self);
51 
52 void giraffe_wlsolution_reset_residuals(GiWlSolution *self);
53 
54 cxint giraffe_wlsolution_set_subslits(GiWlSolution *self, cxbool flag);
55 cxbool giraffe_wlsolution_get_subslits(const GiWlSolution *self);
56 
57 cxint giraffe_wlsolution_set_residuals(GiWlSolution *self,
58  const GiWlResiduals *residuals);
59 GiWlResiduals *giraffe_wlsolution_get_residuals(const GiWlSolution *self);
60 
61 cxdouble giraffe_wlsolution_compute_pixel(const GiWlSolution *self,
62  cxdouble lambda, cxdouble x,
63  cxdouble y, cxint *status);
64 
65 cxdouble giraffe_wlsolution_compute_residual(const GiWlSolution *self,
66  cxdouble x, cxdouble y);
67 
68 GiTable *giraffe_wlsolution_create_table(const GiWlSolution *solution);
69 
70 
71 #ifdef __cplusplus
72 }
73 #endif
74 
75 #endif /* GIWLSOLUTION_H */
GiWlSolution * giraffe_wlsolution_create(GiTable *solution, GiImage *spectra, GiGrating *grating)
Create a new wavelength solution from a wavelength solution table.
Definition: giwlsolution.c:206
GiWlSolution * giraffe_wlsolution_clone(const GiWlSolution *other)
Create a new wavelength solution from another wavelength solution.
Definition: giwlsolution.c:168
Structure to handle Grating Information.
Definition: gigrating.h:44

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:52 by doxygen 1.9.1 written by Dimitri van Heesch, © 1997-2004