GIRAFFE Pipeline Reference Manual

gitransmission.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 GITRANSMISSION_H
21 #define GITRANSMISSION_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 
27 #include <giimage.h>
28 #include <gitable.h>
29 #include <gilocalization.h>
30 #include <giextraction.h>
31 
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 
38  struct GiTransmissionConfig {
39  cxbool transmission;
40  };
41 
42  typedef struct GiTransmissionConfig GiTransmissionConfig;
43 
44 
45  cxint
46  giraffe_transmission_compute(GiExtraction* extraction, GiTable* fibers,
47  GiLocalization* localization,
48  GiTable* wcalcoeff, GiTable* grating,
49  GiTable* slitgeometry);
50 
51  cxint
52  giraffe_transmission_setup(GiTable* fibers, GiTable* reference);
53 
54  cxint
55  giraffe_transmission_apply(GiExtraction* spectra, GiTable* fibers);
56 
57  cxint
58  giraffe_transmission_attach(GiTable* fibers, const cxchar* filename);
59 
60 
61  /*
62  * Convenience functions
63  */
64 
65  GiTransmissionConfig*
66  giraffe_transmission_config_create(cpl_parameterlist* list);
67 
68  void
69  giraffe_transmission_config_destroy(GiTransmissionConfig* config);
70 
71  void
72  giraffe_transmission_config_add(cpl_parameterlist* list);
73 
74 
75 #ifdef __cplusplus
76 }
77 #endif
78 
79 #endif /* GITRANSMISSION_H */
GiTransmissionConfig * giraffe_transmission_config_create(cpl_parameterlist *list)
Creates a setup structure for the relative transmission computation.
void giraffe_transmission_config_add(cpl_parameterlist *list)
Adds parameters for the transmission correction computation.
void giraffe_transmission_config_destroy(GiTransmissionConfig *config)
Destroys a transmission field setup structure.
cxint giraffe_transmission_attach(GiTable *fibers, const cxchar *filename)
Load relative fiber transmission data from a file and add it to a fiber table.

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