GIRAFFE Pipeline Reference Manual

gilocalize.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 GILOCALIZE_H
29 #define GILOCALIZE_H
30 
31 #include <cpl_parameterlist.h>
32 
33 #include <giimage.h>
34 #include <gitable.h>
35 #include <gilocalization.h>
36 
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41 
42 
43 struct GiLocalizeConfig {
44  cxbool full;
45  cxint start;
46  cxint retries;
47  cxint binsize;
48  cxdouble ewidth;
49  cxint ywidth;
50  cxbool centroid;
51  cxbool normalize;
52  cxint threshold;
53  cxdouble noise;
54  cxdouble ron;
55  cxint yorder;
56  cxint worder;
57  cxdouble sigma;
58  cxint iterations;
59  cxdouble fraction;
60 };
61 
62 typedef struct GiLocalizeConfig GiLocalizeConfig;
63 
64 
65 /*
66  * Spectrum localization
67  */
68 
69 cxint giraffe_localize_spectra(GiLocalization* result, GiImage* image,
70  GiTable* fibers, GiLocalization* master,
71  GiImage* badpixels, GiLocalizeConfig* config);
72 
73 
74 /*
75  * Convenience functions
76  */
77 
78 GiLocalizeConfig* giraffe_localize_config_create(cpl_parameterlist* list);
79 void giraffe_localize_config_destroy(GiLocalizeConfig* config);
80 
81 void giraffe_localize_config_add(cpl_parameterlist* list);
82 
83 
84 #ifdef __cplusplus
85 }
86 #endif
87 
88 #endif /* GILOCALIZE_H */
GiLocalizeConfig * giraffe_localize_config_create(cpl_parameterlist *list)
Creates a setup structure for the spectrum localization.
Definition: gilocalize.c:3196
void giraffe_localize_config_destroy(GiLocalizeConfig *config)
Destroys a spectrum localization setup structure.
Definition: gilocalize.c:3303
cxint giraffe_localize_spectra(GiLocalization *result, GiImage *image, GiTable *fibers, GiLocalization *master, GiImage *badpixels, GiLocalizeConfig *config)
Finds the location of spectra in a Giraffe observation.
Definition: gilocalize.c:2568
void giraffe_localize_config_add(cpl_parameterlist *list)
Adds parameters for the spectrum localization.
Definition: gilocalize.c:3327

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