SINFONI Pipeline Reference Manual  2.6.0
sinfo_skycor_config.c
1 /* $Id: sinfo_skycor_config.c,v 1.17 2012-03-03 10:18:26 amodigli Exp $
2  *
3  * This file is part of the CPL (Common Pipeline Library)
4  * Copyright (C) 2002 European Southern Observatory
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19  */
20 /*
21  * $Author: amodigli $
22  * $Date: 2012-03-03 10:18:26 $
23  * $Revision: 1.17 $
24  * $Name: not supported by cvs2svn $
25  */
26 
27 
28 #ifdef HAVE_CONFIG_H
29 # include <config.h>
30 #endif
31 
32 #include "sinfo_skycor_config.h"
33 #include "sinfo_skycor.h"
34 
54 /* General data reduction parameters */
55 
56 void
57 sinfo_skycor_config_add(cpl_parameterlist *list)
58 {
59 
60  cpl_parameter *p;
61 
62  if (!list) {
63  return;
64  }
65 
66 
67  /* Fill the parameters list */
68  /* --stropt */
69 
70  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.mask_ws",
71  CPL_TYPE_DOUBLE,
72  "Starting wavelength for object-sky cross correlation",
73  "sinfoni.sinfo_utl_skycor",
74  SINFO_MASK_WAVE_MIN) ;
75  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-mask_ws") ;
76  cpl_parameterlist_append(list, p) ;
77 
78 
79  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.mask_we",
80  CPL_TYPE_DOUBLE,
81  "End wavelength for object-sky cross correlation",
82  "sinfoni.sinfo_utl_skycor",
83  SINFO_MASK_WAVE_MAX) ;
84  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-mask_we") ;
85  cpl_parameterlist_append(list, p) ;
86 
87 
88  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.min_frac",
89  CPL_TYPE_DOUBLE,
90  "Threshold value for fraction of spatial pixels to be sky",
91  "sinfoni.sinfo_utl_skycor",
92  SINFO_MIN_FRAC) ;
93  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-min_frac") ;
94  cpl_parameterlist_append(list, p) ;
95 
96 
97 
98  p = cpl_parameter_new_range(
99  "sinfoni.sinfo_utl_skycor.sky_bkg_filter_width",
100  CPL_TYPE_INT,
101  "Width of sky-thermal background pre filter "
102  "(to remove emission lines before fitting a "
103  "Black Body).",
104  "sinfoni.sinfo_utl_skycor",
105  SINFO_SKY_BKG_FILTER_WIDTH,2,25) ;
106  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,
107  "skycor-sky_bkg_filter_width") ;
108  cpl_parameterlist_append(list, p) ;
109 
110  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.line_half_width",
111  CPL_TYPE_DOUBLE,
112  "Threshold value for full width in pixels "
113  "of unresolved emission line. Lines with FWHM "
114  "smaller than this value are not considered "
115  "in the object-sky cross correlation and in "
116  "computation of the optimal sky lines scaling "
117  "factor",
118  "sinfoni.sinfo_utl_skycor",
119  SINFO_LINE_HALF_WIDTH) ;
120  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-line_hw") ;
121  cpl_parameterlist_append(list, p) ;
122 
123  p = cpl_parameter_new_enum("sinfoni.sinfo_utl_skycor.scale_method",
124  CPL_TYPE_INT,
125  "Optimal sky lines scaling factor computation "
126  "method: amoeba fit (0), "
127  "maximum likelihood (1) ",
128  "sinfoni.sinfo_utl_skycor",
129  1,2,0,1) ;
130  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,
131  "skycor-scale_method") ;
132  cpl_parameterlist_append(list, p) ;
133 
134 
135  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.rot_cor",
136  CPL_TYPE_BOOL,
137  "Computes scaling factor correction due to "
138  "rotational levels transitions",
139  "sinfoni.sinfo_utl_skycor",
140  FALSE) ;
141  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-rot_cor") ;
142  cpl_parameterlist_append(list, p) ;
143 
144 
145 
146  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.fit_obj_noise",
147  CPL_TYPE_BOOL,
148  "Do Gaussian fit of object noise",
149  "sinfoni.sinfo_utl_skycor",
150  FALSE) ;
151  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-fit_obj_noise");
152  cpl_parameterlist_append(list, p) ;
153 
154 
155  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.niter",
156  CPL_TYPE_INT,
157  "Number of iterations of background "
158  "fit",
159  "sinfoni.sinfo_utl_skycor",
160  10) ;
161  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-niter") ;
162  cpl_parameterlist_append(list, p) ;
163 
164  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.pshift",
165  CPL_TYPE_DOUBLE,
166  "Sky spectrum shift towar object",
167  "sinfoni.sinfo_utl_skycor",
168  0.) ;
169  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-pshift") ;
170  cpl_parameterlist_append(list, p) ;
171 
172  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.llx",
173  CPL_TYPE_INT,
174  "Lower left X defining object "
175  "spectrum location",
176  "sinfoni.sinfo_utl_skycor",
177  1) ;
178  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-llx") ;
179  cpl_parameterlist_append(list, p) ;
180 
181  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.lly",
182  CPL_TYPE_INT,
183  "Lower left Y defining object "
184  "spectrum location",
185  "sinfoni.sinfo_utl_skycor",
186  1) ;
187  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-lly") ;
188  cpl_parameterlist_append(list, p) ;
189 
190 
191 
192  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.urx",
193  CPL_TYPE_INT,
194  "Upper right X defining object "
195  "spectrum location",
196  "sinfoni.sinfo_utl_skycor",
197  64) ;
198  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-urx") ;
199  cpl_parameterlist_append(list, p) ;
200 
201 
202  p = cpl_parameter_new_value("sinfoni.sinfo_utl_skycor.ury",
203  CPL_TYPE_INT,
204  "Upper right Y defining object "
205  "spectrum location",
206  "sinfoni.sinfo_utl_skycor",
207  64) ;
208  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "skycor-ury") ;
209  cpl_parameterlist_append(list, p) ;
210 
211 
212 
213  p = cpl_parameter_new_value(
214 
215  "sinfoni.sinfo_utl_skycor.sub_thr_bkg_from_obj",
216  CPL_TYPE_BOOL,
217  "Subtract thermal background contribute from "
218  "object spectra. Set it to TRUE if "
219  "stack-sub_raw_sky is set to FALSE",
220  "sinfoni.sinfo_utl_skycor",
221  FALSE) ;
222 
223  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,
224  "skycor-sub_thr_bkg_from_obj") ;
225  cpl_parameterlist_append(list, p) ;
226 
227 
228 }