get_param_infoget_param_infoGetParamInfoGetParamInfo (Operator)

Name

get_param_infoget_param_infoGetParamInfoGetParamInfo — Get information concerning the operator parameters.

Signature

Description

The operator get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfo is used for calling up the online-texts assigned to a parameter of an indicated operator. The form of information available for each parameter (SlotSlotSlotSlotslot), can be called up by using the operator query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfo. 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 Values: 'real', 'integer' or 'string' (for control parameters), 'byte', 'direction', 'cyclic', 'int1', 'int2', 'uint2', 'int4', 'int8', 'real', 'complex', 'vector_field' (for images).

'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. Value: 'real', 'integer', 'string' or 'none'.

'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++, .NET, COM). 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 or .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

or .extent.x, .extent.y),

polygon(.x, .y), contour(.x, .y),

coordinates(.x, .y), chord(.x1, .x2, .y),

chain(.begin.x, .begin.y, .code).

'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.

'modified':

'true', if the operator modifies this input parameter.

'multivalue':

'true', if an array of values must be passed, 'false', if exactly one value must be passed, and 'optional' allows both.

'multichannel':

'true', in case the input image object may be multichannel.

'mixed_type':

For control parameters exclusively and only if value tuples ('multivalue'-'true'/'optional') and various types of data are permitted for the parameter values ('type_list' having more than one value). In this case SlotSlotSlotSlotslot indicates, whether values of various types may be mixed in one tuple ('true' or 'false').

'values':

Selection of values (optional).

'value_list':

In case a parameter can take only a limited number of values, this fact will be indicated explicitly (optional).

'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 for the parameter values in a series of tests.

'steprec':

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.

'cd_type_list.[compute_device]':

List of input image types the compute device implementation of the operator supports for a specific device (use 'cd_type_list.opencl' for OpenCL devices).

'cd_value_list.[compute_device]':

List of input control parameters the compute device implementation of the operator supports for a specific device (use 'cd_value_list.opencl' for OpenCL devices).

The online-texts will be taken from the files operators_[LANG].ref, operators_[LANG].sta, operators_[LANG].key, operators_[LANG].num and operators_[LANG].idx which will be searched by HALCON in the currently used directory or the directory 'help_dir' (see also get_systemget_systemGetSystemGetSystemGetSystem and set_systemset_systemSetSystemSetSystemSetSystem).

Attention

The encoding of the result is ISO 8859-1 for English and German, and UTF-8 for Japanese.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywords, search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperator

Alternatives

get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNames, get_param_numget_param_numGetParamNumGetParamNumGetParamNum, get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypes

See also

query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfo, get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo, get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorName

Module

Foundation