vv/tools_ggo/clitkConnectedComponentLabeling_ggo.h

   1 /** @file clitkConnectedComponentLabeling_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 */
   7
   8 #ifndef CLITKCONNECTEDCOMPONENTLABELING_GGO_H
   9 #define CLITKCONNECTEDCOMPONENTLABELING_GGO_H
  10
  11 /* If we use autoconf.  */
  12 #ifdef HAVE_CONFIG_H
  13 #include "config.h"
  14 #endif
  15
  16 #include <stdio.h> /* for FILE */
  17
  18 #ifdef __cplusplus
  19 extern "C" {
  20 #endif /* __cplusplus */
  21
  22 #ifndef CMDLINE_PARSER_CLITKCONNECTEDCOMPONENTLABELING_PACKAGE
  23 /** @brief the program name */
  24 #define CMDLINE_PARSER_CLITKCONNECTEDCOMPONENTLABELING_PACKAGE "clitkConnectedComponentLabeling"
  25 #endif
  26
  27 #ifndef CMDLINE_PARSER_CLITKCONNECTEDCOMPONENTLABELING_VERSION
  28 /** @brief the program version */
  29 #define CMDLINE_PARSER_CLITKCONNECTEDCOMPONENTLABELING_VERSION "1.0"
  30 #endif
  31
  32 /** @brief Where the command line options are stored */
  33 struct args_info_clitkConnectedComponentLabeling
  34 {
  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   int imagetypes_flag;  /**< @brief Display allowed image types (default=off).  */
  43   const char *imagetypes_help; /**< @brief Display allowed image types help description.  */
  44   int verboseOption_flag;       /**< @brief Display options values (default=off).  */
  45   const char *verboseOption_help; /**< @brief Display options values help description.  */
  46   char * input_arg;     /**< @brief Input image filename.  */
  47   char * input_orig;    /**< @brief Input image filename original value given at command line.  */
  48   const char *input_help; /**< @brief Input image filename help description.  */
  49   int inputBG_arg;      /**< @brief Input Background (default='0').  */
  50   char * inputBG_orig;  /**< @brief Input Background original value given at command line.  */
  51   const char *inputBG_help; /**< @brief Input Background help description.  */
  52   char * output_arg;    /**< @brief Output filename.  */
  53   char * output_orig;   /**< @brief Output filename original value given at command line.  */
  54   const char *output_help; /**< @brief Output filename help description.  */
  55   int minSize_arg;      /**< @brief Minimum component size in voxels (default='100').  */
  56   char * minSize_orig;  /**< @brief Minimum component size in voxels original value given at command line.  */
  57   const char *minSize_help; /**< @brief Minimum component size in voxels help description.  */
  58   int full_flag;        /**< @brief Full connecticity (default=off).  */
  59   const char *full_help; /**< @brief Full connecticity help description.  */
  60
  61   unsigned int help_given ;     /**< @brief Whether help was given.  */
  62   unsigned int version_given ;  /**< @brief Whether version was given.  */
  63   unsigned int config_given ;   /**< @brief Whether config was given.  */
  64   unsigned int verbose_given ;  /**< @brief Whether verbose was given.  */
  65   unsigned int imagetypes_given ;       /**< @brief Whether imagetypes was given.  */
  66   unsigned int verboseOption_given ;    /**< @brief Whether verboseOption was given.  */
  67   unsigned int input_given ;    /**< @brief Whether input was given.  */
  68   unsigned int inputBG_given ;  /**< @brief Whether inputBG was given.  */
  69   unsigned int output_given ;   /**< @brief Whether output was given.  */
  70   unsigned int minSize_given ;  /**< @brief Whether minSize was given.  */
  71   unsigned int full_given ;     /**< @brief Whether full was given.  */
  72
  73   char **inputs ; /**< @brief unamed options (options without names) */
  74   unsigned inputs_num ; /**< @brief unamed options number */
  75 } ;
  76
  77 /** @brief The additional parameters to pass to parser functions */
  78 struct cmdline_parser_clitkConnectedComponentLabeling_params
  79 {
  80   int override; /**< @brief whether to override possibly already present options (default 0) */
  81   int initialize; /**< @brief whether to initialize the option structure args_info_clitkConnectedComponentLabeling (default 1) */
  82   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
  83   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure args_info_clitkConnectedComponentLabeling (default 0) */
  84   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
  85 } ;
  86
  87 /** @brief the purpose string of the program */
  88 extern const char *args_info_clitkConnectedComponentLabeling_purpose;
  89 /** @brief the usage string of the program */
  90 extern const char *args_info_clitkConnectedComponentLabeling_usage;
  91 /** @brief all the lines making the help output */
  92 extern const char *args_info_clitkConnectedComponentLabeling_help[];
  93
  94 /**
  95  * The command line parser
  96  * @param argc the number of command line options
  97  * @param argv the command line options
  98  * @param args_info the structure where option information will be stored
  99  * @return 0 if everything went fine, NON 0 if an error took place
 100  */
 101 int cmdline_parser_clitkConnectedComponentLabeling (int argc, char * const *argv,
 102   struct args_info_clitkConnectedComponentLabeling *args_info);
 103
 104 /**
 105  * The command line parser (version with additional parameters - deprecated)
 106  * @param argc the number of command line options
 107  * @param argv the command line options
 108  * @param args_info the structure where option information will be stored
 109  * @param override whether to override possibly already present options
 110  * @param initialize whether to initialize the option structure my_args_info
 111  * @param check_required whether to check that all required options were provided
 112  * @return 0 if everything went fine, NON 0 if an error took place
 113  * @deprecated use cmdline_parser_clitkConnectedComponentLabeling_ext() instead
 114  */
 115 int cmdline_parser_clitkConnectedComponentLabeling2 (int argc, char * const *argv,
 116   struct args_info_clitkConnectedComponentLabeling *args_info,
 117   int override, int initialize, int check_required);
 118
 119 /**
 120  * The command line parser (version with additional parameters)
 121  * @param argc the number of command line options
 122  * @param argv the command line options
 123  * @param args_info the structure where option information will be stored
 124  * @param params additional parameters for the parser
 125  * @return 0 if everything went fine, NON 0 if an error took place
 126  */
 127 int cmdline_parser_clitkConnectedComponentLabeling_ext (int argc, char * const *argv,
 128   struct args_info_clitkConnectedComponentLabeling *args_info,
 129   struct cmdline_parser_clitkConnectedComponentLabeling_params *params);
 130
 131 /**
 132  * Save the contents of the option struct into an already open FILE stream.
 133  * @param outfile the stream where to dump options
 134  * @param args_info the option struct to dump
 135  * @return 0 if everything went fine, NON 0 if an error took place
 136  */
 137 int cmdline_parser_clitkConnectedComponentLabeling_dump(FILE *outfile,
 138   struct args_info_clitkConnectedComponentLabeling *args_info);
 139
 140 /**
 141  * Save the contents of the option struct into a (text) file.
 142  * This file can be read by the config file parser (if generated by gengetopt)
 143  * @param filename the file where to save
 144  * @param args_info the option struct to save
 145  * @return 0 if everything went fine, NON 0 if an error took place
 146  */
 147 int cmdline_parser_clitkConnectedComponentLabeling_file_save(const char *filename,
 148   struct args_info_clitkConnectedComponentLabeling *args_info);
 149
 150 /**
 151  * Print the help
 152  */
 153 void cmdline_parser_clitkConnectedComponentLabeling_print_help(void);
 154 /**
 155  * Print the version
 156  */
 157 void cmdline_parser_clitkConnectedComponentLabeling_print_version(void);
 158
 159 /**
 160  * Initializes all the fields a cmdline_parser_clitkConnectedComponentLabeling_params structure
 161  * to their default values
 162  * @param params the structure to initialize
 163  */
 164 void cmdline_parser_clitkConnectedComponentLabeling_params_init(struct cmdline_parser_clitkConnectedComponentLabeling_params *params);
 165
 166 /**
 167  * Allocates dynamically a cmdline_parser_clitkConnectedComponentLabeling_params structure and initializes
 168  * all its fields to their default values
 169  * @return the created and initialized cmdline_parser_clitkConnectedComponentLabeling_params structure
 170  */
 171 struct cmdline_parser_clitkConnectedComponentLabeling_params *cmdline_parser_clitkConnectedComponentLabeling_params_create(void);
 172
 173 /**
 174  * Initializes the passed args_info_clitkConnectedComponentLabeling structure's fields
 175  * (also set default values for options that have a default)
 176  * @param args_info the structure to initialize
 177  */
 178 void cmdline_parser_clitkConnectedComponentLabeling_init (struct args_info_clitkConnectedComponentLabeling *args_info);
 179 /**
 180  * Deallocates the string fields of the args_info_clitkConnectedComponentLabeling structure
 181  * (but does not deallocate the structure itself)
 182  * @param args_info the structure to deallocate
 183  */
 184 void cmdline_parser_clitkConnectedComponentLabeling_free (struct args_info_clitkConnectedComponentLabeling *args_info);
 185
 186 /**
 187  * The config file parser (deprecated version)
 188  * @param filename the name of the config file
 189  * @param args_info the structure where option information will be stored
 190  * @param override whether to override possibly already present options
 191  * @param initialize whether to initialize the option structure my_args_info
 192  * @param check_required whether to check that all required options were provided
 193  * @return 0 if everything went fine, NON 0 if an error took place
 194  * @deprecated use cmdline_parser_clitkConnectedComponentLabeling_config_file() instead
 195  */
 196 int cmdline_parser_clitkConnectedComponentLabeling_configfile (char * const filename,
 197   struct args_info_clitkConnectedComponentLabeling *args_info,
 198   int override, int initialize, int check_required);
 199
 200 /**
 201  * The config file parser
 202  * @param filename the name of the config file
 203  * @param args_info the structure where option information will be stored
 204  * @param params additional parameters for the parser
 205  * @return 0 if everything went fine, NON 0 if an error took place
 206  */
 207 int cmdline_parser_clitkConnectedComponentLabeling_config_file (char * const filename,
 208   struct args_info_clitkConnectedComponentLabeling *args_info,
 209   struct cmdline_parser_clitkConnectedComponentLabeling_params *params);
 210
 211 /**
 212  * Checks that all the required options were specified
 213  * @param args_info the structure to check
 214  * @param prog_name the name of the program that will be used to print
 215  *   possible errors
 216  * @return
 217  */
 218 int cmdline_parser_clitkConnectedComponentLabeling_required (struct args_info_clitkConnectedComponentLabeling *args_info,
 219   const char *prog_name);
 220
 221
 222 #ifdef __cplusplus
 223 }
 224 #endif /* __cplusplus */
 225 #endif /* CLITKCONNECTEDCOMPONENTLABELING_GGO_H */