GIRAFFE Pipeline Reference Manual

gitransmission.h
1 /* $Id$
2  *
3  * This file is part of the GIRAFFE Pipeline
4  * Copyright (C) 2002-2006 European Southern Observatory
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
21 /*
22  * $Author$
23  * $Date$
24  * $Revision$
25  * $Name$
26  */
27 
28 #ifndef GITRANSMISSION_H
29 #define GITRANSMISSION_H
30 
31 #include <cxtypes.h>
32 
33 #include <cpl_macros.h>
34 
35 #include <giimage.h>
36 #include <gitable.h>
37 #include <gilocalization.h>
38 #include <giextraction.h>
39 
40 
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44 
45 
46  struct GiTransmissionConfig {
47  cxbool transmission;
48  };
49 
50  typedef struct GiTransmissionConfig GiTransmissionConfig;
51 
52 
53  cxint
54  giraffe_transmission_compute(GiExtraction* extraction, GiTable* fibers,
55  GiLocalization* localization,
56  GiTable* wcalcoeff, GiTable* grating,
57  GiTable* slitgeometry);
58 
59  cxint
60  giraffe_transmission_setup(GiTable* fibers, GiTable* reference);
61 
62  cxint
63  giraffe_transmission_apply(GiExtraction* spectra, GiTable* fibers);
64 
65  cxint
66  giraffe_transmission_attach(GiTable* fibers, const cxchar* filename);
67 
68 
69  /*
70  * Convenience functions
71  */
72 
73  GiTransmissionConfig*
74  giraffe_transmission_config_create(cpl_parameterlist* list);
75 
76  void
77  giraffe_transmission_config_destroy(GiTransmissionConfig* config);
78 
79  void
80  giraffe_transmission_config_add(cpl_parameterlist* list);
81 
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 #endif /* GITRANSMISSION_H */
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.
GiTransmissionConfig * giraffe_transmission_config_create(cpl_parameterlist *list)
Creates a setup structure for the relative transmission computation.
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.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Mar 11 2015 13:19:42 by doxygen 1.8.9.1 written by Dimitri van Heesch, © 1997-2004