File: args.h

package info (click to toggle)
gnuastro 0.24-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 44,360 kB
  • sloc: ansic: 185,444; sh: 15,785; makefile: 1,303; cpp: 9
file content (230 lines) | stat: -rw-r--r-- 5,280 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*********************************************************************
Match - A program to match catalogs and WCS warps
Match is part of GNU Astronomy Utilities (Gnuastro) package.

Original author:
     Mohammad Akhlaghi <mohammad@akhlaghi.org>
Contributing author(s):
Copyright (C) 2017-2025 Free Software Foundation, Inc.

Gnuastro is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.

Gnuastro is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with Gnuastro. If not, see <http://www.gnu.org/licenses/>.
**********************************************************************/
#ifndef ARGS_H
#define ARGS_H






/* Array of acceptable options. */
struct argp_option program_options[] =
  {
    /* Input file parameters. */
    {
      "hdu2",
      UI_KEY_HDU2,
      "STR/INT",
      0,
      "Extension name or number of second input.",
      GAL_OPTIONS_GROUP_INPUT,
      &p->hdu2,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET
    },





    /* Outputs. */
    {
      "logasoutput",
      UI_KEY_LOGASOUTPUT,
      0,
      0,
      "No rearranging of inputs, output is log file",
      GAL_OPTIONS_GROUP_OUTPUT,
      &p->logasoutput,
      GAL_OPTIONS_NO_ARG_TYPE,
      GAL_OPTIONS_RANGE_0_OR_1,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET
    },
    {
      "notmatched",
      UI_KEY_NOTMATCHED,
      0,
      0,
      "Output is rows that don't match.",
      GAL_OPTIONS_GROUP_OUTPUT,
      &p->notmatched,
      GAL_OPTIONS_NO_ARG_TYPE,
      GAL_OPTIONS_RANGE_0_OR_1,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET
    },
    {
      "outcols",
      UI_KEY_OUTCOLS,
      "STR",
      0,
      "Out cols in CSV, 'a': 1st, 'b': 2nd input.",
      GAL_OPTIONS_GROUP_OUTPUT,
      &p->outcols,
      GAL_TYPE_STRLL,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      gal_options_parse_csv_strings_append
    },
    {
      "arrange",
      UI_KEY_ARRANGE,
      "STR",
      0,
      "inner, outer, outer-within-aperture or full.",
      GAL_OPTIONS_GROUP_OUTPUT,
      &p->arrange,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      ui_parse_match_type,
    },




    /* Catalog matching. */
    {
      0, 0, 0, 0,
      "Catalog matching",
      UI_GROUP_CATALOGMATCH
    },
    {
      "ccol1",
      UI_KEY_CCOL1,
      "STR[,STR]",
      0,
      "Column name/number of first catalog.",
      UI_GROUP_CATALOGMATCH,
      &p->ccol1,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      gal_options_parse_csv_strings
    },
    {
      "ccol2",
      UI_KEY_CCOL2,
      "STR[,STR]",
      0,
      "Column name/number of second catalog.",
      UI_GROUP_CATALOGMATCH,
      &p->ccol2,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      gal_options_parse_csv_strings
    },
    {
      "coord",
      UI_KEY_COORD,
      "FLT[,FLT]",
      0,
      "Manually input coordiantes.",
      UI_GROUP_CATALOGMATCH,
      &p->coord,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      gal_options_parse_csv_float64
    },
    {
      "aperture",
      UI_KEY_APERTURE,
      "FLT[,...]",
      0,
      "Acceptable aperture for matching.",
      UI_GROUP_CATALOGMATCH,
      &p->aperture,
      GAL_TYPE_FLOAT64,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
      gal_options_parse_csv_float64
    },
    {
      "kdtree",
      UI_KEY_KDTREE,
      "STR",
      0,
      "build, internal, disable, CUSTOM-FITS-FILE.",
      UI_GROUP_CATALOGMATCH,
      &p->kdtree,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_MANDATORY,
      GAL_OPTIONS_NOT_SET,
    },
    {
      "kdtreehdu",
      UI_KEY_KDTREEHDU,
      "STR",
      0,
      "HDU of k-d tree when --kdtree=FILE.fits.",
      UI_GROUP_CATALOGMATCH,
      &p->kdtreehdu,
      GAL_TYPE_STRING,
      GAL_OPTIONS_RANGE_ANY,
      GAL_OPTIONS_NOT_MANDATORY,
      GAL_OPTIONS_NOT_SET,
    },



    {0}
  };





/* Define the child argp structure
   -------------------------------

   NOTE: these parts can be left untouched.*/
struct argp
gal_options_common_child = {gal_commonopts_options,
                            gal_options_common_argp_parse,
                            NULL, NULL, NULL, NULL, NULL};

/* Use the child argp structure in list of children (only one for now). */
struct argp_child
children[]=
{
  {&gal_options_common_child, 0, NULL, 0},
  {0, 0, 0, 0}
};

/* Set all the necessary argp parameters. */
struct argp
thisargp = {program_options, parse_opt, args_doc, doc, children, NULL, NULL};
#endif