Operator Reference

clear_deformable_modelT_clear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_model (Operator)

clear_deformable_modelT_clear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_model — Free the memory of a deformable model.

Signature

clear_deformable_model( : : ModelID : )

Herror T_clear_deformable_model(const Htuple ModelID)

void ClearDeformableModel(const HTuple& ModelID)

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

void HDeformableModel::ClearDeformableModel() const

static void HOperatorSet.ClearDeformableModel(HTuple modelID)

static void HDeformableModel.ClearDeformableModel(HDeformableModel[] modelID)

void HDeformableModel.ClearDeformableModel()

def clear_deformable_model(model_id: MaybeSequence[HHandle]) -> None

Description

The operator clear_deformable_modelclear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_model frees the memory of a deformable model that was created by create_planar_uncalib_deformable_modelcreate_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModelcreate_planar_uncalib_deformable_model or create_planar_calib_deformable_modelcreate_planar_calib_deformable_modelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModelcreate_planar_calib_deformable_model. After calling clear_deformable_modelclear_deformable_modelClearDeformableModelClearDeformableModelclear_deformable_model, the deformable model can no longer be used. The handle ModelIDModelIDModelIDmodelIDmodel_id 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:

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

ModelIDModelIDModelIDmodelIDmodel_id (input_control, state is modified)  deformable_model(-array) HDeformableModel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the model.

Result

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

See also

create_planar_uncalib_deformable_modelcreate_planar_uncalib_deformable_modelCreatePlanarUncalibDeformableModelCreatePlanarUncalibDeformableModelcreate_planar_uncalib_deformable_model, create_planar_calib_deformable_modelcreate_planar_calib_deformable_modelCreatePlanarCalibDeformableModelCreatePlanarCalibDeformableModelcreate_planar_calib_deformable_model, create_local_deformable_modelcreate_local_deformable_modelCreateLocalDeformableModelCreateLocalDeformableModelcreate_local_deformable_model

Module

Matching