GIRAFFE Pipeline Reference Manual

gifibers.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 GIFIBERS_H
21 #define GIFIBERS_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 #include <cpl_frame.h>
27 #include <cpl_parameterlist.h>
28 
29 #include <gitable.h>
30 
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
37 struct GiFibersConfig {
38  cxint nspec;
39  cxchar *spectra;
40 };
41 
42 typedef struct GiFibersConfig GiFibersConfig;
43 
44 
45 /*
46  * Fiber selection
47  */
48 
49 GiTable *giraffe_fibers_select(const cpl_frame *frame,
50  const GiTable *reference,
51  GiFibersConfig *config);
52 
53 GiTable *giraffe_fibers_setup(const cpl_frame *frame,
54  const cpl_frame *reference);
55 
56 
57 /*
58  * Convenience functions
59  */
60 
61 GiFibersConfig *giraffe_fibers_config_create(cpl_parameterlist *list);
62 void giraffe_fibers_config_destroy(GiFibersConfig *config);
63 
64 
65 void giraffe_fibers_config_add(cpl_parameterlist *list);
66 
67 
68 #ifdef __cplusplus
69 }
70 #endif
71 
72 #endif /* GIFIBERS_H */
GiTable * giraffe_fibers_select(const cpl_frame *frame, const GiTable *reference, GiFibersConfig *config)
Selects the spectra to process.
Definition: gifibers.c:72
void giraffe_fibers_config_destroy(GiFibersConfig *config)
Destroys a fibers setup structure.
Definition: gifibers.c:363
void giraffe_fibers_config_add(cpl_parameterlist *list)
Adds parameters for the spectrum selection.
Definition: gifibers.c:391
GiFibersConfig * giraffe_fibers_config_create(cpl_parameterlist *list)
Creates a setup structure for the fiber selection.
Definition: gifibers.c:315
GiTable * giraffe_fibers_setup(const cpl_frame *frame, const cpl_frame *reference)
Setup a fiber list.
Definition: gifibers.c:218

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