GIRAFFE Pipeline Reference Manual

giextract.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 GIEXTRACT_H
29 #define GIEXTRACT_H
30 
31 #include <cpl_macros.h>
32 #include <cpl_parameterlist.h>
33 
34 #include <giimage.h>
35 #include <gitable.h>
36 #include <gilocalization.h>
37 #include <giextraction.h>
38 
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 
45 enum GiExtractMethod {
46  GIEXTRACT_SUM,
47  GIEXTRACT_HORNE,
48  GIEXTRACT_OPTIMAL
49 };
50 
51 typedef enum GiExtractMethod GiExtractMethod;
52 
53 
54 struct GiExtractConfig {
55  GiExtractMethod emethod;
56 
57  cxdouble ron;
58 
59  struct {
60  cxchar* model;
61  cxdouble sigma;
62  cxint iterations;
63  } psf;
64 
65  struct {
66  cxint ewidth;
67  cxint mingood;
68  } horne;
69 
70  struct {
71  cxint bkgorder;
72  cxdouble wfactor;
73  cxdouble fraction;
74  } optimal;
75 
76 };
77 
78 typedef struct GiExtractConfig GiExtractConfig;
79 
80 
81 /*
82  * Spectrum extraction
83  */
84 
85 cxint giraffe_extract_spectra(GiExtraction* result, GiImage* image,
86  GiTable* fibers, GiLocalization* sloc,
87  GiImage* bpixel, GiImage* slight,
88  GiExtractConfig* config);
89 
90 /*
91  * Convenience functions
92  */
93 
94 GiExtractConfig* giraffe_extract_config_create(cpl_parameterlist* list);
95 void giraffe_extract_config_destroy(GiExtractConfig* config);
96 
97 void giraffe_extract_config_add(cpl_parameterlist *list);
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif /* GIEXTRACT_H */
GiExtractConfig * giraffe_extract_config_create(cpl_parameterlist *list)
Creates a setup structure for the spectrum extraction.
Definition: giextract.c:3408
void giraffe_extract_config_add(cpl_parameterlist *list)
Adds parameters for the spectrum extraction.
Definition: giextract.c:3512
void giraffe_extract_config_destroy(GiExtractConfig *config)
Destroys a spectrum extraction setup structure.
Definition: giextract.c:3482
cxint giraffe_extract_spectra(GiExtraction *result, GiImage *image, GiTable *fibers, GiLocalization *sloc, GiImage *bpixel, GiImage *slight, GiExtractConfig *config)
Extracts the spectra from a preprocessed frame.
Definition: giextract.c:2483

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