MUSE Pipeline Reference Manual  2.1.1
muse_dark_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_DARK_Z_H
25 #define MUSE_DARK_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_dark_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 nlow;
71 
73  int nhigh;
74 
76  int nkeep;
77 
79  double lsigma;
80 
82  double hsigma;
83 
85  int scale;
86 
88  double normalize;
89 
91  double hotsigma;
92 
94  int merge;
95 
96  char __dummy__; /* quieten compiler warning about possibly empty struct */
98 
99 #define MUSE_DARK_PARAM_COMBINE_AVERAGE 1
100 #define MUSE_DARK_PARAM_COMBINE_MEDIAN 2
101 #define MUSE_DARK_PARAM_COMBINE_MINMAX 3
102 #define MUSE_DARK_PARAM_COMBINE_SIGCLIP 4
103 #define MUSE_DARK_PARAM_COMBINE_INVALID_VALUE -1
104 
107 /*----------------------------------------------------------------------------*
108  * Function prototypes *
109  *----------------------------------------------------------------------------*/
110 int muse_dark_compute(muse_processing *, muse_dark_params_t *);
111 
112 #endif /* MUSE_DARK_Z_H */
int ovscignore
The number of pixels of the overscan adjacent to the data section of the CCD that are ignored when co...
Definition: muse_dark_z.h:62
const char * combine_s
Type of image combination to use. (as string)
Definition: muse_dark_z.h:67
int scale
Scale the individual images to a common exposure time before combining them.
Definition: muse_dark_z.h:85
const char * ovscreject
This influences how values are rejected when computing overscan statistics. Either no rejection at al...
Definition: muse_dark_z.h:56
double hotsigma
Sigma level, in terms of median deviation above the median dark level, above which a pixel is detecte...
Definition: muse_dark_z.h:91
int nkeep
Number of pixels to keep with minmax.
Definition: muse_dark_z.h:76
Structure to hold the parameters of the muse_dark recipe.
Definition: muse_dark_z.h:48
double ovscsigma
If the deviation of mean overscan levels between a raw input image and the reference image is higher ...
Definition: muse_dark_z.h:59
int merge
Merge output products from different IFUs into a common file.
Definition: muse_dark_z.h:94
double lsigma
Low sigma for pixel rejection with sigclip.
Definition: muse_dark_z.h:79
int combine
Type of image combination to use.
Definition: muse_dark_z.h:65
struct muse_dark_params_s muse_dark_params_t
Structure to hold the parameters of the muse_dark recipe.
int nifu
IFU to handle. If set to 0, all IFUs are processed serially. If set to -1, all IFUs are processed in ...
Definition: muse_dark_z.h:50
double normalize
Normalize the master dark to this exposure time (in seconds). To disable normalization, set this to a negative value.
Definition: muse_dark_z.h:88
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.
Definition: muse_dark_z.h:53
int nlow
Number of minimum pixels to reject with minmax.
Definition: muse_dark_z.h:70
int nhigh
Number of maximum pixels to reject with minmax.
Definition: muse_dark_z.h:73
double hsigma
High sigma for pixel rejection with sigclip.
Definition: muse_dark_z.h:82