ClassesClassesClassesClasses | | | | Operators

get_aop_infoT_get_aop_infoGetAopInfoget_aop_infoGetAopInfoGetAopInfo (Operator)

Name

get_aop_infoT_get_aop_infoGetAopInfoget_aop_infoGetAopInfoGetAopInfo — Return AOP information for operators.

Signature

get_aop_info( : : OperatorName, IndexName, IndexValue, InfoName : InfoValue)

Herror T_get_aop_info(const Htuple OperatorName, const Htuple IndexName, const Htuple IndexValue, const Htuple InfoName, Htuple* InfoValue)

Herror get_aop_info(const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const HTuple& InfoName, char* InfoValue)

Herror get_aop_info(const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const HTuple& InfoName, HTuple* InfoValue)

void GetAopInfo(const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const HTuple& InfoName, HTuple* InfoValue)

static HTuple HSystem::GetAopInfo(const HTuple& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const HString& InfoName)

static HString HSystem::GetAopInfo(const HString& OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const HString& InfoName)

static HString HSystem::GetAopInfo(const char* OperatorName, const HTuple& IndexName, const HTuple& IndexValue, const char* InfoName)

void HOperatorSetX.GetAopInfo(
[in] VARIANT OperatorName, [in] VARIANT IndexName, [in] VARIANT IndexValue, [in] VARIANT InfoName, [out] VARIANT* InfoValue)

VARIANT HSystemX.GetAopInfo(
[in] VARIANT OperatorName, [in] VARIANT IndexName, [in] VARIANT IndexValue, [in] BSTR InfoName)

static void HOperatorSet.GetAopInfo(HTuple operatorName, HTuple indexName, HTuple indexValue, HTuple infoName, out HTuple infoValue)

static HTuple HSystem.GetAopInfo(HTuple operatorName, HTuple indexName, HTuple indexValue, string infoName)

static string HSystem.GetAopInfo(string operatorName, HTuple indexName, HTuple indexValue, string infoName)

Description

HALCON supports a mechanism to optimize the behavior of automatic operator parallelization (AOP) for a given hardware of a machine. The information for this optimization can be determined by the operator optimize_aopoptimize_aopOptimizeAopoptimize_aopOptimizeAopOptimizeAop and can also be partly modified by the operator set_aop_infoset_aop_infoSetAopInfoset_aop_infoSetAopInfoSetAopInfo.

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, passed in OperatorNameOperatorNameOperatorNameOperatorNameOperatorNameoperatorName, the iconic type, and a parameter string value denoting a special mode or method supported by the indexed operator. The latter two indices are passed by IndexNameIndexNameIndexNameIndexNameIndexNameindexName and IndexValueIndexValueIndexValueIndexValueIndexValueindexValue. IndexNameIndexNameIndexNameIndexNameIndexNameindexName holds the dimension identifier whereas IndexValueIndexValueIndexValueIndexValueIndexValueindexValue holds the index value as retured in query_aop_infoquery_aop_infoQueryAopInfoquery_aop_infoQueryAopInfoQueryAopInfo.

get_aop_infoget_aop_infoGetAopInfoget_aop_infoGetAopInfoGetAopInfo returns the specific information parts of an operator's AOP knowledge in InfoValueInfoValueInfoValueInfoValueInfoValueinfoValue if exactly one index per stage was set. The scope of information is specified by InfoNameInfoNameInfoNameInfoNameInfoNameinfoName and supports following values:

'max_threads'"max_threads""max_threads""max_threads""max_threads""max_threads"

returns the maximum allowed thread number. If no optimization data is stored, InfoValueInfoValueInfoValueInfoValueInfoValueinfoValue contains -1. In case the specified operator does not support automatic parallelization, 1 is returned.

'split_level'"split_level""split_level""split_level""split_level""split_level"

returns all allowed data split levels of the automatic parallelization for this operator, the specified iconic type and parameter value. Possible levels are 'split_tuple'"split_tuple""split_tuple""split_tuple""split_tuple""split_tuple", 'split_channel'"split_channel""split_channel""split_channel""split_channel""split_channel", 'split_domain'"split_domain""split_domain""split_domain""split_domain""split_domain", and 'split_partial'"split_partial""split_partial""split_partial""split_partial""split_partial". If no split level is supported or every level was switched off for the indexed operator an empty string ''"""""""""" is returned. Use get_operator_infoget_operator_infoGetOperatorInfoget_operator_infoGetOperatorInfoGetOperatorInfo to query all split levels generally supported by an operator.

'model'"model""model""model""model""model"

returns the stored model type. Possible values are 'threshold'"threshold""threshold""threshold""threshold""threshold", 'linear'"linear""linear""linear""linear""linear", and 'mlp'"mlp""mlp""mlp""mlp""mlp" (see also the description of operator optimize_aopoptimize_aopOptimizeAopoptimize_aopOptimizeAopOptimizeAop). If no optimization data is stored, an empty string is returned.

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

Suggested values: 'mean_image'"mean_image""mean_image""mean_image""mean_image""mean_image", 'opening_circle'"opening_circle""opening_circle""opening_circle""opening_circle""opening_circle", 'find_shape_model'"find_shape_model""find_shape_model""find_shape_model""find_shape_model""find_shape_model"

IndexNameIndexNameIndexNameIndexNameIndexNameindexName (input_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Further index stages

Default value: ['iconic_type','parameter:0'] ["iconic_type","parameter:0"] ["iconic_type","parameter:0"] ["iconic_type","parameter:0"] ["iconic_type","parameter:0"] ["iconic_type","parameter:0"]

IndexValueIndexValueIndexValueIndexValueIndexValueindexValue (input_control)  string-array HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Further index values

Number of elements: IndexName == IndexValue

Default value: ['byte',''] ["byte",""] ["byte",""] ["byte",""] ["byte",""] ["byte",""]

InfoNameInfoNameInfoNameInfoNameInfoNameinfoName (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Scope of information

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

Suggested values: 'max_threads'"max_threads""max_threads""max_threads""max_threads""max_threads", 'split_level'"split_level""split_level""split_level""split_level""split_level", 'model'"model""model""model""model""model"

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

Value of information

Result

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

Module

Foundation


ClassesClassesClassesClasses | | | | Operators