SINFONI Pipeline Reference Manual  2.5.2
sinfo_detlin_cfg.h
1 /*
2  * This file is part of the ESO SINFONI Pipeline
3  * Copyright (C) 2004,2005 European Southern Observatory
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA
18  */
19 /*---------------------------------------------------------------------------
20 
21  File name : sinfo_detlin_cfg.h
22  Author : Juergen Schreiber
23  Created on : April 2002
24  Description : sinfo_detlin_ini definitions + handling prototypes
25  ---------------------------------------------------------------------------*/
26 #ifndef SINFO_DETLIN_CFG_H
27 #define SINFO_DETLIN_CFG_H
28 /*---------------------------------------------------------------------------
29  Includes
30  ---------------------------------------------------------------------------*/
31 #include <stdlib.h>
32 #include "sinfo_globals.h"
33 #include <cpl.h>
34 /*---------------------------------------------------------------------------
35  Defines
36  ---------------------------------------------------------------------------*/
37 /*---------------------------------------------------------------------------
38  New types
39  ---------------------------------------------------------------------------*/
40 /*
41  bad pixels search blackboard container
42 
43  This structure holds all information related to the bad pixels search
44  routine. It is used as a container for the flux of ancillary data,
45  computed values, and algorithm status. Pixel flux is separated from
46  the blackboard.
47  */
48 
49 typedef struct detlin_config {
50 /*-------General---------*/
51  char inFile[FILE_NAME_SZ] ; /* file name of the file containing
52  the list of all input frames */
53  char outName[FILE_NAME_SZ] ; /* output name of resulting bad pixel
54  mask (fits file)*/
55  char ** framelist ; /* list of frames */
56  int nframes ; /* number of frames in frame list */
57 
58 /*------ Response------*/
59  /* order of the fit polynomial */
60  int order ;
61  /* factor to the standard deviation of the zero and slope polynomial
62  coefficient. if the deviation exceeds the resulting value the
63  corresponding pixel is declared as bad */
64  double threshSigmaFactor ;
65  /*if a non-linear coefficient exceeds this value the corresponding
66  pixel is declared as bad*/
67  double nonlinearThresh ;
68  /* percentage of rejected low intensity pixels before determining
69  image statistics (mean and standard deviation)*/
70  float loReject ;
71  /* percentage of rejected high intensity pixels before determining
72  image statistics (mean and standard deviation) */
73  float hiReject ;
74  /*name of the data cube storing the found polynomial coefficients*/
75  char coeffsCubeName[FILE_NAME_SZ] ;
76 } detlin_config ;
77 
78 /*---------------------------------------------------------------------------
79  Function prototypes
80  ---------------------------------------------------------------------------*/
88 detlin_config *
89 sinfo_detlin_cfg_create(void);
90 
97 void
98 sinfo_detlin_cfg_destroy(detlin_config * sc);
99 
100 #endif