SINFONI Pipeline Reference Manual  2.5.2
sinfo_bp_noise_config.c
1 /* $Id: sinfo_bp_noise_config.c,v 1.5 2008-01-17 07:54:04 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: 2008-01-17 07:54:04 $
23  * $Revision: 1.5 $
24  * $Name: not supported by cvs2svn $
25  */
26 
27 #ifdef HAVE_CONFIG_H
28 # include <config.h>
29 #endif
30 /****************************************************************
31  * Bad pixel search (noise method) *
32  ****************************************************************/
33 #include "sinfo_bp_noise_config.h"
52 /* Bad pixel parameters */
53 
54 void
55 sinfo_bp_noise_config_add(cpl_parameterlist *list)
56 {
57 
58  cpl_parameter *p;
59 
60  if (!list) {
61  return;
62  }
63 
64 
65 
66  /* factor of noise within which the pixels are used to fit a straight line
67  to the column intensity */
68  p = cpl_parameter_new_value("sinfoni.bp_noise.thresh_sigma_factor",
69  CPL_TYPE_DOUBLE,
70  "Threshold Sigma Factor: "
71  "If the mean noise exceeds this "
72  "threshold times the clean standard deviation "
73  "of the clean mean the corresponding pixels "
74  "are declared as bad ",
75  "sinfoni.bp_noise",
76  10.);
77 
78  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,
79  "bp_noise-thresh_sigma_fct");
80  cpl_parameterlist_append(list, p);
81 
82  /* float
83  threshold used in the clean mean percentage of rejection used to reject
84  low and high frame */
85  /* percentage of extreme pixel value to reject when calculating the mean
86  and stdev */
87  p = cpl_parameter_new_range("sinfoni.bp_noise.low_rejection",
88  CPL_TYPE_DOUBLE,
89  "low_rejection: "
90  "percentage of rejected low intensity "
91  "pixels before averaging",
92  "sinfoni.bp_noise",
93  10.,0.,100.);
94 
95  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,"bp_noise-lo_rej");
96  cpl_parameterlist_append(list, p);
97 
98  /* float
99  threshold used in the clean mean percentage of rejection used to reject
100  low and high frame */
101  /* percentage of extreme pixel value to reject when calculating the mean
102  and stdev */
103  p = cpl_parameter_new_range("sinfoni.bp_noise.high_rejection",
104  CPL_TYPE_DOUBLE,
105  "high_rejection: "
106  "percentage of rejected high intensity "
107  "pixels before averaging",
108  "sinfoni.bp_noise",
109  10.,0.,100.);
110 
111  cpl_parameter_set_alias(p, CPL_PARAMETER_MODE_CLI,"bp_noise-hi_rej");
112  cpl_parameterlist_append(list, p);
113 
114  return;
115 
116 }