set_shape_model_paramT_set_shape_model_paramSetShapeModelParamSetShapeModelParamset_shape_model_param (Operator)

Name

set_shape_model_paramT_set_shape_model_paramSetShapeModelParamSetShapeModelParamset_shape_model_param — Set selected parameters of the shape model.

Signature

set_shape_model_param( : : ModelID, GenParamName, GenParamValue : )

Herror T_set_shape_model_param(const Htuple ModelID, const Htuple GenParamName, const Htuple GenParamValue)

void SetShapeModelParam(const HTuple& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue)

void HShapeModel::SetShapeModelParam(const HTuple& GenParamName, const HTuple& GenParamValue) const

static void HImage::SetShapeModelParam(const HShapeModel& ModelID, const HTuple& GenParamName, const HTuple& GenParamValue)

static void HOperatorSet.SetShapeModelParam(HTuple modelID, HTuple genParamName, HTuple genParamValue)

void HShapeModel.SetShapeModelParam(HTuple genParamName, HTuple genParamValue)

static void HImage.SetShapeModelParam(HShapeModel modelID, HTuple genParamName, HTuple genParamValue)

def set_shape_model_param(model_id: HHandle, gen_param_name: Sequence[str], gen_param_value: Sequence[Union[float, int, str]]) -> None

Description

The operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParamset_shape_model_param sets the selected parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name in the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id. The following parameters can be modified:

'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast""min_contrast"

Sets the minimum contrast of the object in the search images for the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id. Thereby, the value of 'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast""min_contrast" that was originally set, e.g., with create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModelcreate_shape_model, is overwritten for the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id. Note that if the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id was read from file and if this file should be changed as well, the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id must again be written to file after the execution of the operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParamset_shape_model_param.

'timeout'"timeout""timeout""timeout""timeout""timeout"

Sets the maximum runtime of the operators used to find the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id (e.g., find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model). This is especially useful in cases where a maximum cycle time has to be ensured. The 'timeout'"timeout""timeout""timeout""timeout""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'"timer_mode""timer_mode""timer_mode""timer_mode""timer_mode" set via set_systemset_systemSetSystemSetSystemSetSystemset_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 'false'"false""false""false""false""false".

'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models""border_shape_models"

This parameter determines whether the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id to be found with, e.g., find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model, may lie partially outside the image (i.e., whether they may cross the image border). The value of 'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models""border_shape_models" can be 'true'"true""true""true""true""true", 'false'"false""false""false""false""false", or 'system'"system""system""system""system""system". The value 'system'"system""system""system""system""system" is the default behavior and uses the system-wide used value that was set by set_systemset_systemSetSystemSetSystemSetSystemset_system for the parameter 'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models""border_shape_models".

'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter""use_clutter"

Disables or enables the use of clutter parameters for the shape model ModelIDModelIDModelIDModelIDmodelIDmodel_id, which have been set previously using set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter. The value of 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter""use_clutter" can be 'true'"true""true""true""true""true" or 'false'"false""false""false""false""false". Note that the value of 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter""use_clutter" affects the expected number of entries in the input parameter MinScoreMinScoreMinScoreMinScoreminScoremin_score of the find operators. Please refer to the documentation of the different find operators, e.g., find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model.

For newly created shape models, the use of clutter parameters is disabled. After calling set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter, the use of clutter parameters is enabled. Clutter parameters and the value of 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter""use_clutter" can be queried using get_shape_model_clutterget_shape_model_clutterGetShapeModelClutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter.

'model_cache'"model_cache""model_cache""model_cache""model_cache""model_cache"

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., find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model. 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 AngleStepAngleStepAngleStepAngleStepangleStepangle_step and ScaleStepScaleStepScaleStepScaleStepscaleStepscale_step and a big AngleExtentAngleExtentAngleExtentAngleExtentangleExtentangle_extent and a big range given by ScaleMinScaleMinScaleMinScaleMinscaleMinscale_min and ScaleMaxScaleMaxScaleMaxScaleMaxscaleMaxscale_max result in a big memory consumption. Switching the 'model_cache' off (by setting 'false'"false""false""false""false""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'"true""true""true""true""true").

Execution Information

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.

Parameters

ModelIDModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified)  shape_model HShapeModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  attribute.name-array HTupleSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Parameter names.

List of values: 'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models""border_shape_models", 'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast""min_contrast", 'model_cache'"model_cache""model_cache""model_cache""model_cache""model_cache", 'timeout'"timeout""timeout""timeout""timeout""timeout", 'use_clutter'"use_clutter""use_clutter""use_clutter""use_clutter""use_clutter"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (input_control)  attribute.value-array HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)

Parameter values.

List of values: 'false'"false""false""false""false""false", 'system'"system""system""system""system""system", 'true'"true""true""true""true""true"

Result

If the parameters are valid, the operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParamset_shape_model_param returns the value TRUE. If necessary an exception is raised.

Possible Predecessors

create_shape_model_xldcreate_shape_model_xldCreateShapeModelXldCreateShapeModelXldCreateShapeModelXldcreate_shape_model_xld, create_scaled_shape_model_xldcreate_scaled_shape_model_xldCreateScaledShapeModelXldCreateScaledShapeModelXldCreateScaledShapeModelXldcreate_scaled_shape_model_xld, create_aniso_shape_model_xldcreate_aniso_shape_model_xldCreateAnisoShapeModelXldCreateAnisoShapeModelXldCreateAnisoShapeModelXldcreate_aniso_shape_model_xld

Possible Successors

find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModelfind_shape_model, find_scaled_shape_modelfind_scaled_shape_modelFindScaledShapeModelFindScaledShapeModelFindScaledShapeModelfind_scaled_shape_model, find_aniso_shape_modelfind_aniso_shape_modelFindAnisoShapeModelFindAnisoShapeModelFindAnisoShapeModelfind_aniso_shape_model

See also

create_shape_model_xldcreate_shape_model_xldCreateShapeModelXldCreateShapeModelXldCreateShapeModelXldcreate_shape_model_xld, create_scaled_shape_model_xldcreate_scaled_shape_model_xldCreateScaledShapeModelXldCreateScaledShapeModelXldCreateScaledShapeModelXldcreate_scaled_shape_model_xld, create_aniso_shape_model_xldcreate_aniso_shape_model_xldCreateAnisoShapeModelXldCreateAnisoShapeModelXldCreateAnisoShapeModelXldcreate_aniso_shape_model_xld, set_shape_model_clutterset_shape_model_clutterSetShapeModelClutterSetShapeModelClutterSetShapeModelClutterset_shape_model_clutter, get_shape_model_clutterget_shape_model_clutterGetShapeModelClutterGetShapeModelClutterGetShapeModelClutterget_shape_model_clutter

Module

Matching