query_aop_infoQueryAopInfoQueryAopInfoquery_aop_infoT_query_aop_info

HALCON ScriptCpp++.NETPythonC

Short description

query_aop_infoQueryAopInfoQueryAopInfoquery_aop_infoT_query_aop_info — Query indexing structure of AOP information for operators.

Signature

query_aop_info( string OperatorName, string IndexName, string IndexValue, out string Name, out string Value )void QueryAopInfo( const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, HTuple* Name, HTuple* Value )static void HOperatorSet.QueryAopInfo( HTuple operatorName, HTuple indexName, HTuple indexValue, out HTuple name, out HTuple value )def query_aop_info( operator_name: Union[str, int], index_name: MaybeSequence[Union[str, int]], index_value: MaybeSequence[Union[str, int]] ) -> Tuple[Sequence[str], Sequence[str]]

Herror T_query_aop_info( const Htuple OperatorName, const Htuple IndexName, const Htuple IndexValue, Htuple* Name, Htuple* Value )

static HTuple HSystem::QueryAopInfo( const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, HTuple* Value )

static HTuple HSystem::QueryAopInfo( const HString& OperatorName, const HString& IndexName, const HString& IndexValue, HTuple* Value )

static HTuple HSystem::QueryAopInfo( const char* OperatorName, const char* IndexName, const char* IndexValue, HTuple* Value )

static HTuple HSystem::QueryAopInfo( const wchar_t* OperatorName, const wchar_t* IndexName, const wchar_t* IndexValue, HTuple* Value ) (Windows only)

static HTuple HSystem.QueryAopInfo( HTuple operatorName, HTuple indexName, HTuple indexValue, out HTuple value )

static HTuple HSystem.QueryAopInfo( string operatorName, string indexName, string indexValue, out HTuple value )

Description

HALCON supports a mechanism to adapt the behavior of automatic parallelization of image processing operators (AOP) to the machine’s hardware capability. The information for this adaption can be obtained by the operator optimize_aopOptimizeAop and can be partly read and modified by the operators get_aop_infoGetAopInfo and set_aop_infoSetAopInfo, respectively. To address specific AOP information the operator’s optimization data is indexed within a 3-ary hierarchy that can be obtained by query_aop_infoQueryAopInfo. The three hierarchy stages are indexed by the operator name, the iconic type, and a parameter string value denoting a special mode or method supported by the operator.

If an empty string ''"" is passed to OperatorNameoperatorNameoperator_name, the parameters IndexNameindexNameindex_name and IndexValueindexValueindex_value are ignored and all operator names in Valuevaluevalue are returned, for which optimization data is stored. Namenamename contains the index identifier 'operator'"operator" as many times as operator names are returned. Specifying a single operator name in OperatorNameoperatorNameoperator_name and passing an empty string ''"" to the parameters IndexNameindexNameindex_name and IndexValueindexValueindex_value queries all iconic types the operator holds optimization data for. Valuevaluevalue contains the type strings, Namenamename the index identifier 'iconic_type'"iconic_type", respectively. Finally, when specifying a certain operator in OperatorNameoperatorNameoperator_name and a specific iconic type by passing the dimension identifier 'iconic_type'"iconic_type" to IndexNameindexNameindex_name and the specific iconic type to IndexValueindexValueindex_value, Namenamename contains the parameter index identifier Valuevaluevalue holds the parameter string values supported by the operator. The format of the parameter identifier string is compound containing the string parameter, followed by a colon separator : and a digit, denoting the parameter index (starting with 1). If the operator does not support any mode parameter or the operator’s parameter values were not varied during optimization process of optimize_aopOptimizeAop the string 'parameter:0'"parameter:0" is returned for Namenamename and Valuevaluevalue contains an empty string. In case no AOP information is stored for the specified index, Namenamename returns an empty string.

Execution information

Execution information

• Multithreading type: exclusive (runs in parallel only with independent operators).

• Multithreading scope: global (may be called from any thread).

Parameters

OperatorNameoperatorNameoperator_name (input_control) string → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)Union[str, int]Htuple (char* / Hlong)

Operator to get information for

Default: ''""

IndexNameindexNameindex_name (input_control) string(-array) → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)MaybeSequence[Union[str, int]]Htuple (char* / Hlong)

Further specific index

Default: ''""
Suggested values: '', 'iconic_type'"", "iconic_type"

IndexValueindexValueindex_value (input_control) string(-array) → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)MaybeSequence[Union[str, int]]Htuple (char* / Hlong)

Further specific address

Number of elements: IndexName == IndexValue
Default: ''""
Suggested values: '', 'byte', 'int1', 'int2', 'uint2', 'int4', 'int8', 'direction', 'cyclic', 'vector_field', 'complex', 'region', 'xld', 'xld_cont', 'xld_poly'"", "byte", "int1", "int2", "uint2", "int4", "int8", "direction", "cyclic", "vector_field", "complex", "region", "xld", "xld_cont", "xld_poly"

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

Name of next index stage

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

Values of next index stage

Result

query_aop_infoQueryAopInfo returns 2 (H_MSG_TRUE) if all parameters are correct. If necessary, an exception is raised.

Module

Foundation