set_shape_model_param — Set selected parameters of the shape model.
set_shape_model_param sets the selected parameters
GenParamName in the shape model
ModelID. The following
parameters can be modified:
Sets the minimum contrast of the object in the search images for the shape
Thereby, the value of 'min_contrast' that was originally set,
create_shape_model, is overwritten for the shape model
ModelID. Note that if the shape model
ModelID was read from
file and if this file should be changed as well, the shape model
ModelID must again be written to file after the execution of the
Sets the maximum runtime of the operators used to find the shape model
find_shape_model). This is especially useful
in cases where a maximum cycle time has to be ensured. The 'timeout'
must be given in milliseconds. The temporal accuracy depends on several
factors including the size of the model, the speed of your computer, and
the 'timer_mode' set via
set_system. Be aware that the
runtime of the search increases by up to 10 percent with activated timeout.
To disable the timeout you can either use a negative value or
This parameter determines whether the shape model
ModelID to be
found with, e.g.,
find_shape_model, may lie partially outside the
image (i.e., whether they may cross the image border).
The value of 'border_shape_models' can be 'true',
'false', or 'system'. The value 'system'
is the default behavior and uses the system-wide used value that was set by
set_system for the parameter 'border_shape_models'.
Disables or enables the use of clutter parameters for the shape model
ModelID, which have been set previously using
set_shape_model_clutter. The value of 'use_clutter' can be
'true' or 'false'. Note that the value of
'use_clutter' affects the expected number of entries in the input
MinScore of the find operators. Please refer to the
documentation of the different find operators, e.g.,
For newly created shape models, the use of clutter parameters is disabled.
set_shape_model_clutter, the use of clutter parameters is
enabled. Clutter parameters and the value of 'use_clutter' can be
Disables or enables the use of an internal cache based on temporary memory
that is used by a shape model when it executes, e.g.,
The size of the cache depends on whether the find operation needs a big search space
with many discretization steps. This means that a small
ScaleStep and a big
AngleExtent and a big range given by
ScaleMax result in a
big memory consumption. Switching the 'model_cache' off (by setting 'false')
sometimes results in slightly longer execution times but constantly small memory
footprint, particularly important in embedded applications. By default, this cache is
switched on ('true').
This operator modifies the state of the following input parameter:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
ModelID(input_control, state is modified) shape_model
Handle of the model.
List of values: 'border_shape_models', 'min_contrast', 'model_cache', 'timeout', 'use_clutter'
→(real / integer / string)
List of values: 'false', 'system', 'true'
If the parameters are valid, the operator
returns the value TRUE. If necessary an exception is raised.