GIRAFFE Pipeline Reference Manual

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

This file is part of the GIRAFFE Pipeline Reference Manual 2.16.14.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Wed Nov 20 2024 21:40:14 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2004