MUSE Pipeline Reference Manual  2.1.1
muse_wavecal_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_WAVECAL_Z_H
25 #define MUSE_WAVECAL_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_wavecal_params_s {
50  int nifu;
51 
53  const char * overscan;
54 
56  const char * ovscreject;
57 
59  double ovscsigma;
60 
63 
65  int combine;
67  const char *combine_s;
68 
70  int lampwise;
71 
73  double sigma;
74 
76  double dres;
77 
79  double tolerance;
80 
82  int xorder;
83 
85  int yorder;
86 
88  double linesigma;
89 
91  int residuals;
92 
94  double fitsigma;
95 
99  const char *fitweighting_s;
100 
102  int resample;
103 
105  int wavemap;
106 
108  int merge;
109 
110  char __dummy__; /* quieten compiler warning about possibly empty struct */
112 
113 #define MUSE_WAVECAL_PARAM_COMBINE_AVERAGE 1
114 #define MUSE_WAVECAL_PARAM_COMBINE_MEDIAN 2
115 #define MUSE_WAVECAL_PARAM_COMBINE_MINMAX 3
116 #define MUSE_WAVECAL_PARAM_COMBINE_SIGCLIP 4
117 #define MUSE_WAVECAL_PARAM_COMBINE_INVALID_VALUE -1
118 #define MUSE_WAVECAL_PARAM_FITWEIGHTING_UNIFORM 1
119 #define MUSE_WAVECAL_PARAM_FITWEIGHTING_CERR 2
120 #define MUSE_WAVECAL_PARAM_FITWEIGHTING_SCATTER 3
121 #define MUSE_WAVECAL_PARAM_FITWEIGHTING_CERRSCATTER 4
122 #define MUSE_WAVECAL_PARAM_FITWEIGHTING_INVALID_VALUE -1
123 
126 /*----------------------------------------------------------------------------*
127  * Function prototypes *
128  *----------------------------------------------------------------------------*/
129 int muse_wavecal_compute(muse_processing *, muse_wavecal_params_t *);
130 
131 #endif /* MUSE_WAVECAL_Z_H */
double fitsigma
Sigma level for iterative rejection of deviant datapoints during the final polynomial wavelength solu...
double linesigma
Sigma level for iterative rejection of deviant fits for each arc line within each slice...
const char * ovscreject
This influences how values are rejected when computing overscan statistics. Either no rejection at al...
double ovscsigma
If the deviation of mean overscan levels between a raw input image and the reference image is higher ...
int ovscignore
The number of pixels of the overscan adjacent to the data section of the CCD that are ignored when co...
double dres
The allowed range of resolutions for pattern matching (of detected arc lines to line list) in fractio...
int nifu
IFU to handle. If set to 0, all IFUs are processed serially. If set to -1, all IFUs are processed in ...
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 wavemap
Create a wavelength map of the input images.
int lampwise
Identify and measure the arc emission lines on images separately for each lamp setup.
int residuals
Create a table containing residuals of the fits to the data of all arc lines. This is useful to asses...
int resample
Resample the input arc images onto 2D images for a visual check using tracing and wavelength calibrat...
int yorder
Order of the polynomial used to fit the dispersion relation.
int fitweighting
Type of weighting to use in the final polynomial wavelength solution fit, using centroiding error est...
const char * combine_s
Type of lampwise image combination to use. (as string)
int combine
Type of lampwise image combination to use.
Structure to hold the parameters of the muse_wavecal recipe.
double tolerance
Tolerance for pattern matching (of detected arc lines to line list)
const char * fitweighting_s
Type of weighting to use in the final polynomial wavelength solution fit, using centroiding error est...
double sigma
Sigma level used to detect arc emission lines above the median background level in the S/N image of t...
int merge
Merge output products from different IFUs into a common file.
struct muse_wavecal_params_s muse_wavecal_params_t
Structure to hold the parameters of the muse_wavecal recipe.
int xorder
Order of the polynomial for the horizontal curvature within each slice.