Skip to content

get_param_infoGetParamInfoGetParamInfoget_param_infoget_param_info🔗

Short description🔗

get_param_infoGetParamInfoGetParamInfoget_param_infoget_param_info — Get information concerning the operator parameters.

Signature🔗

get_param_info( proc_name OperatorName, string ParamName, string Slot, out string Information )void GetParamInfo( const HTuple& OperatorName, const HTuple& ParamName, const HTuple& Slot, HTuple* Information )static void HOperatorSet.GetParamInfo( HTuple operatorName, HTuple paramName, HTuple slot, out HTuple information )def get_param_info( operator_name: str, param_name: str, slot: str ) -> Sequence[str]

def get_param_info_s( operator_name: str, param_name: str, slot: str ) -> strHerror get_param_info( const char* OperatorName, const char* ParamName, const char* Slot, char* Information )

Herror T_get_param_info( const Htuple OperatorName, const Htuple ParamName, const Htuple Slot, Htuple* Information )

static HTuple HInfo::GetParamInfo( const HString& OperatorName, const HString& ParamName, const HString& Slot )

static HTuple HInfo::GetParamInfo( const char* OperatorName, const char* ParamName, const char* Slot )

static HTuple HInfo::GetParamInfo( const wchar_t* OperatorName, const wchar_t* ParamName, const wchar_t* Slot ) (Windows only)

static HTuple HInfo.GetParamInfo( string operatorName, string paramName, string slot )

Description🔗

The operator get_param_infoGetParamInfo is used for calling up the online-texts assigned to a parameter of an indicated operator. The form of information available for each parameter (Slotslotslot), can be called up by using the operator query_param_infoQueryParamInfo. 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 of the parameter.

  • 'parameter_class'"parameter_class": Parameter classes.

    'input_object'"input_object"

    'output_object'"output_object"

    'input_control'"input_control"

    'output_control'"output_control"

  • 'type_list'"type_list": Permitted type(s) of data for parameter values.

  • '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" is indicated, the “tuple mode” must be used.

  • '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 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": 'true'"true", if the operator modifies this input parameter.

  • 'multivalue'"multivalue": 'true'"true", if an array of values must be passed,

    'false'"false", if exactly one value must be passed, and

    'optional'"optional" allows both.

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

  • 'multiinstance'"multiinstance": 'true'"true", if an array of semantic tuples (e.g., poses, camera parameters, etc.) must be passed,

    'false'"false", if exactly one semantic tuple must be passed, and

    'optional'"optional" allows both.

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

  • 'values'"values": Selection of values (optional).

  • '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": Minimum value of a value interval.

  • 'valuemax'"valuemax": Maximum value of a value interval.

  • 'valuefunction'"valuefunction": Function describing the course of the values for a series of tests (lin, log, quadr, …).

  • 'steprec'"steprec": Recommended step width for the parameter values in a series of tests.

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

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

  • '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_systemGetSystem and set_systemSetSystem).

Attention🔗

The encoding of the result is UTF-8.

Execution information🔗

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🔗

OperatorNameoperatorNameoperator_name (input_control) proc_name → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the operator on whose parameter more information is needed.

Default: 'get_param_info'"get_param_info"

ParamNameparamNameparam_name (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Name of the parameter on which more information is needed.

Default: 'Slot'"Slot"

Slotslotslot (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Desired information.

Default: 'description'"description"
List of values: 'assertion', 'cd_type_list.opencl', 'cd_value_list.opencl', 'default_type', 'default_value', 'description', 'mixed_type', 'modified', 'multichannel', 'multivalue', 'sem_type', 'step_min', 'step_rec', 'type_list', 'value_function', 'value_list', 'value_max', 'value_min', 'value_number', 'values'"assertion", "cd_type_list.opencl", "cd_value_list.opencl", "default_type", "default_value", "description", "mixed_type", "modified", "multichannel", "multivalue", "sem_type", "step_min", "step_rec", "type_list", "value_function", "value_list", "value_max", "value_min", "value_number", "values"

Informationinformationinformation (output_control) string(-array) → (string)HTuple (HString)HTuple (string)Sequence[str]Htuple (char*)

Information (empty in case there is no information available).

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

get_keywordsGetKeywords, search_operatorSearchOperator

Alternatives

get_param_namesGetParamNames, get_param_numGetParamNum, get_param_typesGetParamTypes

See also

query_param_infoQueryParamInfo, get_operator_infoGetOperatorInfo, get_operator_nameGetOperatorName

Module🔗

Foundation