VISIR Pipeline Reference Manual  4.1.0
visir_parameter.h
1 /* $Id: visir_parameter.h,v 1.12 2012-05-07 08:28:06 jtaylor Exp $
2  *
3  * This file is part of the VISIR Pipeline
4  * Copyright (C) 2002,2003 European Southern Observatory
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1307 USA
19  */
20 
21 /*
22  * $Author: jtaylor $
23  * $Date: 2012-05-07 08:28:06 $
24  * $Revision: 1.12 $
25  * $Name: not supported by cvs2svn $
26  */
27 
28 #ifndef VISIR_PARAMETER_H
29 #define VISIR_PARAMETER_H
30 
31 /*-----------------------------------------------------------------------------
32  Includes
33  -----------------------------------------------------------------------------*/
34 
35 #include <cpl.h>
36 
37 #include "visir_utils.h"
38 
39 /*-----------------------------------------------------------------------------
40  Defines
41  -----------------------------------------------------------------------------*/
42 
43 /* The available recipe parameters */
44 /* The value 1 is unused, which makes the (mis)use of logical or detectable */
45 #define VISIR_PARAM_NODPOS ((visir_parameter) 1 << 1)
46 #define VISIR_PARAM_AUTOBPM ((visir_parameter) 1 << 2)
47 #define VISIR_PARAM_GLITCH ((visir_parameter) 1 << 3)
48 #define VISIR_PARAM_PURGE ((visir_parameter) 1 << 4)
49 #define VISIR_PARAM_UNION ((visir_parameter) 1 << 5)
50 #define VISIR_PARAM_REJECT ((visir_parameter) 1 << 6)
51 #define VISIR_PARAM_PLOT ((visir_parameter) 1 << 7)
52 #define VISIR_PARAM_SLITSKEW ((visir_parameter) 1 << 8)
53 #define VISIR_PARAM_SPECSKEW ((visir_parameter) 1 << 9)
54 #define VISIR_PARAM_VERTARC ((visir_parameter) 1 << 10)
55 #define VISIR_PARAM_HORIARC ((visir_parameter) 1 << 11)
56 #define VISIR_PARAM_ORDEROFF ((visir_parameter) 1 << 12)
57 #define VISIR_PARAM_OFFSETS ((visir_parameter) 1 << 13)
58 #define VISIR_PARAM_OBJECTS ((visir_parameter) 1 << 14)
59 #define VISIR_PARAM_REFINE ((visir_parameter) 1 << 15)
60 #define VISIR_PARAM_XCORR ((visir_parameter) 1 << 16)
61 #define VISIR_PARAM_JYVAL ((visir_parameter) 1 << 17)
62 #define VISIR_PARAM_RADII ((visir_parameter) 1 << 18)
63 #define VISIR_PARAM_LOWLIM ((visir_parameter) 1 << 19)
64 #define VISIR_PARAM_HIGHLIM ((visir_parameter) 1 << 20)
65 #define VISIR_PARAM_FIXCOMBI ((visir_parameter) 1 << 21)
66 #define VISIR_PARAM_EMIS_TOL ((visir_parameter) 1 << 22)
67 #define VISIR_PARAM_ZERODIST ((visir_parameter) 1 << 23)
68 #define VISIR_PARAM_QEFF ((visir_parameter) 1 << 24)
69 #define VISIR_PARAM_REJBORD ((visir_parameter) 1 << 25)
70 #define VISIR_PARAM_HOT_LIM ((visir_parameter) 1 << 26)
71 #define VISIR_PARAM_COLD_LIM ((visir_parameter) 1 << 27)
72 #define VISIR_PARAM_DEV_LIM ((visir_parameter) 1 << 28)
73 #define VISIR_PARAM_NSAMPLES ((visir_parameter) 1 << 29)
74 #define VISIR_PARAM_HALFSIZE ((visir_parameter) 1 << 30)
75 #define VISIR_PARAM_COMBINE ((visir_parameter) 1 << 31)
76 #define VISIR_PARAM_STRIPNON ((visir_parameter) 1 << 32)
77 #define VISIR_PARAM_STRIPITE ((visir_parameter) 1 << 33)
78 #define VISIR_PARAM_STRIPMOR ((visir_parameter) 1 << 34)
79 #define VISIR_PARAM_REJLEFT ((visir_parameter) 1 << 35)
80 #define VISIR_PARAM_REJRIGHT ((visir_parameter) 1 << 36)
81 #define VISIR_PARAM_ECCMAX ((visir_parameter) 1 << 37)
82 #define VISIR_PARAM_BKG_CORRECT ((visir_parameter) 1 << 38)
83 
84 
85 /*-----------------------------------------------------------------------------
86  Prototypes
87  -----------------------------------------------------------------------------*/
88 
89 typedef unsigned long long visir_parameter;
90 
91 cpl_error_code visir_parameter_set(cpl_parameterlist *, const char *,
92  visir_parameter);
93 
94 cpl_boolean visir_parameterlist_get_bool(const cpl_parameterlist *,
95  const char *,
96  visir_parameter);
97 
98 int visir_parameterlist_get_int(const cpl_parameterlist *,
99  const char *,
100  visir_parameter);
101 
102 double visir_parameterlist_get_double(const cpl_parameterlist *,
103  const char *,
104  visir_parameter);
105 
106 const char * visir_parameterlist_get_string(const cpl_parameterlist *,
107  const char *,
108  visir_parameter);
109 #endif
double visir_parameterlist_get_double(const cpl_parameterlist *, const char *, visir_parameter)
Retrieve the value of a VISIR parameter of type double.
cpl_error_code visir_parameter_set(cpl_parameterlist *, const char *, visir_parameter)
Define the specified parameters.
int visir_parameterlist_get_int(const cpl_parameterlist *, const char *, visir_parameter)
Retrieve the value of a VISIR integer parameter.
cpl_boolean visir_parameterlist_get_bool(const cpl_parameterlist *, const char *, visir_parameter)
Retrieve the value of a VISIR boolean parameter.
const char * visir_parameterlist_get_string(const cpl_parameterlist *, const char *, visir_parameter)
Retrieve the value of a VISIR string parameter.