vv/tools_ggo/clitkImageArithm_ggo.h

   1 /** @file clitkImageArithm_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 CLITKIMAGEARITHM_GGO_H
   9 #define CLITKIMAGEARITHM_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_CLITKIMAGEARITHM_PACKAGE
  23 /** @brief the program name */
  24 #define CMDLINE_PARSER_CLITKIMAGEARITHM_PACKAGE "clitkImageArithm"
  25 #endif
  26
  27 #ifndef CMDLINE_PARSER_CLITKIMAGEARITHM_VERSION
  28 /** @brief the program version */
  29 #define CMDLINE_PARSER_CLITKIMAGEARITHM_VERSION "1.0"
  30 #endif
  31
  32 /** @brief Where the command line options are stored */
  33 struct args_info_clitkImageArithm
  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   char * input1_arg;    /**< @brief Input first image filename.  */
  45   char * input1_orig;   /**< @brief Input first image filename original value given at command line.  */
  46   const char *input1_help; /**< @brief Input first image filename help description.  */
  47   char * input2_arg;    /**< @brief Input second image filename.  */
  48   char * input2_orig;   /**< @brief Input second image filename original value given at command line.  */
  49   const char *input2_help; /**< @brief Input second image filename help description.  */
  50   char * output_arg;    /**< @brief Output image filename.  */
  51   char * output_orig;   /**< @brief Output image filename original value given at command line.  */
  52   const char *output_help; /**< @brief Output image filename help description.  */
  53   double scalar_arg;    /**< @brief Scalar value.  */
  54   char * scalar_orig;   /**< @brief Scalar value original value given at command line.  */
  55   const char *scalar_help; /**< @brief Scalar value help description.  */
  56   int operation_arg;    /**< @brief Type of operation : \n With another image : 0=add*, 1=multiply, 2=divide,\n 3=max, 4=min, 5=absdiff, 6=squareddiff,  7=difference*, 8=relativ diff\n; For 'scalar' : 0=add*, 1=multiply*, 2=inverse,\n 3=max, 4=min 5=absval 6=squareval\n 7=log 8=exp 9=sqrt 10=EPID 11=divide* 12=normalize (divide by max) 13=-ln(I/IO)**; \n* operations supported with vector fields as inputs. \n** for fluence image, if pixel value == 0, consider value=0.5 (default='0').  */
  57   char * operation_orig;        /**< @brief Type of operation : \n With another image : 0=add*, 1=multiply, 2=divide,\n 3=max, 4=min, 5=absdiff, 6=squareddiff,  7=difference*, 8=relativ diff\n; For 'scalar' : 0=add*, 1=multiply*, 2=inverse,\n 3=max, 4=min 5=absval 6=squareval\n 7=log 8=exp 9=sqrt 10=EPID 11=divide* 12=normalize (divide by max) 13=-ln(I/IO)**; \n* operations supported with vector fields as inputs. \n** for fluence image, if pixel value == 0, consider value=0.5 original value given at command line.  */
  58   const char *operation_help; /**< @brief Type of operation : \n With another image : 0=add*, 1=multiply, 2=divide,\n 3=max, 4=min, 5=absdiff, 6=squareddiff,  7=difference*, 8=relativ diff\n; For 'scalar' : 0=add*, 1=multiply*, 2=inverse,\n 3=max, 4=min 5=absval 6=squareval\n 7=log 8=exp 9=sqrt 10=EPID 11=divide* 12=normalize (divide by max) 13=-ln(I/IO)**; \n* operations supported with vector fields as inputs. \n** for fluence image, if pixel value == 0, consider value=0.5 help description.  */
  59   double pixelValue_arg;        /**< @brief Default value for NaN/Inf (default='0.0').  */
  60   char * pixelValue_orig;       /**< @brief Default value for NaN/Inf original value given at command line.  */
  61   const char *pixelValue_help; /**< @brief Default value for NaN/Inf help description.  */
  62   int setFloatOutput_flag;      /**< @brief Set output to float pixel type (default=off).  */
  63   const char *setFloatOutput_help; /**< @brief Set output to float pixel type help description.  */
  64
  65   unsigned int help_given ;     /**< @brief Whether help was given.  */
  66   unsigned int version_given ;  /**< @brief Whether version was given.  */
  67   unsigned int config_given ;   /**< @brief Whether config was given.  */
  68   unsigned int verbose_given ;  /**< @brief Whether verbose was given.  */
  69   unsigned int imagetypes_given ;       /**< @brief Whether imagetypes was given.  */
  70   unsigned int input1_given ;   /**< @brief Whether input1 was given.  */
  71   unsigned int input2_given ;   /**< @brief Whether input2 was given.  */
  72   unsigned int output_given ;   /**< @brief Whether output was given.  */
  73   unsigned int scalar_given ;   /**< @brief Whether scalar was given.  */
  74   unsigned int operation_given ;        /**< @brief Whether operation was given.  */
  75   unsigned int pixelValue_given ;       /**< @brief Whether pixelValue was given.  */
  76   unsigned int setFloatOutput_given ;   /**< @brief Whether setFloatOutput was given.  */
  77
  78   char **inputs ; /**< @brief unamed options (options without names) */
  79   unsigned inputs_num ; /**< @brief unamed options number */
  80 } ;
  81
  82 /** @brief The additional parameters to pass to parser functions */
  83 struct cmdline_parser_clitkImageArithm_params
  84 {
  85   int override; /**< @brief whether to override possibly already present options (default 0) */
  86   int initialize; /**< @brief whether to initialize the option structure args_info_clitkImageArithm (default 1) */
  87   int check_required; /**< @brief whether to check that all required options were provided (default 1) */
  88   int check_ambiguity; /**< @brief whether to check for options already specified in the option structure args_info_clitkImageArithm (default 0) */
  89   int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
  90 } ;
  91
  92 /** @brief the purpose string of the program */
  93 extern const char *args_info_clitkImageArithm_purpose;
  94 /** @brief the usage string of the program */
  95 extern const char *args_info_clitkImageArithm_usage;
  96 /** @brief all the lines making the help output */
  97 extern const char *args_info_clitkImageArithm_help[];
  98
  99 /**
 100  * The command line parser
 101  * @param argc the number of command line options
 102  * @param argv the command line options
 103  * @param args_info the structure where option information will be stored
 104  * @return 0 if everything went fine, NON 0 if an error took place
 105  */
 106 int cmdline_parser_clitkImageArithm (int argc, char * const *argv,
 107   struct args_info_clitkImageArithm *args_info);
 108
 109 /**
 110  * The command line parser (version with additional parameters - deprecated)
 111  * @param argc the number of command line options
 112  * @param argv the command line options
 113  * @param args_info the structure where option information will be stored
 114  * @param override whether to override possibly already present options
 115  * @param initialize whether to initialize the option structure my_args_info
 116  * @param check_required whether to check that all required options were provided
 117  * @return 0 if everything went fine, NON 0 if an error took place
 118  * @deprecated use cmdline_parser_clitkImageArithm_ext() instead
 119  */
 120 int cmdline_parser_clitkImageArithm2 (int argc, char * const *argv,
 121   struct args_info_clitkImageArithm *args_info,
 122   int override, int initialize, int check_required);
 123
 124 /**
 125  * The command line parser (version with additional parameters)
 126  * @param argc the number of command line options
 127  * @param argv the command line options
 128  * @param args_info the structure where option information will be stored
 129  * @param params additional parameters for the parser
 130  * @return 0 if everything went fine, NON 0 if an error took place
 131  */
 132 int cmdline_parser_clitkImageArithm_ext (int argc, char * const *argv,
 133   struct args_info_clitkImageArithm *args_info,
 134   struct cmdline_parser_clitkImageArithm_params *params);
 135
 136 /**
 137  * Save the contents of the option struct into an already open FILE stream.
 138  * @param outfile the stream where to dump options
 139  * @param args_info the option struct to dump
 140  * @return 0 if everything went fine, NON 0 if an error took place
 141  */
 142 int cmdline_parser_clitkImageArithm_dump(FILE *outfile,
 143   struct args_info_clitkImageArithm *args_info);
 144
 145 /**
 146  * Save the contents of the option struct into a (text) file.
 147  * This file can be read by the config file parser (if generated by gengetopt)
 148  * @param filename the file where to save
 149  * @param args_info the option struct to save
 150  * @return 0 if everything went fine, NON 0 if an error took place
 151  */
 152 int cmdline_parser_clitkImageArithm_file_save(const char *filename,
 153   struct args_info_clitkImageArithm *args_info);
 154
 155 /**
 156  * Print the help
 157  */
 158 void cmdline_parser_clitkImageArithm_print_help(void);
 159 /**
 160  * Print the version
 161  */
 162 void cmdline_parser_clitkImageArithm_print_version(void);
 163
 164 /**
 165  * Initializes all the fields a cmdline_parser_clitkImageArithm_params structure
 166  * to their default values
 167  * @param params the structure to initialize
 168  */
 169 void cmdline_parser_clitkImageArithm_params_init(struct cmdline_parser_clitkImageArithm_params *params);
 170
 171 /**
 172  * Allocates dynamically a cmdline_parser_clitkImageArithm_params structure and initializes
 173  * all its fields to their default values
 174  * @return the created and initialized cmdline_parser_clitkImageArithm_params structure
 175  */
 176 struct cmdline_parser_clitkImageArithm_params *cmdline_parser_clitkImageArithm_params_create(void);
 177
 178 /**
 179  * Initializes the passed args_info_clitkImageArithm structure's fields
 180  * (also set default values for options that have a default)
 181  * @param args_info the structure to initialize
 182  */
 183 void cmdline_parser_clitkImageArithm_init (struct args_info_clitkImageArithm *args_info);
 184 /**
 185  * Deallocates the string fields of the args_info_clitkImageArithm structure
 186  * (but does not deallocate the structure itself)
 187  * @param args_info the structure to deallocate
 188  */
 189 void cmdline_parser_clitkImageArithm_free (struct args_info_clitkImageArithm *args_info);
 190
 191 /**
 192  * The config file parser (deprecated version)
 193  * @param filename the name of the config file
 194  * @param args_info the structure where option information will be stored
 195  * @param override whether to override possibly already present options
 196  * @param initialize whether to initialize the option structure my_args_info
 197  * @param check_required whether to check that all required options were provided
 198  * @return 0 if everything went fine, NON 0 if an error took place
 199  * @deprecated use cmdline_parser_clitkImageArithm_config_file() instead
 200  */
 201 int cmdline_parser_clitkImageArithm_configfile (char * const filename,
 202   struct args_info_clitkImageArithm *args_info,
 203   int override, int initialize, int check_required);
 204
 205 /**
 206  * The config file parser
 207  * @param filename the name of the config file
 208  * @param args_info the structure where option information will be stored
 209  * @param params additional parameters for the parser
 210  * @return 0 if everything went fine, NON 0 if an error took place
 211  */
 212 int cmdline_parser_clitkImageArithm_config_file (char * const filename,
 213   struct args_info_clitkImageArithm *args_info,
 214   struct cmdline_parser_clitkImageArithm_params *params);
 215
 216 /**
 217  * Checks that all the required options were specified
 218  * @param args_info the structure to check
 219  * @param prog_name the name of the program that will be used to print
 220  *   possible errors
 221  * @return
 222  */
 223 int cmdline_parser_clitkImageArithm_required (struct args_info_clitkImageArithm *args_info,
 224   const char *prog_name);
 225
 226
 227 #ifdef __cplusplus
 228 }
 229 #endif /* __cplusplus */
 230 #endif /* CLITKIMAGEARITHM_GGO_H */