GIRAFFE Pipeline Reference Manual

gigrating.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 GIGRATING_H
29 #define GIGRATING_H
30 
31 #include <cxstring.h>
32 
33 #include <cpl_macros.h>
34 #include <cpl_msg.h>
35 
36 #include <giimage.h>
37 #include <gitable.h>
38 
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 
52 struct GiGrating {
53  cx_string *setup;
54  cx_string *name;
55  cx_string *filter;
56  cx_string *slit;
57  cxint order;
58  cxdouble wlen0;
59  cxdouble wlenmin;
60  cxdouble wlenmax;
61  cxdouble band;
62  cxint resol;
63  cxdouble space;
64  cxdouble theta;
65  cxdouble fcoll;
66  cxdouble gcam;
67  cxdouble sdx;
68  cxdouble sdy;
69  cxdouble sphi;
70 };
71 
72 typedef struct GiGrating GiGrating;
73 
75 GiGrating *giraffe_grating_create(const GiImage *spectra,
76  const GiTable *grating);
78 
79 void giraffe_grating_dump(const GiGrating *);
80 
81 cxint giraffe_grating_setup(GiTable *grating_table, GiImage *spectra,
82  GiGrating *grating_setup);
83 
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif /* GIGRATING_H */
cxdouble wlenmin
Definition: gigrating.h:59
cxint giraffe_grating_setup(GiTable *grating_table, GiImage *spectra, GiGrating *grating_setup)
Retrieves grating information and returns it in a GiGrating structure.
Definition: gigrating.c:482
cxdouble sphi
Definition: gigrating.h:69
GiGrating * giraffe_grating_create(const GiImage *spectra, const GiTable *grating)
Create a GiGrating from a reference image.
Definition: gigrating.c:226
cxdouble band
Definition: gigrating.h:61
GiGrating * giraffe_grating_new(void)
Create a new GiGrating.
Definition: gigrating.c:194
cxdouble theta
Definition: gigrating.h:64
cxint order
Definition: gigrating.h:57
cxdouble gcam
Definition: gigrating.h:66
cxint resol
Definition: gigrating.h:62
void giraffe_grating_dump(const GiGrating *)
Dump the the information contained in a GiGrating to output.
Definition: gigrating.c:730
cx_string * name
Definition: gigrating.h:54
cx_string * filter
Definition: gigrating.h:55
cxdouble wlenmax
Definition: gigrating.h:60
cxdouble sdx
Definition: gigrating.h:67
Structure to handle Grating Information.
Definition: gigrating.h:52
cxdouble wlen0
Definition: gigrating.h:58
void giraffe_grating_delete(GiGrating *)
Destroys an GiGrating object.
Definition: gigrating.c:429
cx_string * setup
Definition: gigrating.h:53
cx_string * slit
Definition: gigrating.h:56
cxdouble fcoll
Definition: gigrating.h:65
cxdouble space
Definition: gigrating.h:63
cxdouble sdy
Definition: gigrating.h:68

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