ClassesClassesClassesClasses | | | | Operators

query_aop_infoT_query_aop_infoQueryAopInfoquery_aop_infoQueryAopInfoQueryAopInfo (Operator)

Name

query_aop_infoT_query_aop_infoQueryAopInfoquery_aop_infoQueryAopInfoQueryAopInfo — 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)

Herror 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)

void HOperatorSetX.QueryAopInfo(
[in] VARIANT OperatorName, [in] VARIANT IndexName, [in] VARIANT IndexValue, [out] VARIANT* Name, [out] VARIANT* Value)

VARIANT HSystemX.QueryAopInfo(
[in] VARIANT OperatorName, [in] VARIANT IndexName, [in] VARIANT IndexValue, [out] VARIANT* Value)

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)

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_aopOptimizeAopoptimize_aopOptimizeAopOptimizeAop and can be partly read and modified by the operators get_aop_infoget_aop_infoGetAopInfoget_aop_infoGetAopInfoGetAopInfo and set_aop_infoset_aop_infoSetAopInfoset_aop_infoSetAopInfoSetAopInfo, 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_infoQueryAopInfoquery_aop_infoQueryAopInfoQueryAopInfo. 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 OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName, the parameters IndexNameIndexNameIndexNameIndexNameIndexNameindexName and IndexValueIndexValueIndexValueIndexValueIndexValueindexValue are ignored and all operator names in ValueValueValueValueValuevalue are returned, for which optimization data is stored. NameNameNameNameNamename contains the index identifier 'operator'"operator""operator""operator""operator""operator" as many times as operator names are returned. Specifying a single operator name in OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName and passing an empty string ''"""""""""" to the parameters IndexNameIndexNameIndexNameIndexNameIndexNameindexName and IndexValueIndexValueIndexValueIndexValueIndexValueindexValue queries all iconic types the operator holds optimization data for. ValueValueValueValueValuevalue contains the type strings, NameNameNameNameNamename the index identifier 'iconic_type'"iconic_type""iconic_type""iconic_type""iconic_type""iconic_type", respectively. Finally, when specifying a certain operator in OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName and a specific iconic type by passing the dimension identifier 'iconic_type'"iconic_type""iconic_type""iconic_type""iconic_type""iconic_type" to IndexNameIndexNameIndexNameIndexNameIndexNameindexName and the specific iconic type to IndexValueIndexValueIndexValueIndexValueIndexValueindexValue, NameNameNameNameNamename contains the parameter index identifier ValueValueValueValueValuevalue holds the parameter string values supported by the operator. The format of the parameter identifier string is compound containing the string 'parameter'"parameter""parameter""parameter""parameter""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_aopOptimizeAopoptimize_aopOptimizeAopOptimizeAop the string 'parameter:0'"parameter:0""parameter:0""parameter:0""parameter:0""parameter:0" is returned for NameNameNameNameNamename and ValueValueValueValueValuevalue contains an empty string. In case no AOP information is stored for the specified index, NameNameNameNameNamename returns an empty string.

Parallelization

Parameters

OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

Operator to get information for

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

IndexNameIndexNameIndexNameIndexNameIndexNameindexName (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

Further specific index

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

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

IndexValueIndexValueIndexValueIndexValueIndexValueindexValue (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

Further specific address

Number of elements: IndexName == IndexValue

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

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

NameNameNameNameNamename (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Name of next index stage

ValueValueValueValueValuevalue (output_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Values of next index stage

Result

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

Module

Foundation


ClassesClassesClassesClasses | | | | Operators