fors_setting.h

00001 /* $Id: fors_setting.h,v 1.16 2010/09/14 07:49:30 cizzo Exp $
00002  *
00003  * This file is part of the FORS Library
00004  * Copyright (C) 2002-2010 European Southern Observatory
00005  *
00006  * This program is free software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License as published by
00008  * the Free Software Foundation; either version 2 of the License, or
00009  * (at your option) any later version.
00010  *
00011  * This program is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00014  * GNU General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU General Public License
00017  * along with this program; if not, write to the Free Software
00018  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
00019  */
00020 
00021 /*
00022  * $Author: cizzo $
00023  * $Date: 2010/09/14 07:49:30 $
00024  * $Revision: 1.16 $
00025  * $Name: fors-4_8_6 $
00026  */
00027 
00028 #ifndef FORS_SETTING_H
00029 #define FORS_SETTING_H
00030 
00031 #include <cpl.h>
00032 
00033 /* deprecate this, only kept for now for
00034  * create_phot.c, fors_data.c, test_simulate.c */
00035     enum filter
00036     {
00037         FILTER_U, 
00038         FILTER_B, 
00039         FILTER_G,
00040         FILTER_V, 
00041         FILTER_R, 
00042         FILTER_I, 
00043         FILTER_Z
00044     };
00045     #define FORS_NUM_FILTER 7
00046 
00047 typedef struct _fors_setting {
00048 
00049     int         binx,
00050                 biny;
00051 
00052     int         prescan_x,
00053                 prescan_y;   /* prescan width in 
00054                    software (binned) pixels */
00055     
00056 /* not used for now
00057    int ccd_x, ccd_y;  / * CCD size in
00058               physical pixels,
00059               not FITS pixels 
00060                */
00061     char        filterband;
00062 
00063     const char  *filter_name; /* NULL if no filter */
00064 
00065     double      exposure_time;  /* seconds */
00066 
00067     double      average_gain;  /* average ESO gain of all read-out ports */
00068 
00069     double      ron;    /* average read-out-noise (ADU) of all read-out ports */
00070 
00071     double      pixel_scale;  /*  arcsec/pixel, positive */
00072 
00073     const char  *read_clock;
00074     const char  *chip_id;
00075 
00076     const char  *instrument;  /* e.g. fors1 */
00077     const char  *version;     /* e.g. fors1/4.0.0 */
00078     
00079 } fors_setting;
00080 
00081 fors_setting *
00082 fors_setting_new(const cpl_frame *raw);
00083 
00084 void
00085 fors_setting_verify(const fors_setting *ref_setting, const cpl_frame *frame,
00086             fors_setting **setting);
00087 
00088 void fors_setting_delete(fors_setting **s);
00089 
00090 #endif

Generated on Fri Mar 4 09:46:01 2011 for FORS Pipeline Reference Manual by  doxygen 1.4.7