MUSE Pipeline Reference Manual  0.18.1
muse_scipost_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-2013 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_SCIPOST_Z_H
25 #define MUSE_SCIPOST_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_scipost_params_s {
50  int resample;
52  const char *resample_s;
53 
55  double dx;
56 
58  double dy;
59 
61  double dlambda;
62 
64  int crtype;
66  const char *crtype_s;
67 
69  double crsigma;
70 
72  double rc;
73 
75  double pixfrac;
76 
78  int ld;
79 
81  int format;
83  const char *format_s;
84 
86  int weight;
88  const char *weight_s;
89 
91  const char * filter;
92 
94  int skymethod;
96  const char *skymethod_s;
97 
99  double lambdamin;
100 
102  double lambdamax;
103 
105  double lambdaref;
106 
108  int darcheck;
110  const char *darcheck_s;
111 
114 
117 
120 
123 
126 
129 
132 
134  int stacked;
135 
136  char __dummy__; /* quieten compiler warning about possibly empty struct */
138 
139 #define MUSE_SCIPOST_PARAM_RESAMPLE_NEAREST 1
140 #define MUSE_SCIPOST_PARAM_RESAMPLE_LINEAR 2
141 #define MUSE_SCIPOST_PARAM_RESAMPLE_QUADRATIC 3
142 #define MUSE_SCIPOST_PARAM_RESAMPLE_RENKA 4
143 #define MUSE_SCIPOST_PARAM_RESAMPLE_DRIZZLE 5
144 #define MUSE_SCIPOST_PARAM_RESAMPLE_LANCZOS 6
145 #define MUSE_SCIPOST_PARAM_RESAMPLE_INVALID_VALUE -1
146 #define MUSE_SCIPOST_PARAM_CRTYPE_IRAF 1
147 #define MUSE_SCIPOST_PARAM_CRTYPE_MEAN 2
148 #define MUSE_SCIPOST_PARAM_CRTYPE_MEDIAN 3
149 #define MUSE_SCIPOST_PARAM_CRTYPE_INVALID_VALUE -1
150 #define MUSE_SCIPOST_PARAM_FORMAT_CUBE 1
151 #define MUSE_SCIPOST_PARAM_FORMAT_EURO3D 2
152 #define MUSE_SCIPOST_PARAM_FORMAT_XCUBE 3
153 #define MUSE_SCIPOST_PARAM_FORMAT_XEURO3D 4
154 #define MUSE_SCIPOST_PARAM_FORMAT_INVALID_VALUE -1
155 #define MUSE_SCIPOST_PARAM_WEIGHT_EXPTIME 1
156 #define MUSE_SCIPOST_PARAM_WEIGHT_FWHM 2
157 #define MUSE_SCIPOST_PARAM_WEIGHT_INVALID_VALUE -1
158 #define MUSE_SCIPOST_PARAM_SKYMETHOD_NONE 1
159 #define MUSE_SCIPOST_PARAM_SKYMETHOD_SUBTRACT_MODEL 2
160 #define MUSE_SCIPOST_PARAM_SKYMETHOD_MODEL 3
161 #define MUSE_SCIPOST_PARAM_SKYMETHOD_ROW_BY_ROW 4
162 #define MUSE_SCIPOST_PARAM_SKYMETHOD_INVALID_VALUE -1
163 #define MUSE_SCIPOST_PARAM_DARCHECK_NONE 1
164 #define MUSE_SCIPOST_PARAM_DARCHECK_CHECK 2
165 #define MUSE_SCIPOST_PARAM_DARCHECK_CORRECT 3
166 #define MUSE_SCIPOST_PARAM_DARCHECK_INVALID_VALUE -1
167 
170 /*----------------------------------------------------------------------------*
171  * Function prototypes *
172  *----------------------------------------------------------------------------*/
173 int muse_scipost_compute(muse_processing *, muse_scipost_params_t *);
174 
175 #endif /* MUSE_SCIPOST_Z_H */
double lambdamin
Cut off the data below this wavelength after loading the pixel table(s).
int save_combined
If true, save the fully reduced and combined pixel table for the full set of exposures. The difference to save_positioned is that here all pixel tables are combined into one, with an added "weight" column. This is useful, if only the final resampling step is to be done separately.
const char * skymethod_s
The method used to subtract the sky background. "model" should work in all cases, it uses a global sk...
const char * darcheck_s
Carry out a check of the theoretical DAR correction using source centroiding. If "correct" it will al...
struct muse_scipost_params_s muse_scipost_params_t
Structure to hold the parameters of the muse_scipost recipe.
int ld
Number of adjacent pixels to take into account during resampling in all three directions (loop distan...
const char * filter
The filter name(s) to be used for the output field-of-view image. Each name has to correspond to an E...
const char * weight_s
Type of weighting scheme to use when combining multiple exposures. (as string)
double dy
Vertical step size for resampling (in arcsec or pixel). The following defaults are taken when this va...
double pixfrac
Pixel down-scaling factor for the "drizzle" resampling method.
double lambdaref
Reference wavelength used for correction of differential atmospheric refraction. The R-band (peak wav...
double rc
Critical radius for the "renka" resampling method.
double skymodel_fraction
Fraction of the image to be considered as sky. If an input sky mask is provided, the fraction is appl...
const char * crtype_s
Type of statistics used for detection of cosmic rays during final resampling. "iraf" uses the varianc...
int darcheck
Carry out a check of the theoretical DAR correction using source centroiding. If "correct" it will al...
double skymodel_sampling
Spectral sampling of the sky spectrum [Angstrom].
int astrometry
If false, skip any astrometric calibration, even if one was passed in the input set of files...
double skymodel_csampling
Spectral sampling of the continuum spectrum [Angstrom].
int weight
Type of weighting scheme to use when combining multiple exposures.
const char * format_s
Type of output file format, "Cube" is a standard FITS cube with NAXIS=3 and multiple extensions (for ...
double lambdamax
Cut off the data above this wavelength after loading the pixel table(s).
double dx
Horizontal step size for resampling (in arcsec or pixel). The following defaults are taken when this ...
int skymethod
The method used to subtract the sky background. "model" should work in all cases, it uses a global sk...
Structure to hold the parameters of the muse_scipost recipe.
double crsigma
Sigma rejection factor to use for cosmic ray rejection during final resampling. A zero or negative va...
int resample
The resampling technique to use for the final output cube.
int save_individual
If true, save fully reduced pixel table for each individual exposure as output product.
int save_positioned
If true, save fully reduced and positioned pixel table for each individual exposure as output product...
double dlambda
Wavelength step size (in Angstrom). Natural instrument sampling is used, if this is 0...
int format
Type of output file format, "Cube" is a standard FITS cube with NAXIS=3 and multiple extensions (for ...
int stacked
If true, write an additional output file in form of a 2D stacked image (x direction is pseudo-spatial...
const char * resample_s
The resampling technique to use for the final output cube. (as string)
int crtype
Type of statistics used for detection of cosmic rays during final resampling. "iraf" uses the varianc...