1 /** @file clitkMedianImageFilter_ggo.h
2 * @brief The header file for the command line option parser
3 * generated by GNU Gengetopt version 2.22
4 * http://www.gnu.org/software/gengetopt.
5 * DO NOT modify this file, since it can be overwritten
6 * @author GNU Gengetopt by Lorenzo Bettini */
8 #ifndef CLITKMEDIANIMAGEFILTER_GGO_H
9 #define CLITKMEDIANIMAGEFILTER_GGO_H
11 /* If we use autoconf. */
16 #include <stdio.h> /* for FILE */
20 #endif /* __cplusplus */
22 #ifndef CMDLINE_PARSER_CLITKMEDIANIMAGEFILTER_PACKAGE
23 /** @brief the program name */
24 #define CMDLINE_PARSER_CLITKMEDIANIMAGEFILTER_PACKAGE "clitkMedianImageFilter"
27 #ifndef CMDLINE_PARSER_CLITKMEDIANIMAGEFILTER_VERSION
28 /** @brief the program version */
29 #define CMDLINE_PARSER_CLITKMEDIANIMAGEFILTER_VERSION "1.0"
32 /** @brief Where the command line options are stored */
33 struct args_info_clitkMedianImageFilter
35 const char *help_help; /**< @brief Print help and exit help description. */
36 const char *version_help; /**< @brief Print version and exit help description. */
37 char * config_arg; /**< @brief Config file. */
38 char * config_orig; /**< @brief Config file original value given at command line. */
39 const char *config_help; /**< @brief Config file help description. */
40 int verbose_flag; /**< @brief Verbose (default=off). */
41 const char *verbose_help; /**< @brief Verbose help description. */
42 char * input_arg; /**< @brief Input image filename. */
43 char * input_orig; /**< @brief Input image filename original value given at command line. */
44 const char *input_help; /**< @brief Input image filename help description. */
45 char * output_arg; /**< @brief Output image filename. */
46 char * output_orig; /**< @brief Output image filename original value given at command line. */
47 const char *output_help; /**< @brief Output image filename help description. */
48 int* radius_arg; /**< @brief Radius in each Direction (default='1'). */
49 char ** radius_orig; /**< @brief Radius in each Direction original value given at command line. */
50 int radius_min; /**< @brief Radius in each Direction's minimum occurreces */
51 int radius_max; /**< @brief Radius in each Direction's maximum occurreces */
52 const char *radius_help; /**< @brief Radius in each Direction help description. */
54 unsigned int help_given ; /**< @brief Whether help was given. */
55 unsigned int version_given ; /**< @brief Whether version was given. */
56 unsigned int config_given ; /**< @brief Whether config was given. */
57 unsigned int verbose_given ; /**< @brief Whether verbose was given. */
58 unsigned int input_given ; /**< @brief Whether input was given. */
59 unsigned int output_given ; /**< @brief Whether output was given. */
60 unsigned int radius_given ; /**< @brief Whether radius was given. */
62 char **inputs ; /**< @brief unamed options (options without names) */
63 unsigned inputs_num ; /**< @brief unamed options number */
66 /** @brief The additional parameters to pass to parser functions */
67 struct cmdline_parser_clitkMedianImageFilter_params
69 int override; /**< @brief whether to override possibly already present options (default 0) */
70 int initialize; /**< @brief whether to initialize the option structure args_info_clitkMedianImageFilter (default 1) */
71 int check_required; /**< @brief whether to check that all required options were provided (default 1) */
72 int check_ambiguity; /**< @brief whether to check for options already specified in the option structure args_info_clitkMedianImageFilter (default 0) */
73 int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
76 /** @brief the purpose string of the program */
77 extern const char *args_info_clitkMedianImageFilter_purpose;
78 /** @brief the usage string of the program */
79 extern const char *args_info_clitkMedianImageFilter_usage;
80 /** @brief all the lines making the help output */
81 extern const char *args_info_clitkMedianImageFilter_help[];
84 * The command line parser
85 * @param argc the number of command line options
86 * @param argv the command line options
87 * @param args_info the structure where option information will be stored
88 * @return 0 if everything went fine, NON 0 if an error took place
90 int cmdline_parser_clitkMedianImageFilter (int argc, char * const *argv,
91 struct args_info_clitkMedianImageFilter *args_info);
94 * The command line parser (version with additional parameters - deprecated)
95 * @param argc the number of command line options
96 * @param argv the command line options
97 * @param args_info the structure where option information will be stored
98 * @param override whether to override possibly already present options
99 * @param initialize whether to initialize the option structure my_args_info
100 * @param check_required whether to check that all required options were provided
101 * @return 0 if everything went fine, NON 0 if an error took place
102 * @deprecated use cmdline_parser_clitkMedianImageFilter_ext() instead
104 int cmdline_parser_clitkMedianImageFilter2 (int argc, char * const *argv,
105 struct args_info_clitkMedianImageFilter *args_info,
106 int override, int initialize, int check_required);
109 * The command line parser (version with additional parameters)
110 * @param argc the number of command line options
111 * @param argv the command line options
112 * @param args_info the structure where option information will be stored
113 * @param params additional parameters for the parser
114 * @return 0 if everything went fine, NON 0 if an error took place
116 int cmdline_parser_clitkMedianImageFilter_ext (int argc, char * const *argv,
117 struct args_info_clitkMedianImageFilter *args_info,
118 struct cmdline_parser_clitkMedianImageFilter_params *params);
121 * Save the contents of the option struct into an already open FILE stream.
122 * @param outfile the stream where to dump options
123 * @param args_info the option struct to dump
124 * @return 0 if everything went fine, NON 0 if an error took place
126 int cmdline_parser_clitkMedianImageFilter_dump(FILE *outfile,
127 struct args_info_clitkMedianImageFilter *args_info);
130 * Save the contents of the option struct into a (text) file.
131 * This file can be read by the config file parser (if generated by gengetopt)
132 * @param filename the file where to save
133 * @param args_info the option struct to save
134 * @return 0 if everything went fine, NON 0 if an error took place
136 int cmdline_parser_clitkMedianImageFilter_file_save(const char *filename,
137 struct args_info_clitkMedianImageFilter *args_info);
142 void cmdline_parser_clitkMedianImageFilter_print_help(void);
146 void cmdline_parser_clitkMedianImageFilter_print_version(void);
149 * Initializes all the fields a cmdline_parser_clitkMedianImageFilter_params structure
150 * to their default values
151 * @param params the structure to initialize
153 void cmdline_parser_clitkMedianImageFilter_params_init(struct cmdline_parser_clitkMedianImageFilter_params *params);
156 * Allocates dynamically a cmdline_parser_clitkMedianImageFilter_params structure and initializes
157 * all its fields to their default values
158 * @return the created and initialized cmdline_parser_clitkMedianImageFilter_params structure
160 struct cmdline_parser_clitkMedianImageFilter_params *cmdline_parser_clitkMedianImageFilter_params_create(void);
163 * Initializes the passed args_info_clitkMedianImageFilter structure's fields
164 * (also set default values for options that have a default)
165 * @param args_info the structure to initialize
167 void cmdline_parser_clitkMedianImageFilter_init (struct args_info_clitkMedianImageFilter *args_info);
169 * Deallocates the string fields of the args_info_clitkMedianImageFilter structure
170 * (but does not deallocate the structure itself)
171 * @param args_info the structure to deallocate
173 void cmdline_parser_clitkMedianImageFilter_free (struct args_info_clitkMedianImageFilter *args_info);
176 * The config file parser (deprecated version)
177 * @param filename the name of the config file
178 * @param args_info the structure where option information will be stored
179 * @param override whether to override possibly already present options
180 * @param initialize whether to initialize the option structure my_args_info
181 * @param check_required whether to check that all required options were provided
182 * @return 0 if everything went fine, NON 0 if an error took place
183 * @deprecated use cmdline_parser_clitkMedianImageFilter_config_file() instead
185 int cmdline_parser_clitkMedianImageFilter_configfile (char * const filename,
186 struct args_info_clitkMedianImageFilter *args_info,
187 int override, int initialize, int check_required);
190 * The config file parser
191 * @param filename the name of the config file
192 * @param args_info the structure where option information will be stored
193 * @param params additional parameters for the parser
194 * @return 0 if everything went fine, NON 0 if an error took place
196 int cmdline_parser_clitkMedianImageFilter_config_file (char * const filename,
197 struct args_info_clitkMedianImageFilter *args_info,
198 struct cmdline_parser_clitkMedianImageFilter_params *params);
201 * Checks that all the required options were specified
202 * @param args_info the structure to check
203 * @param prog_name the name of the program that will be used to print
207 int cmdline_parser_clitkMedianImageFilter_required (struct args_info_clitkMedianImageFilter *args_info,
208 const char *prog_name);
213 #endif /* __cplusplus */
214 #endif /* CLITKMEDIANIMAGEFILTER_GGO_H */