GIRAFFE Pipeline Reference Manual

gigrating.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 GIGRATING_H
21 #define GIGRATING_H
22 
23 #include <cxstring.h>
24 
25 #include <cpl_macros.h>
26 #include <cpl_msg.h>
27 
28 #include <giimage.h>
29 #include <gitable.h>
30 
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
36 
44 struct GiGrating {
45  cx_string *setup;
46  cx_string *name;
47  cx_string *filter;
48  cx_string *slit;
49  cxint order;
50  cxdouble wlen0;
51  cxdouble wlenmin;
52  cxdouble wlenmax;
53  cxdouble band;
54  cxint resol;
55  cxdouble space;
56  cxdouble theta;
57  cxdouble fcoll;
58  cxdouble gcam;
59  cxdouble sdx;
60  cxdouble sdy;
61  cxdouble sphi;
62 };
63 
64 typedef struct GiGrating GiGrating;
65 
67 GiGrating *giraffe_grating_create(const GiImage *spectra,
68  const GiTable *grating);
70 
71 void giraffe_grating_dump(const GiGrating *);
72 
73 cxint giraffe_grating_setup(GiTable *grating_table, GiImage *spectra,
74  GiGrating *grating_setup);
75 
76 
77 #ifdef __cplusplus
78 }
79 #endif
80 
81 #endif /* GIGRATING_H */
GiGrating * giraffe_grating_new(void)
Create a new GiGrating.
Definition: gigrating.c:186
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:474
void giraffe_grating_dump(const GiGrating *)
Dump the the information contained in a GiGrating to output.
Definition: gigrating.c:722
void giraffe_grating_delete(GiGrating *)
Destroys an GiGrating object.
Definition: gigrating.c:421
GiGrating * giraffe_grating_create(const GiImage *spectra, const GiTable *grating)
Create a GiGrating from a reference image.
Definition: gigrating.c:218
Structure to handle Grating Information.
Definition: gigrating.h:44
cxdouble wlenmax
Definition: gigrating.h:52
cxdouble sdy
Definition: gigrating.h:60
cx_string * name
Definition: gigrating.h:46
cx_string * setup
Definition: gigrating.h:45
cxdouble space
Definition: gigrating.h:55
cxdouble fcoll
Definition: gigrating.h:57
cxdouble wlen0
Definition: gigrating.h:50
cxdouble sdx
Definition: gigrating.h:59
cxint resol
Definition: gigrating.h:54
cxdouble gcam
Definition: gigrating.h:58
cx_string * slit
Definition: gigrating.h:48
cxdouble band
Definition: gigrating.h:53
cxdouble wlenmin
Definition: gigrating.h:51
cxdouble sphi
Definition: gigrating.h:61
cxint order
Definition: gigrating.h:49
cx_string * filter
Definition: gigrating.h:47
cxdouble theta
Definition: gigrating.h:56

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