determine_ncc_model_params🔗
Short description🔗
determine_ncc_model_params — Determine the parameters of an NCC model.
Signature🔗
determine_ncc_model_params( image Template, integer NumLevels, angle.rad AngleStart, angle.rad AngleExtent, string Metric, string Parameters, out string ParameterName, out number ParameterValue )
Description🔗
determine_ncc_model_params determines certain parameters
of an NCC model automatically from the model image
Template. The parameters to be determined can be specified
with Parameters. determine_ncc_model_params can
be used to determine the same parameters that are determined
automatically when the respective parameter in
create_ncc_model is set to 'auto': the
number of pyramid levels (Parameters \(=\)
'num_levels') and/or the angle step length
(Parameters \(=\) 'angle_step'). By passing a tuple
of the above values in Parameters, an arbitrary combination
of these parameters can be determined. If all of the above
parameters should be determined, the value 'all' can be
passed.
determine_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 ParameterName and ParameterValue. The
parameter names in ParameterName are identical to the names
in Parameters, where, of course, the value 'all'
is replaced by the actual parameter names.
The input parameters (NumLevels, AngleStart,
AngleExtent, and Metric) have the same meaning as
in create_ncc_model. The description of these parameters
can be looked up with this operator. These parameters are used
by determine_ncc_model_params to calculate the parameters
to be determined in the same manner as in create_ncc_model.
Note that in determine_ncc_model_params the input
parameter NumLevels can also be determined automatically.
If this parameter should not be determined automatically, i.e.,
the name is not passed in Parameters, the parameter must
contain a valid value and must not be set to 'auto'. In
contrast, if the maximum number of pyramid levels is to be
determined automatically, i.e., Parameters contains the
value '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 NumLevels can be set to the
particular value. If in this case Parameters contains
the value 'num_levels', the computed number of pyramid
levels is at most NumLevels. If NumLevels is
set to 'auto' or 0, the number of pyramid levels
is determined without restrictions as large as possible.
Execution information🔗
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🔗
Template (input_object) singlechannelimage → object (byte / uint2)
Input image whose domain will be used to create the model.
NumLevels (input_control) integer → (integer / string)
Maximum number of pyramid levels.
Default: 'auto'
List of values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 'auto'
AngleStart (input_control) angle.rad → (real)
Smallest rotation of the model.
Default: -0.39
Suggested values: -3.14, -1.57, -0.79, -0.39, -0.20, 0.0
AngleExtent (input_control) angle.rad → (real)
Extent of the rotation angles.
Default: 0.79
Suggested values: 6.29, 3.14, 1.57, 0.79, 0.39
Restriction: AngleExtent >= 0
Metric (input_control) string → (string)
Match metric.
Default: 'use_polarity'
List of values: 'ignore_global_polarity', 'use_polarity'
Parameters (input_control) string(-array) → (string)
Parameters to be determined automatically.
Default: 'all'
List of values: 'all', 'angle_step', 'num_levels'
ParameterName (output_control) string-array → (string)
Name of the automatically determined parameter.
ParameterValue (output_control) number-array → (real / integer)
Value of the automatically determined parameter.
Result🔗
If the parameters are valid, the operator
determine_ncc_model_params returns the value 2 (H_MSG_TRUE).
Combinations with other operators🔗
Module🔗
Matching