get_aop_infoT_get_aop_infoGetAopInfoGetAopInfo (Operator)

Name

get_aop_infoT_get_aop_infoGetAopInfoGetAopInfo — Return AOP information for operators.

Signature

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_aopOptimizeAopOptimizeAopOptimizeAop and can also be partly modified by the operator set_aop_infoset_aop_infoSetAopInfoSetAopInfoSetAopInfo.

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_infoQueryAopInfoQueryAopInfoQueryAopInfo. The three hierarchy stages are indexed by the operator name, passed in OperatorNameOperatorNameOperatorNameOperatorNameoperatorName, 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 IndexNameIndexNameIndexNameIndexNameindexName and IndexValueIndexValueIndexValueIndexValueindexValue. IndexNameIndexNameIndexNameIndexNameindexName holds the dimension identifier whereas IndexValueIndexValueIndexValueIndexValueindexValue holds the index value as retured in query_aop_infoquery_aop_infoQueryAopInfoQueryAopInfoQueryAopInfo.

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

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

returns the maximum allowed thread number. If no optimization data is stored, InfoValueInfoValueInfoValueInfoValueinfoValue 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"

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_channel'"split_channel""split_channel""split_channel""split_channel", 'split_domain'"split_domain""split_domain""split_domain""split_domain", and '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_infoGetOperatorInfoGetOperatorInfoGetOperatorInfo to query all split levels generally supported by an operator.

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

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

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

Result

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

Module

Foundation