GIRAFFE Pipeline Reference Manual

giflat.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 GIFLAT_H
21 #define GIFLAT_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 
27 #include <giimage.h>
28 #include <giextraction.h>
29 
30 
31 #ifdef __cplusplus
32 extern "C" {
33 #endif
34 
35 
36 struct GiFlatConfig {
37  cxbool load;
38  cxbool apply;
39  cxbool transmission;
40 };
41 
42 typedef struct GiFlatConfig GiFlatConfig;
43 
44 
45 cxint giraffe_flat_apply(GiExtraction *spectra, const GiTable *fibers,
46  const GiImage *flat, const GiImage* errors,
47  GiFlatConfig *config);
48 
49 
50 /*
51  * Convenience functions
52  */
53 
54 GiFlatConfig *giraffe_flat_config_create(cpl_parameterlist *list);
55 void giraffe_flat_config_destroy(GiFlatConfig *config);
56 
57 void giraffe_flat_config_add(cpl_parameterlist *list);
58 
59 
60 #ifdef __cplusplus
61 }
62 #endif
63 
64 #endif /* GIFLAT_H */
GiFlatConfig * giraffe_flat_config_create(cpl_parameterlist *list)
Creates a setup structure for the flat field correction.
Definition: giflat.c:302
void giraffe_flat_config_destroy(GiFlatConfig *config)
Destroys a flat field setup structure.
Definition: giflat.c:353
void giraffe_flat_config_add(cpl_parameterlist *list)
Adds parameters for the flat field correction.
Definition: giflat.c:376
cxint giraffe_flat_apply(GiExtraction *spectra, const GiTable *fibers, const GiImage *flat, const GiImage *errors, GiFlatConfig *config)
Apply the flat field correction to the given extracted spectra.
Definition: giflat.c:238

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