GIRAFFE Pipeline Reference Manual

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

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