FORS Pipeline Reference Manual  5.0.9
fors_setting.h
1 /* $Id: fors_setting.h,v 1.16 2010-09-14 07:49:30 cizzo Exp $
2  *
3  * This file is part of the FORS Library
4  * Copyright (C) 2002-2010 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: cizzo $
23  * $Date: 2010-09-14 07:49:30 $
24  * $Revision: 1.16 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef FORS_SETTING_H
29 #define FORS_SETTING_H
30 
31 #include <cpl.h>
32 
33 /* deprecate this, only kept for now for
34  * create_phot.c, fors_data.c, test_simulate.c */
35  enum filter
36  {
37  FILTER_U,
38  FILTER_B,
39  FILTER_G,
40  FILTER_V,
41  FILTER_R,
42  FILTER_I,
43  FILTER_Z
44  };
45  #define FORS_NUM_FILTER 7
46 
47 typedef struct _fors_setting {
48 
49  int binx,
50  biny;
51 
52  int prescan_x,
53  prescan_y; /* prescan width in
54  software (binned) pixels */
55 
56 /* not used for now
57  int ccd_x, ccd_y; / * CCD size in
58  physical pixels,
59  not FITS pixels
60  */
61  char filterband;
62 
63  const char *filter_name; /* NULL if no filter */
64 
65  double exposure_time; /* seconds */
66 
67  double average_gain; /* average ESO gain of all read-out ports */
68 
69  double ron; /* average read-out-noise (ADU) of all read-out ports */
70 
71  double pixel_scale; /* arcsec/pixel, positive */
72 
73  const char *read_clock;
74  const char *chip_id;
75 
76  const char *instrument; /* e.g. fors1 */
77  const char *version; /* e.g. fors1/4.0.0 */
78 
79 } fors_setting;
80 
81 CPL_BEGIN_DECLS
82 
84 fors_setting_new(const cpl_frame *raw);
85 
86 void
87 fors_setting_verify(const fors_setting *ref_setting, const cpl_frame *frame,
88  fors_setting **setting);
89 
91 
92 CPL_END_DECLS
93 #endif
CPL_BEGIN_DECLS fors_setting * fors_setting_new(const cpl_frame *raw)
Create setting from FITS header.
Definition: fors_setting.c:64
void fors_setting_verify(const fors_setting *ref_setting, const cpl_frame *frame, fors_setting **setting)
Verify that instrument settings are compatible.
Definition: fors_setting.c:401
void fors_setting_delete(fors_setting **s)
Deallocate and and set pointer to NULL.
Definition: fors_setting.c:498