dark_cfg.h

00001 
00002 /*---------------------------------------------------------------------------
00003    
00004    File name    :   dark_cfg.h
00005    Author   :   Juergen Schreiber
00006    Created on   :   February 2002
00007    Description  :   dark_cfg.c definitions + handling prototypes
00008 
00009  ---------------------------------------------------------------------------*/
00010 
00011 
00012 #ifndef _DARK_CFG_H_
00013 #define _DARK_CFG_H_
00014 
00015 /*---------------------------------------------------------------------------
00016                                 Includes
00017  ---------------------------------------------------------------------------*/
00018 
00019 /*
00020 #include <stdio.h>
00021 */
00022 #include <stdlib.h>
00023 #include "static_sz.h"
00024 
00025 
00026 /*---------------------------------------------------------------------------
00027                                 Defines
00028  ---------------------------------------------------------------------------*/
00029 
00030 
00031 /*---------------------------------------------------------------------------
00032                                 New types
00033  ---------------------------------------------------------------------------*/
00034 
00035 
00036 /*
00037   master dark frame generation blackboard container
00038 
00039   This structure holds all information related to the master dark frame generation
00040   routine. It is used as a container for the flux of ancillary data,
00041   computed values, and algorithm status. Pixel flux is separated from
00042   the blackboard.
00043   */
00044 
00045 /*<python>*/
00046 typedef struct dark_config {
00047 /*-------General---------*/
00048         char inFile[FILENAMESZ] ;       /* file name of frame list */
00049         char ** inFrameList ; /* input averaged, bad pixel corrected, off subtracted, \
00050                                 flatfielded, spectral tilt corrected list of frames */
00051         int nframes ;        /* number of frames in the list */
00052         char outName[FILENAMESZ] ;     /* output name of resulting fits data cube */
00053 
00054 /*------ CleanMean ------*/
00055         /* the fraction [0...1] of rejected low intensity pixels when taking the average of columns */
00056         float lo_reject ;
00057         /* the fraction [0...1] of rejected high intensity pixels when taking the average of columns */
00058         float hi_reject ;
00059 /*------ QCLOG ------*/
00060         /* RON */
00061         
00062   int qc_ron_xmin;
00063   int qc_ron_xmax;
00064   int qc_ron_ymin;
00065   int qc_ron_ymax;
00066   int qc_ron_hsize;
00067   int qc_ron_nsamp;
00068   /* FPN */
00069   int qc_fpn_xmin;
00070   int qc_fpn_xmax;
00071   int qc_fpn_ymin;
00072   int qc_fpn_ymax;
00073   int qc_fpn_hsize;
00074   int qc_fpn_nsamp;
00075 
00076 } dark_config ;
00077 /*</python>*/
00078 
00079 
00080 
00081 /*---------------------------------------------------------------------------
00082                             Function prototypes
00083  ---------------------------------------------------------------------------*/
00084 
00085 
00086 /*---------------------------------------------------------------------------
00087    Function :   dark_cfg_create()
00088    In       :   void
00089    Out      :   pointer to allocated base dark_cfg structure
00090    Job      :   allocate memory for a dark_config struct
00091    Notice   :   only the main (base) structure is allocated
00092  ---------------------------------------------------------------------------*/
00093 
00094 dark_config * dark_cfg_create(void);
00095 
00096 
00097 /*---------------------------------------------------------------------------
00098    Function :   dark_cfg_destroy()
00099    In       :   dark_config to deallocate
00100    Out      :   void
00101    Job      :   deallocate all memory associated with a dark_config data structure
00102    Notice   :   
00103  ---------------------------------------------------------------------------*/
00104 /*<python>*/
00105 void dark_cfg_destroy(dark_config * cc);
00106 /*</python>*/
00107 
00108 #endif

Generated on Wed Oct 26 13:08:52 2005 for SINFONI Pipeline Reference Manual by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001