Operator Reference

HALCON Operator Reference / System / Parallelization

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

query_aop_infoT_query_aop_infoQueryAopInfoQueryAopInfoquery_aop_info (Operator)

query_aop_infoT_query_aop_infoQueryAopInfoQueryAopInfoquery_aop_info — Query indexing structure of AOP information for operators.

Signature

query_aop_info( : : OperatorName, IndexName, IndexValue : Name, Value)

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

void QueryAopInfo(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 void HOperatorSet.QueryAopInfo(HTuple operatorName, HTuple indexName, HTuple indexValue, out HTuple name, out HTuple value)

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)

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]]

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_aopoptimize_aopOptimizeAopOptimizeAopoptimize_aop and can be partly read and modified by the operators get_aop_infoget_aop_infoGetAopInfoGetAopInfoget_aop_info and set_aop_infoset_aop_infoSetAopInfoSetAopInfoset_aop_info, 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_infoquery_aop_infoQueryAopInfoQueryAopInfoquery_aop_info. 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 OperatorNameOperatorNameOperatorNameoperatorNameoperator_name, the parameters IndexNameIndexNameIndexNameindexNameindex_name and IndexValueIndexValueIndexValueindexValueindex_value are ignored and all operator names in ValueValueValuevaluevalue are returned, for which optimization data is stored. NameNameNamenamename contains the index identifier 'operator'"operator""operator""operator""operator" as many times as operator names are returned. Specifying a single operator name in OperatorNameOperatorNameOperatorNameoperatorNameoperator_name and passing an empty string ''"""""""" to the parameters IndexNameIndexNameIndexNameindexNameindex_name and IndexValueIndexValueIndexValueindexValueindex_value queries all iconic types the operator holds optimization data for. ValueValueValuevaluevalue contains the type strings, NameNameNamenamename the index identifier 'iconic_type'"iconic_type""iconic_type""iconic_type""iconic_type", respectively. Finally, when specifying a certain operator in OperatorNameOperatorNameOperatorNameoperatorNameoperator_name and a specific iconic type by passing the dimension identifier 'iconic_type'"iconic_type""iconic_type""iconic_type""iconic_type" to IndexNameIndexNameIndexNameindexNameindex_name and the specific iconic type to IndexValueIndexValueIndexValueindexValueindex_value, NameNameNamenamename contains the parameter index identifier ValueValueValuevaluevalue 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_aopoptimize_aopOptimizeAopOptimizeAopoptimize_aop the string 'parameter:0'"parameter:0""parameter:0""parameter:0""parameter:0" is returned for NameNameNamenamename and ValueValueValuevaluevalue contains an empty string. In case no AOP information is stored for the specified index, NameNameNamenamename returns an empty string.

Execution Information

• Multithreading type: exclusive (runs in parallel only with independent operators).
• Multithreading scope: local (may only be called from the same thread in which the window, model, or tool instance was created).
• Processed without parallelization.

Parameters

OperatorNameOperatorNameOperatorNameoperatorNameoperator_name (input_control)  string → HTupleUnion[str, int]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Operator to get information for

Default: '' "" "" "" ""

IndexNameIndexNameIndexNameindexNameindex_name (input_control)  string(-array) → HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Further specific index

Default: '' "" "" "" ""

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

IndexValueIndexValueIndexValueindexValueindex_value (input_control)  string(-array) → HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Further specific address

Number of elements: IndexName == IndexValue

Default: '' "" "" "" ""

Suggested values: ''"""""""", 'byte'"byte""byte""byte""byte", 'int1'"int1""int1""int1""int1", 'int2'"int2""int2""int2""int2", 'uint2'"uint2""uint2""uint2""uint2", 'int4'"int4""int4""int4""int4", 'int8'"int8""int8""int8""int8", 'direction'"direction""direction""direction""direction", 'cyclic'"cyclic""cyclic""cyclic""cyclic", 'vector_field'"vector_field""vector_field""vector_field""vector_field", 'complex'"complex""complex""complex""complex", 'region'"region""region""region""region", 'xld'"xld""xld""xld""xld", 'xld_cont'"xld_cont""xld_cont""xld_cont""xld_cont", 'xld_poly'"xld_poly""xld_poly""xld_poly""xld_poly"

NameNameNamenamename (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Name of next index stage

ValueValueValuevaluevalue (output_control)  string-array → HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Values of next index stage

Result

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

Module

Foundation

---

ClassesClasses | | Operators