MUSE Pipeline Reference Manual  2.1.1
muse_twilight_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_TWILIGHT_Z_H
25 #define MUSE_TWILIGHT_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_twilight_params_s {
50  const char * overscan;
51 
53  const char * ovscreject;
54 
56  double ovscsigma;
57 
60 
62  int combine;
64  const char *combine_s;
65 
67  int nlow;
68 
70  int nhigh;
71 
73  int nkeep;
74 
76  double lsigma;
77 
79  double hsigma;
80 
82  int scale;
83 
85  int resample;
87  const char *resample_s;
88 
90  int crtype;
92  const char *crtype_s;
93 
95  double crsigma;
96 
98  double lambdamin;
99 
101  double lambdamax;
102 
104  double dlambda;
105 
107  int xorder;
108 
110  int yorder;
111 
114 
118  const char *vignsmooth_s;
119 
121  int vignxpar;
122 
124  int vignypar;
125 
126  char __dummy__; /* quieten compiler warning about possibly empty struct */
128 
129 #define MUSE_TWILIGHT_PARAM_COMBINE_AVERAGE 1
130 #define MUSE_TWILIGHT_PARAM_COMBINE_MEDIAN 2
131 #define MUSE_TWILIGHT_PARAM_COMBINE_MINMAX 3
132 #define MUSE_TWILIGHT_PARAM_COMBINE_SIGCLIP 4
133 #define MUSE_TWILIGHT_PARAM_COMBINE_INVALID_VALUE -1
134 #define MUSE_TWILIGHT_PARAM_RESAMPLE_NEAREST 1
135 #define MUSE_TWILIGHT_PARAM_RESAMPLE_LINEAR 2
136 #define MUSE_TWILIGHT_PARAM_RESAMPLE_QUADRATIC 3
137 #define MUSE_TWILIGHT_PARAM_RESAMPLE_RENKA 4
138 #define MUSE_TWILIGHT_PARAM_RESAMPLE_DRIZZLE 5
139 #define MUSE_TWILIGHT_PARAM_RESAMPLE_LANCZOS 6
140 #define MUSE_TWILIGHT_PARAM_RESAMPLE_INVALID_VALUE -1
141 #define MUSE_TWILIGHT_PARAM_CRTYPE_IRAF 1
142 #define MUSE_TWILIGHT_PARAM_CRTYPE_MEAN 2
143 #define MUSE_TWILIGHT_PARAM_CRTYPE_MEDIAN 3
144 #define MUSE_TWILIGHT_PARAM_CRTYPE_INVALID_VALUE -1
145 #define MUSE_TWILIGHT_PARAM_VIGNSMOOTH_POLYFIT 1
146 #define MUSE_TWILIGHT_PARAM_VIGNSMOOTH_GAUSSIAN 2
147 #define MUSE_TWILIGHT_PARAM_VIGNSMOOTH_MEDIAN 3
148 #define MUSE_TWILIGHT_PARAM_VIGNSMOOTH_INVALID_VALUE -1
149 
152 /*----------------------------------------------------------------------------*
153  * Function prototypes *
154  *----------------------------------------------------------------------------*/
155 int muse_twilight_compute(muse_processing *, muse_twilight_params_t *);
156 
157 #endif /* MUSE_TWILIGHT_Z_H */
double crsigma
Sigma rejection factor to use for cosmic ray rejection during final resampling. A zero or negative va...
const char * vignsmooth_s
Type of smoothing to use for the vignetted region given by the VIGNETTING_MASK; gaussian uses (vignxp...
int scale
Scale the individual images to a common exposure time before combining them.
double lsigma
Low sigma for pixel rejection with sigclip.
int nkeep
Number of pixels to keep with minmax.
struct muse_twilight_params_s muse_twilight_params_t
Structure to hold the parameters of the muse_twilight recipe.
double ovscsigma
If the deviation of mean overscan levels between a raw input image and the reference image is higher ...
const char * crtype_s
Type of statistics used for detection of cosmic rays during final resampling. "iraf" uses the varianc...
const char * overscan
If this is "none", stop when detecting discrepant overscan levels (see ovscsigma), for "offset" it assumes that the mean overscan level represents the real offset in the bias levels of the exposures involved, and adjusts the data accordingly; for "vpoly", a polynomial is fit to the vertical overscan and subtracted from the whole quadrant.
int nhigh
Number of maximum pixels to reject with minmax.
int vignxpar
Parameter used by the vignetting smoothing: x order for polyfit (default, recommended 4)...
double vignmaskedges
Pixels on edges stronger than this fraction in the normalized image are excluded from the fit to the ...
int vignypar
Parameter used by the vignetting smoothing: y order for polyfit (default, recommended 4)...
const char * combine_s
Type of combination to use (as string)
Structure to hold the parameters of the muse_twilight recipe.
double dlambda
Sampling for twilight reconstruction, this should result in planes of equal wavelength coverage...
int vignsmooth
Type of smoothing to use for the vignetted region given by the VIGNETTING_MASK; gaussian uses (vignxp...
int resample
The resampling technique to use for the final output cube.
double lambdamin
Minimum wavelength for twilight reconstruction.
int combine
Type of combination to use.
double hsigma
High sigma for pixel rejection with sigclip.
int yorder
Polynomial order to use in y direction to fit the full field of view.
int xorder
Polynomial order to use in x direction to fit the full field of view.
const char * ovscreject
This influences how values are rejected when computing overscan statistics. Either no rejection at al...
int ovscignore
The number of pixels of the overscan adjacent to the data section of the CCD that are ignored when co...
double lambdamax
Maximum wavelength for twilight reconstruction.
int nlow
Number of minimum pixels to reject with minmax.
int crtype
Type of statistics used for detection of cosmic rays during final resampling. "iraf" uses the varianc...
const char * resample_s
The resampling technique to use for the final output cube. (as string)