MUSE Pipeline Reference Manual  2.1.1
muse_lingain_z.h
1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* vim:set sw=2 sts=2 et cin: */
3 /*
4  * This file is part of the MUSE Instrument Pipeline
5  * Copyright (C) 2005-2015 European Southern Observatory
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  */
21 
22 /* This file was automatically generated */
23 
24 #ifndef MUSE_LINGAIN_Z_H
25 #define MUSE_LINGAIN_Z_H
26 
27 /*----------------------------------------------------------------------------*
28  * Includes *
29  *----------------------------------------------------------------------------*/
30 #include <muse.h>
31 #include <muse_instrument.h>
32 
33 /*----------------------------------------------------------------------------*
34  * Special variable types *
35  *----------------------------------------------------------------------------*/
36 
40 /*----------------------------------------------------------------------------*/
47 /*----------------------------------------------------------------------------*/
48 typedef struct muse_lingain_params_s {
50  int nifu;
51 
55  int ybox;
56 
60  int xgap;
61 
65  int xborder;
66 
70  int order;
71 
75  double toffset;
76 
80  double fluxtol;
81 
83  double sigma;
84 
86  double signalmin;
87 
89  double signalmax;
90 
92  double signalbin;
93 
95  double gainlimit;
96 
98  double gainsigma;
99 
101  double ctsmin;
102 
104  double ctsmax;
105 
107  double ctsbin;
108 
110  double linearmin;
111 
113  double linearmax;
114 
116  int merge;
117 
118  char __dummy__; /* quieten compiler warning about possibly empty struct */
120 
121 
124 /*----------------------------------------------------------------------------*
125  * Function prototypes *
126  *----------------------------------------------------------------------------*/
127 int muse_lingain_compute(muse_processing *, muse_lingain_params_t *);
128 
129 #endif /* MUSE_LINGAIN_Z_H */
struct muse_lingain_params_s muse_lingain_params_t
Structure to hold the parameters of the muse_lingain recipe.
int merge
Merge output products from different IFUs into a common file.
Structure to hold the parameters of the muse_lingain recipe.
double signalmin
Minimum signal value in log(ADU) used for the gain analysis and the non-linearity polynomial model...
double linearmin
Lower limit of desired linear range in log10(counts).
double sigma
Sigma value used for signal value clipping.
int nifu
IFU to handle. If set to 0, all IFUs are processed serially. If set to -1, all IFUs are processed in ...
double signalbin
Size of a signal bin in log10(ADU) used for the gain analysis and the non-linearity polynomial model...
double signalmax
Maximum signal value in log(ADU) used for the gain analysis and the non-linearity polynomial model...
double fluxtol
Tolerance value for the overall flux consistency check of a pair of flat fields. The value is the max...
int order
Order of the polynomial used to fit the non-linearity residuals.
double toffset
Exposure time offset in seconds to apply to linearity flat fields.
double gainsigma
Sigma value for gain value clipping.
double linearmax
Upper limit of desired linear range in log10(counts).
double ctsmin
Minimum signal value in log(counts) to consider for the non-linearity analysis.
double ctsbin
Size of a signal bin in log10(counts) used for the non-linearity analysis.
int xborder
Extra offset from the detector edge used for the selection of slices.
double ctsmax
Maximum signal value in log(counts) to consider for the non-linearity analysis.
int xgap
Extra offset from tracing edge.
double gainlimit
Minimum signal value [ADU] used for fitting the gain relation.
int ybox
Size of windows along the traces of the slices.