SINFONI Pipeline Reference Manual  2.6.0
sinfo_standard_star_config.c
1 /* $Id: sinfo_standard_star_config.c,v 1.7 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.7 $
24  * $Name: not supported by cvs2svn $
25  */
26 
27 /****************************************************************
28  * Standard_Star Frames Data Reduction Parameter Initialization *
29  ****************************************************************/
30 
31 #ifdef HAVE_CONFIG_H
32 # include <config.h>
33 #endif
34 
35 #include <string.h>
36 #include "sinfo_standard_star_config.h"
49 void
50 sinfo_standard_star_config_add(cpl_parameterlist *list)
51 {
52 
53  cpl_parameter *p;
54 
55  if (!list) {
56  return;
57  }
58 
59  /*
60  --------------------------------------------------------------------------
61  In/Out
62  --------------------------------------------------------------------------
63  */
64 
65  /* switch to generate the extracted spectrum */
66  /*
67  p = cpl_parameter_new_value("sinfoni.std_star.qc_info",
68  CPL_TYPE_BOOL,
69  "Switch to activate extra QC information "
70  "together with the spectrum",
71  "sinfoni.std_star",
72  FALSE);
73 
74  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,"std_star-qc_info");
75  cpl_parameterlist_append(list, p);
76  */
77 
78  p = cpl_parameter_new_value("sinfoni.std_star.switch", CPL_TYPE_BOOL,
79  "Switch to activate spectrum extraction",
80  "sinfoni.std_star", TRUE);
81 
82  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-switch");
83  cpl_parameterlist_append(list, p);
84 
85  /* the fraction [0...1] of rejected low intensity pixels when taking
86  the average of columns */
87  p = cpl_parameter_new_value("sinfoni.std_star.low_rejection",
88  CPL_TYPE_DOUBLE, "lower rejection", "sinfoni.std_star",
89  0.1);
90 
91  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-lo_rej");
92  cpl_parameterlist_append(list, p);
93 
94  /* the fraction [0...1] of rejected high intensity pixels when taking
95  the average of columns */
96  p = cpl_parameter_new_value("sinfoni.std_star.high_rejection",
97  CPL_TYPE_DOUBLE, "high rejection", "sinfoni.std_star", 0.1);
98 
99  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-hi_rej");
100  cpl_parameterlist_append(list, p);
101 
102  /* factor applied to the found fwhms of a 2D-Gaussian fit, defines the radius
103  of the aperture inside which the spectral extraction is carried out.
104  */
105  p = cpl_parameter_new_value("sinfoni.std_star.fwhm_factor", CPL_TYPE_DOUBLE,
106  "Factor to find 2D-Gauss FWHM. "
107  "The extraction box is: "
108  "halfbox_x=halfbox_y="
109  "fwhm_factor*(fwhm_x+fwhm_y)*0.5",
110  "sinfoni.std_star", 5.0);
111 
112  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-fwhm_fct");
113  cpl_parameterlist_append(list, p);
114 
115  /* indicator if the intensity conversion factor should be determined or not
116  */
117 
118  p = cpl_parameter_new_value("sinfoni.std_star.conversion_index",
119  CPL_TYPE_BOOL, "Intensity Conversion Index: ",
120  "sinfoni.std_star", TRUE);
121 
122  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-conv_ind");
123  cpl_parameterlist_append(list, p);
124 
125  p = cpl_parameter_new_value("sinfoni.std_star.compute_eff", CPL_TYPE_BOOL,
126  "Compute efficiency: TRUE/FALSE", "sinfoni.std_star", TRUE);
127 
128  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI, "std_star-compute_eff");
129  cpl_parameterlist_append(list, p);
130 
131 }