vv/tools_ggo/clitkRegionGrowing_ggo.h

   1 /** @file clitkRegionGrowing_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 CLITKREGIONGROWING_GGO_H
   9 #define CLITKREGIONGROWING_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_CLITKREGIONGROWING_PACKAGE
  23 /** @brief the program name */
  24 #define CMDLINE_PARSER_CLITKREGIONGROWING_PACKAGE "clitkRegionGrowing"
  25 #endif
  26
  27 #ifndef CMDLINE_PARSER_CLITKREGIONGROWING_VERSION
  28 /** @brief the program version */
  29 #define CMDLINE_PARSER_CLITKREGIONGROWING_VERSION "1.0"
  30 #endif
  31
  32 /** @brief Where the command line options are stored */
  33 struct args_info_clitkRegionGrowing
  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   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 type_arg; /**< @brief Region growing filter type: 0=threshold , 1=neighborhood-threshold , 2=confidence , 3= locally-adaptive-threshold, 4= explosion-controlled-threshold (default='0').  */
  49   char * type_orig;     /**< @brief Region growing filter type: 0=threshold , 1=neighborhood-threshold , 2=confidence , 3= locally-adaptive-threshold, 4= explosion-controlled-threshold original value given at command line.  */
  50   const char *type_help; /**< @brief Region growing filter type: 0=threshold , 1=neighborhood-threshold , 2=confidence , 3= locally-adaptive-threshold, 4= explosion-controlled-threshold help description.  */
  51   double lower_arg;     /**< @brief 1,2,3,4: Lower threshold value (default='310').  */
  52   char * lower_orig;    /**< @brief 1,2,3,4: Lower threshold value original value given at command line.  */
  53   const char *lower_help; /**< @brief 1,2,3,4: Lower threshold value help description.  */
  54   double upper_arg;     /**< @brief 1,2,3,4: Upper threshold value (default='4000').  */
  55   char * upper_orig;    /**< @brief 1,2,3,4: Upper threshold value original value given at command line.  */
  56   const char *upper_help; /**< @brief 1,2,3,4: Upper threshold value help description.  */
  57   double maxUpper_arg;  /**< @brief 4: Maximum upper threshold value (default='2000').  */
  58   char * maxUpper_orig; /**< @brief 4: Maximum upper threshold value original value given at command line.  */
  59   const char *maxUpper_help; /**< @brief 4: Maximum upper threshold value help description.  */
  60   double minLower_arg;  /**< @brief 4: Minimum lower threshold value (default='-1000').  */
  61   char * minLower_orig; /**< @brief 4: Minimum lower threshold value original value given at command line.  */
  62   const char *minLower_help; /**< @brief 4: Minimum lower threshold value help description.  */
  63   double step_arg;      /**< @brief 4: Threshold step size (default='64.0').  */
  64   char * step_orig;     /**< @brief 4: Threshold step size original value given at command line.  */
  65   const char *step_help; /**< @brief 4: Threshold step size help description.  */
  66   double minStep_arg;   /**< @brief 4: Minimum threshold step size (default='1').  */
  67   char * minStep_orig;  /**< @brief 4: Minimum threshold step size original value given at command line.  */
  68   const char *minStep_help; /**< @brief 4: Minimum threshold step size help description.  */
  69   int adaptLower_flag;  /**< @brief 3,4: (locally) adapt lower thresholding (default=off).  */
  70   const char *adaptLower_help; /**< @brief 3,4: (locally) adapt lower thresholding help description.  */
  71   int adaptUpper_flag;  /**< @brief 3,4: (locally) adapt upper thresholding (default=off).  */
  72   const char *adaptUpper_help; /**< @brief 3,4: (locally) adapt upper thresholding help description.  */
  73   double multiplier_arg;        /**< @brief 2-4: (2-3) accept if within mean+-mutiplier*SD, (4) explosion if size increases multiplier times (default='2.0').  */
  74   char * multiplier_orig;       /**< @brief 2-4: (2-3) accept if within mean+-mutiplier*SD, (4) explosion if size increases multiplier times original value given at command line.  */
  75   const char *multiplier_help; /**< @brief 2-4: (2-3) accept if within mean+-mutiplier*SD, (4) explosion if size increases multiplier times help description.  */
  76   int* seed_arg;        /**< @brief Seed index postion (in voxels) (default='0').  */
  77   char ** seed_orig;    /**< @brief Seed index postion (in voxels) original value given at command line.  */
  78   int seed_min; /**< @brief Seed index postion (in voxels)'s minimum occurreces */
  79   int seed_max; /**< @brief Seed index postion (in voxels)'s maximum occurreces */
  80   const char *seed_help; /**< @brief Seed index postion (in voxels) help description.  */
  81   int* seedRadius_arg;  /**< @brief Radius used for seed dilatation(in voxel) (default='0').  */
  82   char ** seedRadius_orig;      /**< @brief Radius used for seed dilatation(in voxel) original value given at command line.  */
  83   int seedRadius_min; /**< @brief Radius used for seed dilatation(in voxel)'s minimum occurreces */
  84   int seedRadius_max; /**< @brief Radius used for seed dilatation(in voxel)'s maximum occurreces */
  85   const char *seedRadius_help; /**< @brief Radius used for seed dilatation(in voxel) help description.  */
  86   double pad_arg;       /**< @brief The replace padding value (default='1.0').  */
  87   char * pad_orig;      /**< @brief The replace padding value original value given at command line.  */
  88   const char *pad_help; /**< @brief The replace padding value help description.  */
  89   int* radius_arg;      /**< @brief 1-3: The radius of the neighborhood (default='1').  */
  90   char ** radius_orig;  /**< @brief 1-3: The radius of the neighborhood original value given at command line.  */
  91   int radius_min; /**< @brief 1-3: The radius of the neighborhood's minimum occurreces */
  92   int radius_max; /**< @brief 1-3: The radius of the neighborhood's maximum occurreces */
  93   const char *radius_help; /**< @brief 1-3: The radius of the neighborhood help description.  */
  94   double maxSD_arg;     /**< @brief 3: Limit to SD.  */
  95   char * maxSD_orig;    /**< @brief 3: Limit to SD original value given at command line.  */
  96   const char *maxSD_help; /**< @brief 3: Limit to SD help description.  */
  97   int full_flag;        /**< @brief 4: use full connectivity (not implemented yet) (default=off).  */
  98   const char *full_help; /**< @brief 4: use full connectivity (not implemented yet) help description.  */
  99   int iter_arg; /**< @brief 2: Iterations (default='5').  */
 100   char * iter_orig;     /**< @brief 2: Iterations original value given at command line.  */
 101   const char *iter_help; /**< @brief 2: Iterations help description.  */
 102
 103   unsigned int help_given ;     /**< @brief Whether help was given.  */
 104   unsigned int version_given ;  /**< @brief Whether version was given.  */
 105   unsigned int config_given ;   /**< @brief Whether config was given.  */
 106   unsigned int verbose_given ;  /**< @brief Whether verbose was given.  */
 107   unsigned int input_given ;    /**< @brief Whether input was given.  */
 108   unsigned int output_given ;   /**< @brief Whether output was given.  */
 109   unsigned int type_given ;     /**< @brief Whether type was given.  */
 110   unsigned int lower_given ;    /**< @brief Whether lower was given.  */
 111   unsigned int upper_given ;    /**< @brief Whether upper was given.  */
 112   unsigned int maxUpper_given ; /**< @brief Whether maxUpper was given.  */
 113   unsigned int minLower_given ; /**< @brief Whether minLower was given.  */
 114   unsigned int step_given ;     /**< @brief Whether step was given.  */
 115   unsigned int minStep_given ;  /**< @brief Whether minStep was given.  */
 116   unsigned int adaptLower_given ;       /**< @brief Whether adaptLower was given.  */
 117   unsigned int adaptUpper_given ;       /**< @brief Whether adaptUpper was given.  */
 118   unsigned int multiplier_given ;       /**< @brief Whether multiplier was given.  */
 119   unsigned int seed_given ;     /**< @brief Whether seed was given.  */
 120   unsigned int seedRadius_given ;       /**< @brief Whether seedRadius was given.  */
 121   unsigned int pad_given ;      /**< @brief Whether pad was given.  */
 122   unsigned int radius_given ;   /**< @brief Whether radius was given.  */
 123   unsigned int maxSD_given ;    /**< @brief Whether maxSD was given.  */
 124   unsigned int full_given ;     /**< @brief Whether full was given.  */
 125   unsigned int iter_given ;     /**< @brief Whether iter was given.  */
 126
 127   char **inputs ; /**< @brief unamed options (options without names) */
 128   unsigned inputs_num ; /**< @brief unamed options number */
 129 } ;
 130
 131 /** @brief The additional parameters to pass to parser functions */
 132 struct cmdline_parser_clitkRegionGrowing_params
 133 {
 134   int override; /**< @brief whether to override possibly already present options (default 0) */
 135   int initialize; /**< @brief whether to initialize the option structure args_info_clitkRegionGrowing (default 1) */
 136   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
 137   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure args_info_clitkRegionGrowing (default 0) */
 138   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
 139 } ;
 140
 141 /** @brief the purpose string of the program */
 142 extern const char *args_info_clitkRegionGrowing_purpose;
 143 /** @brief the usage string of the program */
 144 extern const char *args_info_clitkRegionGrowing_usage;
 145 /** @brief all the lines making the help output */
 146 extern const char *args_info_clitkRegionGrowing_help[];
 147
 148 /**
 149  * The command line parser
 150  * @param argc the number of command line options
 151  * @param argv the command line options
 152  * @param args_info the structure where option information will be stored
 153  * @return 0 if everything went fine, NON 0 if an error took place
 154  */
 155 int cmdline_parser_clitkRegionGrowing (int argc, char * const *argv,
 156   struct args_info_clitkRegionGrowing *args_info);
 157
 158 /**
 159  * The command line parser (version with additional parameters - deprecated)
 160  * @param argc the number of command line options
 161  * @param argv the command line options
 162  * @param args_info the structure where option information will be stored
 163  * @param override whether to override possibly already present options
 164  * @param initialize whether to initialize the option structure my_args_info
 165  * @param check_required whether to check that all required options were provided
 166  * @return 0 if everything went fine, NON 0 if an error took place
 167  * @deprecated use cmdline_parser_clitkRegionGrowing_ext() instead
 168  */
 169 int cmdline_parser_clitkRegionGrowing2 (int argc, char * const *argv,
 170   struct args_info_clitkRegionGrowing *args_info,
 171   int override, int initialize, int check_required);
 172
 173 /**
 174  * The command line parser (version with additional parameters)
 175  * @param argc the number of command line options
 176  * @param argv the command line options
 177  * @param args_info the structure where option information will be stored
 178  * @param params additional parameters for the parser
 179  * @return 0 if everything went fine, NON 0 if an error took place
 180  */
 181 int cmdline_parser_clitkRegionGrowing_ext (int argc, char * const *argv,
 182   struct args_info_clitkRegionGrowing *args_info,
 183   struct cmdline_parser_clitkRegionGrowing_params *params);
 184
 185 /**
 186  * Save the contents of the option struct into an already open FILE stream.
 187  * @param outfile the stream where to dump options
 188  * @param args_info the option struct to dump
 189  * @return 0 if everything went fine, NON 0 if an error took place
 190  */
 191 int cmdline_parser_clitkRegionGrowing_dump(FILE *outfile,
 192   struct args_info_clitkRegionGrowing *args_info);
 193
 194 /**
 195  * Save the contents of the option struct into a (text) file.
 196  * This file can be read by the config file parser (if generated by gengetopt)
 197  * @param filename the file where to save
 198  * @param args_info the option struct to save
 199  * @return 0 if everything went fine, NON 0 if an error took place
 200  */
 201 int cmdline_parser_clitkRegionGrowing_file_save(const char *filename,
 202   struct args_info_clitkRegionGrowing *args_info);
 203
 204 /**
 205  * Print the help
 206  */
 207 void cmdline_parser_clitkRegionGrowing_print_help(void);
 208 /**
 209  * Print the version
 210  */
 211 void cmdline_parser_clitkRegionGrowing_print_version(void);
 212
 213 /**
 214  * Initializes all the fields a cmdline_parser_clitkRegionGrowing_params structure
 215  * to their default values
 216  * @param params the structure to initialize
 217  */
 218 void cmdline_parser_clitkRegionGrowing_params_init(struct cmdline_parser_clitkRegionGrowing_params *params);
 219
 220 /**
 221  * Allocates dynamically a cmdline_parser_clitkRegionGrowing_params structure and initializes
 222  * all its fields to their default values
 223  * @return the created and initialized cmdline_parser_clitkRegionGrowing_params structure
 224  */
 225 struct cmdline_parser_clitkRegionGrowing_params *cmdline_parser_clitkRegionGrowing_params_create(void);
 226
 227 /**
 228  * Initializes the passed args_info_clitkRegionGrowing structure's fields
 229  * (also set default values for options that have a default)
 230  * @param args_info the structure to initialize
 231  */
 232 void cmdline_parser_clitkRegionGrowing_init (struct args_info_clitkRegionGrowing *args_info);
 233 /**
 234  * Deallocates the string fields of the args_info_clitkRegionGrowing structure
 235  * (but does not deallocate the structure itself)
 236  * @param args_info the structure to deallocate
 237  */
 238 void cmdline_parser_clitkRegionGrowing_free (struct args_info_clitkRegionGrowing *args_info);
 239
 240 /**
 241  * The config file parser (deprecated version)
 242  * @param filename the name of the config file
 243  * @param args_info the structure where option information will be stored
 244  * @param override whether to override possibly already present options
 245  * @param initialize whether to initialize the option structure my_args_info
 246  * @param check_required whether to check that all required options were provided
 247  * @return 0 if everything went fine, NON 0 if an error took place
 248  * @deprecated use cmdline_parser_clitkRegionGrowing_config_file() instead
 249  */
 250 int cmdline_parser_clitkRegionGrowing_configfile (char * const filename,
 251   struct args_info_clitkRegionGrowing *args_info,
 252   int override, int initialize, int check_required);
 253
 254 /**
 255  * The config file parser
 256  * @param filename the name of the config file
 257  * @param args_info the structure where option information will be stored
 258  * @param params additional parameters for the parser
 259  * @return 0 if everything went fine, NON 0 if an error took place
 260  */
 261 int cmdline_parser_clitkRegionGrowing_config_file (char * const filename,
 262   struct args_info_clitkRegionGrowing *args_info,
 263   struct cmdline_parser_clitkRegionGrowing_params *params);
 264
 265 /**
 266  * Checks that all the required options were specified
 267  * @param args_info the structure to check
 268  * @param prog_name the name of the program that will be used to print
 269  *   possible errors
 270  * @return
 271  */
 272 int cmdline_parser_clitkRegionGrowing_required (struct args_info_clitkRegionGrowing *args_info,
 273   const char *prog_name);
 274
 275
 276 #ifdef __cplusplus
 277 }
 278 #endif /* __cplusplus */
 279 #endif /* CLITKREGIONGROWING_GGO_H */