detlin_cfg.h

00001 
00002 /*---------------------------------------------------------------------------
00003    
00004    File name    :   detlin_cfg.h
00005    Author       :   Juergen Schreiber
00006    Created on   :   April 2002
00007    Description  :   detlin_ini definitions + handling prototypes
00008 
00009  ---------------------------------------------------------------------------*/
00010 
00011 
00012 #ifndef _DETLIN_CFG_H_
00013 #define _DETLIN_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   bad pixels search blackboard container
00038 
00039   This structure holds all information related to the bad pixels search
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 detlin_config {
00047 /*-------General---------*/
00048         char inFile[FILENAMESZ] ; /* file name of the file containing the list of all input frames */
00049         char outName[FILENAMESZ] ; /* output name of resulting bad pixel mask (fits file)*/
00050         char ** framelist ; /* list of frames */
00051         int     nframes ; /* number of frames in frame list */
00052 
00053 /*------ Response------*/
00054         /* order of the fit polynomial */
00055         int order ;      
00056         /* factor to the standard deviation of the zero and slope polynomial 
00057            coefficient. if the deviation exceeds the resulting value the 
00058            corresponding pixel is declared as bad */ 
00059         double threshSigmaFactor ;      
00060         /*if a non-linear coefficient exceeds this value the corresponding 
00061           pixel is declared as bad*/
00062         double nonlinearThresh ;      
00063         /* percentage of rejected low intensity pixels before determining
00064            image statistics (mean and standard deviation)*/
00065         float loReject ;
00066         /* percentage of rejected high intensity pixels before determining
00067            image statistics (mean and standard deviation) */
00068         float hiReject ;
00069         /*name of the data cube storing the found polynomial coefficients*/
00070         char coeffsCubeName[FILENAMESZ] ;
00071 } detlin_config ;
00072 /*</python>*/
00073 
00074 
00075 /*---------------------------------------------------------------------------
00076                             Function prototypes
00077  ---------------------------------------------------------------------------*/
00078 
00079 
00080 /*---------------------------------------------------------------------------
00081    Function :   detlin_cfg_create()
00082    In       :   void
00083    Out      :   pointer to allocated base detlin_cfg structure
00084    Job      :   allocate memory for a detlin_cfg struct
00085    Notice   :   only the main (base) structure is allocated
00086  ---------------------------------------------------------------------------*/
00087 
00088 detlin_config * detlin_cfg_create(void);
00089 
00090 
00091 /*---------------------------------------------------------------------------
00092    Function :   detlin_cfg_destroy()
00093    In       :   detlin_config to deallocate
00094    Out      :   void
00095    Job      :   deallocate all memory associated with a detlin_config data structure
00096    Notice   :   
00097  ---------------------------------------------------------------------------*/
00098 /*<python>*/
00099 void detlin_cfg_destroy(detlin_config * sc);
00100 /*</python>*/
00101 
00102 #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