clear_deformable_modelT_clear_deformable_modelClearDeformableModelClearDeformableModel (Operator)

Name

clear_deformable_modelT_clear_deformable_modelClearDeformableModelClearDeformableModel — Free the memory of a deformable model.

Signature

clear_deformable_model( : : ModelID : )

Description

The operator clear_deformable_modelclear_deformable_modelClearDeformableModelClearDeformableModelClearDeformableModel frees the memory of a deformable model that was created by create_planar_uncalib_deformable_modelcreate_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModel or create_planar_calib_deformable_modelcreate_planar_calib_deformable_modelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModel. After calling clear_deformable_modelclear_deformable_modelClearDeformableModelClearDeformableModelClearDeformableModel, the deformable model can no longer be used. The handle ModelIDModelIDModelIDModelIDmodelID becomes invalid.

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) deformable_model(-array) → (handle)

Handle of the model.

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

Module

Matching

Operators