standstar_cfg.h

00001 
00002 /*---------------------------------------------------------------------------
00003    
00004    File name    :   standstar_cfg.h
00005    Author   :   Juergen Schreiber
00006    Created on   :   March 2002
00007    Description  :   standstar_ini definitions + handling prototypes
00008 
00009  ---------------------------------------------------------------------------*/
00010 
00011 
00012 #ifndef _STANDSTAR_CFG_H_
00013 #define _STANDSTAR_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   standard star data reduction blackboard container
00038 
00039   This structure holds all information related to the standard star data reduction
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 standstar_config {
00047 /*-------General---------*/
00048         char inFile[FILENAMESZ]  ;     /* input file of reduced jittered data cubes of a standard star */
00049         char ** inFrameList ; /* input list of cubes */
00050         int     nframes ;         /* number of input frames */
00051         char outName[FILENAMESZ] ;     /* output name of resulting extracted spectrum stored as fits image */
00052 
00053 /*------ spectral extraction and determination of conversion factor ------*/
00054         /* the fraction [0...1] of rejected low intensity pixels when taking the average of jittered spectra */
00055         float lo_reject ;
00056         /* the fraction [0...1] of rejected high intensity pixels when taking the average of jittered spectra */
00057         float hi_reject ;
00058         /* lower left edge coordinates of fitting box for 2d Gaussian fit */
00059         int llx ;
00060         int lly ;
00061         /* size of a box inside which the 2D-Gaussian fit is carried through */
00062         int halfbox_x ;
00063         int halfbox_y ;
00064     
00065         /* factor applied to the found fwhms of a 2D-Gaussian
00066            fit, defines the radius of the aperture from which the
00067            spectral extraction is carried out (default: 0.7). */
00068         float fwhm_factor ;
00069         /* (readnoise^2 + dark current) needed to determine the noise variance 
00070            of the background. Must be given in counts/sec. */
00071         float backvariance ;
00072         /* estimated sky counts/sec */
00073         float sky ;
00074         /* gain: counts per electron */
00075         float gain ;
00076         /* indicator if an intensity conversion factor should be determined or not */
00077         int convInd ;      
00078         /* name of the ASCII file that stores the intensity conversion factor */
00079         char convName[FILENAMESZ] ;      
00080         /* magnitude of the standard star */
00081         float mag ;      
00082 } standstar_config ;
00083 /*</python>*/
00084 
00085 
00086 
00087 /*---------------------------------------------------------------------------
00088                             Function prototypes
00089  ---------------------------------------------------------------------------*/
00090 
00091 
00092 /*---------------------------------------------------------------------------
00093    Function :   standstar_cfg_create()
00094    In       :   void
00095    Out      :   pointer to allocated base standstar_config structure
00096    Job      :   allocate memory for a standstar_config struct
00097    Notice   :   only the main (base) structure is allocated
00098  ---------------------------------------------------------------------------*/
00099 
00100 standstar_config * standstar_cfg_create(void);
00101 
00102 
00103 /*---------------------------------------------------------------------------
00104    Function :   standstar_cfg_destroy()
00105    In       :   standstar_config to deallocate
00106    Out      :   void
00107    Job      :   deallocate all memory associated with a standstar_config data structure
00108    Notice   :   
00109  ---------------------------------------------------------------------------*/
00110 /*<python>*/
00111 void standstar_cfg_destroy(standstar_config * cc);
00112 /*</python>*/
00113 
00114 #endif

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