set_shape_model_paramT_set_shape_model_paramSetShapeModelParamSetShapeModelParam (Operator)

Name

set_shape_model_paramT_set_shape_model_paramSetShapeModelParamSetShapeModelParam — Set selected parameters of the shape model.

Signature

set_shape_model_param( : : ModelID, GenParamName, GenParamValue : )

Description

The operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParam sets the selected parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamName in the shape model ModelIDModelIDModelIDModelIDmodelID. The following parameters can be modified:

'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 ModelIDModelIDModelIDModelIDmodelID. Thereby, the value of 'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast" that was originally set, e.g. with create_shape_modelcreate_shape_modelCreateShapeModelCreateShapeModelCreateShapeModel, is overwritten for the shape model ModelIDModelIDModelIDModelIDmodelID. Note that if the shape model ModelIDModelIDModelIDModelIDmodelID was read from file and if this file should be changed as well, the shape model ModelIDModelIDModelIDModelIDmodelID must again be written to file after the execution of the operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParam.

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

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

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

This parameter determines whether the shape model ModelIDModelIDModelIDModelIDmodelID to be found with, e.g., find_shape_modelfind_shape_modelFindShapeModelFindShapeModelFindShapeModel, 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" can be 'true'"true""true""true""true", 'false'"false""false""false""false", or 'system'"system""system""system""system". The value 'system'"system""system""system""system" is the default behavior and uses the system-wide used value that was set by set_systemset_systemSetSystemSetSystemSetSystem for the parameter 'border_shape_models'"border_shape_models""border_shape_models""border_shape_models""border_shape_models".

Execution Information

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

This operator modifies the state of the following input parameter:

ModelIDModelIDModelIDModelIDmodelID

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

ModelIDModelIDModelIDModelIDmodelID (input_control, state is modified) shape_model → (handle)

Handle of the model.

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) attribute.name-array → (string)

Parameter names.

List of values: '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", 'timeout'"timeout""timeout""timeout""timeout"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control) attribute.value-array → (real / integer / string)

Parameter values.

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

Result

If the parameters are valid, the operator set_shape_model_paramset_shape_model_paramSetShapeModelParamSetShapeModelParamSetShapeModelParam returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.