File: ui.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 (146 lines) | stat: -rw-r--r-- 3,538 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
/*********************************************************************
Statistics - Statistical analysis on input dataset.
Statistics is part of GNU Astronomy Utilities (Gnuastro) package.

Original author:
     Mohammad Akhlaghi <mohammad@akhlaghi.org>
Contributing author(s):
Copyright (C) 2015-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 UI_H
#define UI_H

/* For common options groups. */
#include <gnuastro-internal/options.h>





/* Option groups particular to this program. */
enum program_args_groups
{
  UI_GROUP_SINGLE_VALUE = GAL_OPTIONS_GROUP_AFTER_COMMON,
  UI_GROUP_PARTICULAR_STAT,
  UI_GROUP_SKY,
  UI_GROUP_HIST_CFP,
  UI_GROUP_FIT,
};





/* Available letters for short options:

   b e j r v w x z
   B G J L W X Y
*/
enum option_keys_enum
{
  /* With short-option version. */
  UI_KEY_COLUMN        = 'c',
  UI_KEY_GREATEREQUAL  = 'g',
  UI_KEY_LESSTHAN      = 'l',
  UI_KEY_QRANGE        = 'Q',
  UI_KEY_MEAN          = 'm',
  UI_KEY_STD           = 'd',
  UI_KEY_MEDIAN        = 'E',
  UI_KEY_MODE          = 'O',
  UI_KEY_QUANTILE      = 'u',
  UI_KEY_ASCIIHIST     = 'A',
  UI_KEY_HISTOGRAM     = 'H',
  UI_KEY_CUMULATIVE    = 'C',
  UI_KEY_SIGMACLIP     = 's',
  UI_KEY_NORMALIZE     = 'n',
  UI_KEY_ONTILE        = 't',
  UI_KEY_INTERPOLATE   = 'i',
  UI_KEY_SKY           = 'y',
  UI_KEY_KERNEL        = 'k',
  UI_KEY_CONTOUR       = 'R',
  UI_KEY_FIT           = 'f',
  UI_KEY_FITMAXPOWER   = 'p',
  UI_KEY_OUTLIERNUMNGB = 'a',

  /* Only with long version (start with a value 1000, the rest will be set
     automatically). */
  UI_KEY_NUMBER       = 1000,
  UI_KEY_MINIMUM,
  UI_KEY_MAXIMUM,
  UI_KEY_SUM,
  UI_KEY_MAD,
  UI_KEY_MADCLIP,
  UI_KEY_MODEQUANT,
  UI_KEY_MODESYM,
  UI_KEY_MODESYMVALUE,
  UI_KEY_QUANTFUNC,
  UI_KEY_QUANTOFMEAN,
  UI_KEY_ASCIICFP,
  UI_KEY_HISTOGRAM2D,
  UI_KEY_MIRROR,
  UI_KEY_NUMBINS,
  UI_KEY_NUMBINS2,
  UI_KEY_NUMASCIIBINS,
  UI_KEY_ASCIIHEIGHT,
  UI_KEY_LOWERBIN,
  UI_KEY_MANUALBINRANGE,
  UI_KEY_ONEBINSTART,
  UI_KEY_MAXBINONE,
  UI_KEY_KHDU,
  UI_KEY_MIRRORDIST,
  UI_KEY_MEANMEDQDIFF,
  UI_KEY_OUTLIERSIGMA,
  UI_KEY_OUTLIERSCLIP,
  UI_KEY_SMOOTHWIDTH,
  UI_KEY_CHECKSKY,
  UI_KEY_CHECKSKYNOINTERP,
  UI_KEY_IGNOREBLANKINTILES,
  UI_KEY_SCLIPPARAMS,
  UI_KEY_MCLIPPARAMS,
  UI_KEY_SIGCLIPNUMBER,
  UI_KEY_SIGCLIPMEDIAN,
  UI_KEY_SIGCLIPMEAN,
  UI_KEY_SIGCLIPSTD,
  UI_KEY_SIGCLIPMAD,
  UI_KEY_MADCLIPNUMBER,
  UI_KEY_MADCLIPMEDIAN,
  UI_KEY_MADCLIPMEAN,
  UI_KEY_MADCLIPSTD,
  UI_KEY_MADCLIPMAD,
  UI_KEY_GREATEREQUAL2,
  UI_KEY_LESSTHAN2,
  UI_KEY_ONEBINSTART2,
  UI_KEY_FITWEIGHT,
  UI_KEY_FITESTIMATE,
  UI_KEY_FITESTIMATEHDU,
  UI_KEY_FITESTIMATECOL,
  UI_KEY_FITROBUST,
  UI_KEY_CONCENTRATION,
};





/* Functions */
void
ui_read_check_inputs_setup(int argc, char *argv[],
                           struct statisticsparams *p);

void
ui_free_report(struct statisticsparams *p);

#endif