IIINSTRUMENT Pipeline Reference Manual 4.4.12
naco_parameter.h
1/* $Id: naco_parameter.h,v 1.15 2011-11-18 09:05:51 llundin Exp $
2 *
3 * This file is part of the NACO 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: llundin $
23 * $Date: 2011-11-18 09:05:51 $
24 * $Revision: 1.15 $
25 * $Name: not supported by cvs2svn $
26 */
27
28#ifndef NACO_PARAMETER_H
29#define NACO_PARAMETER_H
30
31/*-----------------------------------------------------------------------------
32 Includes
33 -----------------------------------------------------------------------------*/
34
35#include <cpl.h>
36
37#include "naco_utils.h"
38
39/*-----------------------------------------------------------------------------
40 Defines
41 -----------------------------------------------------------------------------*/
42
43/* The available recipe parameters */
44/* None has the value 1, which makes the (mis)use of logical or detectable */
45#define NACO_PARAM_PLOT ((naco_parameter) 1 << 1)
46#define NACO_PARAM_STAR_R ((naco_parameter) 1 << 2)
47#define NACO_PARAM_BG_RINT ((naco_parameter) 1 << 3)
48#define NACO_PARAM_BG_REXT ((naco_parameter) 1 << 4)
49#define NACO_PARAM_REJBORD ((naco_parameter) 1 << 5)
50#define NACO_PARAM_HOT_LIM ((naco_parameter) 1 << 6)
51#define NACO_PARAM_COLD_LIM ((naco_parameter) 1 << 7)
52#define NACO_PARAM_DEV_LIM ((naco_parameter) 1 << 8)
53#define NACO_PARAM_NSAMPLES ((naco_parameter) 1 << 9)
54#define NACO_PARAM_HALFSIZE ((naco_parameter) 1 << 10)
55#define NACO_PARAM_FORCE ((naco_parameter) 1 << 11)
56#define NACO_PARAM_SLIT_W ((naco_parameter) 1 << 12)
57#define NACO_PARAM_BPMTHRES ((naco_parameter) 1 << 13)
58#define NACO_PARAM_PROPFIT ((naco_parameter) 1 << 14)
59#define NACO_PARAM_BPM ((naco_parameter) 1 << 15)
60#define NACO_PARAM_ERRORMAP ((naco_parameter) 1 << 16)
61#define NACO_PARAM_INTCEPT ((naco_parameter) 1 << 17)
62#define NACO_PARAM_RA ((naco_parameter) 1 << 18)
63#define NACO_PARAM_DEC ((naco_parameter) 1 << 19)
64#define NACO_PARAM_PIXSCALE ((naco_parameter) 1 << 20)
65#define NACO_PARAM_MAGNITD ((naco_parameter) 1 << 21)
66#define NACO_PARAM_SX ((naco_parameter) 1 << 22)
67#define NACO_PARAM_SY ((naco_parameter) 1 << 23)
68#define NACO_PARAM_CHK_IMG ((naco_parameter) 1 << 24)
69#define NACO_PARAM_SAVE ((naco_parameter) 1 << 25)
70#define NACO_PARAM_XTMIN ((naco_parameter) 1 << 26)
71#define NACO_PARAM_XTMAX ((naco_parameter) 1 << 27)
72#define NACO_PARAM_OFFSETS ((naco_parameter) 1 << 28)
73#define NACO_PARAM_OBJECTS ((naco_parameter) 1 << 29)
74#define NACO_PARAM_ODDEVEN ((naco_parameter) 1 << 30)
75#define NACO_PARAM_XCORR ((naco_parameter) 1 << 31)
76#define NACO_PARAM_UNION ((naco_parameter) 1 << 32)
77#define NACO_PARAM_REJ_HILO ((naco_parameter) 1 << 33)
78#define NACO_PARAM_COMBINE ((naco_parameter) 1 << 34)
79#define NACO_PARAM_SKYPLANE ((naco_parameter) 1 << 35)
80#define NACO_PARAM_CUBEMODE ((naco_parameter) 1 << 36)
81#define NACO_PARAM_LUCK_STR ((naco_parameter) 1 << 37)
82#define NACO_PARAM_SAVECUBE ((naco_parameter) 1 << 38)
83
84/*-----------------------------------------------------------------------------
85 Prototypes
86 -----------------------------------------------------------------------------*/
87
88typedef unsigned long long naco_parameter;
89
90cpl_error_code naco_parameter_set(cpl_parameterlist *, const char *,
91 naco_parameter);
92
93cpl_boolean naco_parameterlist_get_bool(const cpl_parameterlist *,
94 const char *,
95 naco_parameter);
96
97int naco_parameterlist_get_int(const cpl_parameterlist *,
98 const char *,
99 naco_parameter);
100
101double naco_parameterlist_get_double(const cpl_parameterlist *,
102 const char *,
103 naco_parameter);
104
105const char * naco_parameterlist_get_string(const cpl_parameterlist *,
106 const char *,
107 naco_parameter);
108
109#endif
double naco_parameterlist_get_double(const cpl_parameterlist *, const char *, naco_parameter)
Retrieve the value of a NACO parameter of type double.
int naco_parameterlist_get_int(const cpl_parameterlist *, const char *, naco_parameter)
Retrieve the value of a NACO integer parameter.
const char * naco_parameterlist_get_string(const cpl_parameterlist *, const char *, naco_parameter)
Retrieve the value of a NACO string parameter.
cpl_error_code naco_parameter_set(cpl_parameterlist *, const char *, naco_parameter)
Define the specified parameters.
cpl_boolean naco_parameterlist_get_bool(const cpl_parameterlist *, const char *, naco_parameter)
Retrieve the value of a NACO boolean parameter.