GIRAFFE Pipeline Reference Manual

gifiberutils.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 GIFIBERUTILS_H
21 #define GIFIBERUTILS_H
22 
23 #include <cxtypes.h>
24 
25 #include <cpl_macros.h>
26 #include <cpl_array.h>
27 #include <cpl_table.h>
28 #include <cpl_frame.h>
29 
30 #include <gitable.h>
31 
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
37 
38 #define GIOZPOZ_EXTENSION (1)
39 #define GIOZPOZ_MAGIC "OzPoz_table"
40 
41 #define GIFIBER_EXTENSION (2)
42 #define GIFIBER_MAGIC "FLAMES FIBRE Table"
43 
44 
45 /*
46  * Fiber table utilities
47  */
48 
49 cpl_table *giraffe_fiberlist_create(const cxchar *filename, cxint nspec,
50  const cxint *spectra);
51 
52 GiTable *giraffe_fiberlist_load(const cxchar *filename, cxint dataset,
53  const cxchar *tag);
54 
55 cxint giraffe_fiberlist_save(GiTable *, const cxchar *filename);
56 cxint giraffe_fiberlist_attach(cpl_frame *frame, GiTable *fibers);
57 
58 cxint giraffe_fiberlist_compare(const GiTable *fibers,
59  const GiTable *reference);
60 
61 cxint giraffe_fiberlist_associate(GiTable *fibers, const GiTable *reference);
62 
63 cxint giraffe_fiberlist_clear_index(GiTable* fibers);
64 const cxchar *giraffe_fiberlist_query_index(const cpl_table *fibers);
65 
66 cpl_array* giraffe_fiberlist_get_subslits(const cpl_table* fibers);
67 
68 cxint *giraffe_parse_spectrum_selection(const cxchar *selection,
69  cxint *nspec);
70 
71 cxint *giraffe_create_spectrum_selection(const cxchar *filename,
72  const GiTable *reference,
73  cxint *nspec);
74 
75 
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif /* GIFIBERUTILS_H */
cxint * giraffe_create_spectrum_selection(const cxchar *filename, const GiTable *reference, cxint *nspec)
Create a spectrum selection from a reference table.
cxint * giraffe_parse_spectrum_selection(const cxchar *selection, cxint *nspec)
Parses a spectrum selection string.
cpl_table * giraffe_fiberlist_create(const cxchar *filename, cxint nspec, const cxint *spectra)
Creates the fiber table.
Definition: gifiberutils.c:85
cxint giraffe_fiberlist_save(GiTable *, const cxchar *filename)
Save a fiber table to a file.
Definition: gifiberutils.c:768
cxint giraffe_fiberlist_compare(const GiTable *fibers, const GiTable *reference)
Compare two fiber lists.
Definition: gifiberutils.c:913
cxint giraffe_fiberlist_attach(cpl_frame *frame, GiTable *fibers)
Attach a fiber table to a frame.
Definition: gifiberutils.c:845
GiTable * giraffe_fiberlist_load(const cxchar *filename, cxint dataset, const cxchar *tag)
Load a fiber table from a file.
Definition: gifiberutils.c:715
const cxchar * giraffe_fiberlist_query_index(const cpl_table *fibers)
Query a fiber list for the name of the fiber reference index column.
cpl_array * giraffe_fiberlist_get_subslits(const cpl_table *fibers)
Get the list of subslit identifiers from a fiber setup.
cxint giraffe_fiberlist_associate(GiTable *fibers, const GiTable *reference)
Associate a fiberlist with a reference list.
Definition: gifiberutils.c:983
cxint giraffe_fiberlist_clear_index(GiTable *fibers)
Remove the reference index column from a fiber list.

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