Skip to content

clear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_modelT_clear_deformable_model🔗

Short description🔗

clear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_modelT_clear_deformable_model — Free the memory of a deformable model.

Signature🔗

clear_deformable_model( deformable_model ModelID )void ClearDeformableModel( const HTuple& ModelID )static void HOperatorSet.ClearDeformableModel( HTuple modelID )def clear_deformable_model( model_id: MaybeSequence[HHandle] ) -> None

Herror T_clear_deformable_model( const Htuple ModelID )

static void HDeformableModel::ClearDeformableModel( const HDeformableModelArray& ModelID )

void HDeformableModel::ClearDeformableModel( ) const

static void HDeformableModel.ClearDeformableModel( HDeformableModel[] modelID )

void HDeformableModel.ClearDeformableModel( )

Description🔗

The operator clear_deformable_modelClearDeformableModel frees the memory of a deformable model that was created by create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel or create_planar_calib_deformable_modelCreatePlanarCalibDeformableModel. After calling clear_deformable_modelClearDeformableModel, the deformable model can no longer be used. The handle ModelIDmodelIDmodel_id becomes invalid.

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.

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🔗

ModelIDmodelIDmodel_id (input_control, state is modified) deformable_model(-array) → (handle)HTuple (HHandle)HDeformableModel, HTuple (IntPtr)MaybeSequence[HHandle]Htuple (handle)

Handle of the model.

Result🔗

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

Combinations with other operators🔗

Combinations

See also

create_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModel, create_planar_calib_deformable_modelCreatePlanarCalibDeformableModel, create_local_deformable_modelCreateLocalDeformableModel

Module🔗

Matching