get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info (Operator)
Name
get_param_infoget_param_infoGetParamInfoGetParamInfoget_param_info — Get information concerning the operator parameters.
Signature
Description
The operator get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info is used for calling up the
online-texts assigned to a parameter of an indicated operator. The
form of information available for each parameter (SlotSlotSlotSlotslotslot),
can be called up by using the operator query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfoquery_param_info.
Possible slots are given in the list below.
For a more extensive description of the entries and their possible
values we refer to the “Extension Package Programmer’s Manual”.
- 'description'"description""description""description""description""description":
Description of the parameter.
- 'description.latex':
Description of the parameter in LaTeX notation.
- 'parameter_class'"parameter_class""parameter_class""parameter_class""parameter_class""parameter_class":
-
Parameter classes.
'input_object'"input_object""input_object""input_object""input_object""input_object"
'output_object'"output_object""output_object""output_object""output_object""output_object"
'input_control'"input_control""input_control""input_control""input_control""input_control"
'output_control'"output_control""output_control""output_control""output_control""output_control"
- 'type_list'"type_list""type_list""type_list""type_list""type_list":
Permitted type(s) of data for parameter values.
- 'default_type'"default_type""default_type""default_type""default_type""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'"none""none""none""none""none" is indicated, the “tuple mode”
must be used.
- 'sem_type'"sem_type""sem_type""sem_type""sem_type""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.
- 'default_value'"default_value""default_value""default_value""default_value""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'"modified""modified""modified""modified""modified":
'true'"true""true""true""true""true", if the operator modifies this input parameter.
- 'multivalue'"multivalue""multivalue""multivalue""multivalue""multivalue":
-
'true'"true""true""true""true""true", if an array of values must be passed,
'false'"false""false""false""false""false", if exactly one value must be passed, and
'optional'"optional""optional""optional""optional""optional" allows both.
- 'multichannel'"multichannel""multichannel""multichannel""multichannel""multichannel":
'true'"true""true""true""true""true", in case the input image object may be multichannel.
- 'multiinstance'"multiinstance""multiinstance""multiinstance""multiinstance""multiinstance":
-
'true'"true""true""true""true""true", if an array of semantic tuples (e.g., poses, camera
parameters, etc.) must be passed,
'false'"false""false""false""false""false", if exactly one semantic tuple must be passed, and
'optional'"optional""optional""optional""optional""optional" allows both.
- 'mixed_type'"mixed_type""mixed_type""mixed_type""mixed_type""mixed_type":
For control parameters exclusively and only if value tuples
('multivalue'"multivalue""multivalue""multivalue""multivalue""multivalue"-'true'"true""true""true""true""true"/'optional'"optional""optional""optional""optional""optional") and various
types of data are permitted for the parameter values
('type_list' having more than one value).
In this case SlotSlotSlotSlotslotslot indicates, whether values of various
types may be mixed in one tuple ('true'"true""true""true""true""true" or 'false'"false""false""false""false""false").
- 'values'"values""values""values""values""values":
Selection of values (optional).
- 'value_list'"value_list""value_list""value_list""value_list""value_list":
In case a parameter can take only a limited number of values, this
fact will be indicated explicitly (optional).
- 'valuemin'"valuemin""valuemin""valuemin""valuemin""valuemin":
Minimum value of a value interval.
- 'valuemax'"valuemax""valuemax""valuemax""valuemax""valuemax":
Maximum value of a value interval.
- 'valuefunction'"valuefunction""valuefunction""valuefunction""valuefunction""valuefunction":
Function describing the course of the values for a series of tests
(lin, log, quadr, ...).
- 'steprec'"steprec""steprec""steprec""steprec""steprec":
Recommended step width for the parameter values in a series of tests.
- 'stepmin'"stepmin""stepmin""stepmin""stepmin""stepmin":
Minimum step width of the parameter values in a series of tests.
- 'valuenumber'"valuenumber""valuenumber""valuenumber""valuenumber""valuenumber":
Expression describing the number of parameters as such or in relation
to other parameters.
- 'assertion'"assertion""assertion""assertion""assertion""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_systemGetSystemGetSystemGetSystemget_system and
set_systemset_systemSetSystemSetSystemSetSystemset_system).
Attention
The encoding of the result is UTF-8.
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
OperatorNameOperatorNameOperatorNameOperatorNameoperatorNameoperator_name (input_control) proc_name → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the operator on whose parameter more information
is needed.
Default value:
'get_param_info'
"get_param_info"
"get_param_info"
"get_param_info"
"get_param_info"
"get_param_info"
ParamNameParamNameParamNameParamNameparamNameparam_name (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Name of the parameter on which more information is needed.
Default value:
'Slot'
"Slot"
"Slot"
"Slot"
"Slot"
"Slot"
SlotSlotSlotSlotslotslot (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Desired information.
Default value:
'description'
"description"
"description"
"description"
"description"
"description"
List of values: 'assertion'"assertion""assertion""assertion""assertion""assertion", 'cd_type_list.opencl'"cd_type_list.opencl""cd_type_list.opencl""cd_type_list.opencl""cd_type_list.opencl""cd_type_list.opencl", 'cd_value_list.opencl'"cd_value_list.opencl""cd_value_list.opencl""cd_value_list.opencl""cd_value_list.opencl""cd_value_list.opencl", 'default_type'"default_type""default_type""default_type""default_type""default_type", 'default_value'"default_value""default_value""default_value""default_value""default_value", 'description'"description""description""description""description""description", 'mixed_type'"mixed_type""mixed_type""mixed_type""mixed_type""mixed_type", 'modified'"modified""modified""modified""modified""modified", 'multichannel'"multichannel""multichannel""multichannel""multichannel""multichannel", 'multivalue'"multivalue""multivalue""multivalue""multivalue""multivalue", 'sem_type'"sem_type""sem_type""sem_type""sem_type""sem_type", 'step_min'"step_min""step_min""step_min""step_min""step_min", 'step_rec'"step_rec""step_rec""step_rec""step_rec""step_rec", 'type_list'"type_list""type_list""type_list""type_list""type_list", 'value_function'"value_function""value_function""value_function""value_function""value_function", 'value_list'"value_list""value_list""value_list""value_list""value_list", 'value_max'"value_max""value_max""value_max""value_max""value_max", 'value_min'"value_min""value_min""value_min""value_min""value_min", 'value_number'"value_number""value_number""value_number""value_number""value_number", 'values'"values""values""values""values""values"
InformationInformationInformationInformationinformationinformation (output_control) string(-array) → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Information (empty in case there is no information
available).
Result
The operator get_param_infoget_param_infoGetParamInfoGetParamInfoGetParamInfoget_param_info returns the value TRUE if the
parameters are correct and the helpfiles are available. Otherwise an
exception is raised.
Possible Predecessors
get_keywordsget_keywordsGetKeywordsGetKeywordsGetKeywordsget_keywords,
search_operatorsearch_operatorSearchOperatorSearchOperatorSearchOperatorsearch_operator
Alternatives
get_param_namesget_param_namesGetParamNamesGetParamNamesGetParamNamesget_param_names,
get_param_numget_param_numGetParamNumGetParamNumGetParamNumget_param_num,
get_param_typesget_param_typesGetParamTypesGetParamTypesGetParamTypesget_param_types
See also
query_param_infoquery_param_infoQueryParamInfoQueryParamInfoQueryParamInfoquery_param_info,
get_operator_infoget_operator_infoGetOperatorInfoGetOperatorInfoGetOperatorInfoget_operator_info,
get_operator_nameget_operator_nameGetOperatorNameGetOperatorNameGetOperatorNameget_operator_name
Module
Foundation