Get information concerning the procedure parameters.

The operator get_param_info is used for calling up the online-texts assigned to a parameter of an indicated procedure. The form of information available for each parameter (Slot), can be called up by using the operator query_param_info. At the moment the following slots are available:

  'description'
              Description of the parameter.

  'description.latex'      
              Description of the parameter in LaTeX notation.

  'parameter_class'  
              Parameter classes: 'input_object', 'output_object', 
              'input_control' or 'output_control'.

  'type_list'   
              Permitted type(s) of data for parameter values 
              (for control parameters only).
                Values: 'real', 'integer' or 'string'.

  'sem_type'
              Semantic type of the parameter. This is important to allow the 
              assignment of the parameters to object classes in object-oriented
              languages (C++, Smalltalk). If more than one parameter belongs
              semantically to one type, this fact is indicated as well. So far 
              the following objects are supported:
                      object, image, region, xld,             
                      xld_cont, xld_para, xld_poly, xld_ext_para, xld_mod_para,
                      integer, real, number, string,
                      channel, grayval, window,
                      histogram, distribution,
                      point(.x, .y), extent(.x, .y),
                      angle(.rad oder .deg),
                      circle(.center.x, .center.y, .radius),
                      arc(.center.x, .center.y, .angle.rad, .begin.x, .begin.y),
                      ellipse(.center.x, .center.y, .angle.rad, .radius1, .radius2),
                      line(.begin.x, .begin.y, .end.x, .end.y)
                      rectangle(.origin.x, .origin.y, .corner.x, .corner.y
                                                 bzw. .extent.x, .extent.y),
                      polygon(.x, .y), contour(.x, .y),
                      coordinates(.x, .y), chord(.x1, .x2, .y),
                      chain(.begin.x, .begin.y, .code),

  'default_type'   
              Default-type for parameter values (for control parameters only).
              This type of parameter is the one HALCON/C uses in the
              "simple mode". If 'none' is indicated, the "tuple mode" must
              be used. 
              Values: 'real', 'integer', 'string' or 'none'.

  'default_value'
            Default-value for the parameter
              (for input-control parameters only).
              It is the question of mere information only (the parameter
              value must be transmitted explicitly, even if the 
              default-value is used). This entry serves only as a notice, a
              point of departure for own experiments. The values have been
              selected so that they normally do not cause any errors but
              generate something that makes sense.

  'multivalue'  
            'true', if more than one value is permitted in this parameter position,
              otherwise 'false'. 

  'multichannel'  
            'true', in case the input image object may have more than one channel.

  'mixed_type'
            For control parameters exclusively and only if value tuples
              ('multivalue'-'true') and various types of data are permitted
              for the parameter values ('type_list' having more than one value).
              In this case Slot indicates, whether it is allowable to have values
              of different types in one tuple ('true' or 'false').   

  'values'
              Selection of possible values.

  'value_list'
            In case a parameter can only take a limited number of values, these
              will be indicated explicitly.

  'valuemin'
              Minimum value of a value interval.

  'valuemax'
              Maximum value of a value interval.

  'valuefunction'
              Function discribing the course of the values for a series of tests
          (lin, log, quadr, ...).

  'steprec'
              Recommended step width of the parameter values in a series of tests.

  'stepmin'
              Minimum step width of the parameter values in a series of tests.

  'valuenumber'
              Expression describing the number of parameters as such or in relation
              to other parameters.

  'assertion' 
              Expression describing the parameter values as such or in relation to other
              parameters.

The online-texts will be taken from the files english.hlp, english.sta, english.key, english.num and english.idx which will be searched by HALCON in the currently used directory or the directory 'help_dir' (see also get_system and set_system).

The operator get_param_info returns the value 2 (H_MSG_TRUE) if the parameters are correct and the helpfiles are available. Otherwise an exception handling is raised.

get_param_info is processed completely exclusively without parallelization.

get_keywords, search_operator

get_param_names, get_param_num, get_param_types

query_param_info, get_operator_info, get_operator_name

Image / region / XLD management