Operator Reference

HALCON Operator Reference / Matching / Correlation-Based
ClassesClasses | | Operators

determine_ncc_model_paramsT_determine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params (Operator)

determine_ncc_model_paramsT_determine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params — Determine the parameters of an NCC model.

Signature

Herror T_determine_ncc_model_params(const Hobject Template, const Htuple NumLevels, const Htuple AngleStart, const Htuple AngleExtent, const Htuple Metric, const Htuple Parameters, Htuple* ParameterName, Htuple* ParameterValue)

void DetermineNccModelParams(const HObject& Template, const HTuple& NumLevels, const HTuple& AngleStart, const HTuple& AngleExtent, const HTuple& Metric, const HTuple& Parameters, HTuple* ParameterName, HTuple* ParameterValue)

static HTuple HNCCModel::DetermineNccModelParams(const HImage& Template, const HTuple& NumLevels, double AngleStart, double AngleExtent, const HString& Metric, const HTuple& Parameters, HTuple* ParameterValue)

static HTuple HNCCModel::DetermineNccModelParams(const HImage& Template, Hlong NumLevels, double AngleStart, double AngleExtent, const HString& Metric, const HString& Parameters, HTuple* ParameterValue)

static HTuple HNCCModel::DetermineNccModelParams(const HImage& Template, Hlong NumLevels, double AngleStart, double AngleExtent, const char* Metric, const char* Parameters, HTuple* ParameterValue)

static HTuple HNCCModel::DetermineNccModelParams(const HImage& Template, Hlong NumLevels, double AngleStart, double AngleExtent, const wchar_t* Metric, const wchar_t* Parameters, HTuple* ParameterValue)   ( Windows only)

static void HOperatorSet.DetermineNccModelParams(HObject template, HTuple numLevels, HTuple angleStart, HTuple angleExtent, HTuple metric, HTuple parameters, out HTuple parameterName, out HTuple parameterValue)

static HTuple HNCCModel.DetermineNccModelParams(HImage template, HTuple numLevels, double angleStart, double angleExtent, string metric, HTuple parameters, out HTuple parameterValue)

static HTuple HNCCModel.DetermineNccModelParams(HImage template, int numLevels, double angleStart, double angleExtent, string metric, string parameters, out HTuple parameterValue)

def determine_ncc_model_params(template: HObject, num_levels: Union[int, str], angle_start: float, angle_extent: float, metric: str, parameters: MaybeSequence[str]) -> Tuple[Sequence[str], Sequence[Union[int, float]]]

Description

determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params determines certain parameters of an NCC model automatically from the model image TemplateTemplateTemplatetemplatetemplate. The parameters to be determined can be specified with ParametersParametersParametersparametersparameters. determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params can be used to determine the same parameters that are determined automatically when the respective parameter in create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelcreate_ncc_model is set to 'auto'"auto""auto""auto""auto": the number of pyramid levels (ParametersParametersParametersparametersparameters = 'num_levels'"num_levels""num_levels""num_levels""num_levels") and/or the angle step length (ParametersParametersParametersparametersparameters = 'angle_step'"angle_step""angle_step""angle_step""angle_step"). By passing a tuple of the above values in ParametersParametersParametersparametersparameters, an arbitrary combination of these parameters can be determined. If all of the above parameters should be determined, the value 'all'"all""all""all""all" can be passed.

determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params is mainly useful to determine the above parameters before creating the model, e.g., in an interactive system, which makes suggestions for these parameters to the user, but enables the user to modify the suggested values.

The automatically determined parameters are returned as a name-value pair in ParameterNameParameterNameParameterNameparameterNameparameter_name and ParameterValueParameterValueParameterValueparameterValueparameter_value. The parameter names in ParameterNameParameterNameParameterNameparameterNameparameter_name are identical to the names in ParametersParametersParametersparametersparameters, where, of course, the value 'all'"all""all""all""all" is replaced by the actual parameter names.

The input parameters (NumLevelsNumLevelsNumLevelsnumLevelsnum_levels, AngleStartAngleStartAngleStartangleStartangle_start, AngleExtentAngleExtentAngleExtentangleExtentangle_extent, and MetricMetricMetricmetricmetric) have the same meaning as in create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelcreate_ncc_model. The description of these parameters can be looked up with this operator. These parameters are used by determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params to calculate the parameters to be determined in the same manner as in create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelcreate_ncc_model.

Note that in determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params the input parameter NumLevelsNumLevelsNumLevelsnumLevelsnum_levels can also be determined automatically. If this parameter should not be determined automatically, i.e., the name is not passed in ParametersParametersParametersparametersparameters, the parameter must contain a valid value and must not be set to 'auto'"auto""auto""auto""auto". In contrast, if the maximum number of pyramid levels is to be determined automatically, i.e., ParametersParametersParametersparametersparameters contains the value 'num_levels'"num_levels""num_levels""num_levels""num_levels", you can let HALCON determine a suitable value and at the same time specify an upper boundary:

If the maximum number of pyramid levels should be specified in advance, the input parameter NumLevelsNumLevelsNumLevelsnumLevelsnum_levels can be set to the particular value. If in this case ParametersParametersParametersparametersparameters contains the value 'num_levels'"num_levels""num_levels""num_levels""num_levels", the computed number of pyramid levels is at most NumLevelsNumLevelsNumLevelsnumLevelsnum_levels. If NumLevelsNumLevelsNumLevelsnumLevelsnum_levels is set to 'auto'"auto""auto""auto""auto" or 0, the number of pyramid levels is determined without restrictions as large as possible.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

TemplateTemplateTemplatetemplatetemplate (input_object)  singlechannelimage → objectHImageHObjectHObjectHobject (byte / uint2)

Input image whose domain will be used to create the model.

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

Maximum number of pyramid levels.

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

List of values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 'auto'"auto""auto""auto""auto"

AngleStartAngleStartAngleStartangleStartangle_start (input_control)  angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Smallest rotation of the model.

Default: -0.39

Suggested values: -3.14, -1.57, -0.79, -0.39, -0.20, 0.0

AngleExtentAngleExtentAngleExtentangleExtentangle_extent (input_control)  angle.rad → HTuplefloatHTupleHtuple (real) (double) (double) (double)

Extent of the rotation angles.

Default: 0.79

Suggested values: 6.29, 3.14, 1.57, 0.79, 0.39

Restriction: AngleExtent >= 0

MetricMetricMetricmetricmetric (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Match metric.

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

List of values: 'ignore_global_polarity'"ignore_global_polarity""ignore_global_polarity""ignore_global_polarity""ignore_global_polarity", 'use_polarity'"use_polarity""use_polarity""use_polarity""use_polarity"

ParametersParametersParametersparametersparameters (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameters to be determined automatically.

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

List of values: 'all'"all""all""all""all", 'angle_step'"angle_step""angle_step""angle_step""angle_step", 'num_levels'"num_levels""num_levels""num_levels""num_levels"

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

Name of the automatically determined parameter.

ParameterValueParameterValueParameterValueparameterValueparameter_value (output_control)  number-array → HTupleSequence[Union[int, float]]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)

Value of the automatically determined parameter.

Result

If the parameters are valid, the operator determine_ncc_model_paramsdetermine_ncc_model_paramsDetermineNccModelParamsDetermineNccModelParamsdetermine_ncc_model_params returns the value 2 ( H_MSG_TRUE) .

Possible Successors

create_ncc_modelcreate_ncc_modelCreateNccModelCreateNccModelcreate_ncc_model

See also

find_ncc_modelfind_ncc_modelFindNccModelFindNccModelfind_ncc_model

Module

Matching

ClassesClasses | | Operators