clear_descriptor_modelT_clear_descriptor_modelClearDescriptorModelClearDescriptorModel (Operator)

Name

clear_descriptor_modelT_clear_descriptor_modelClearDescriptorModelClearDescriptorModel — Free the memory of a descriptor model.

Signature

clear_descriptor_model( : : ModelID : )

Description

The operator clear_descriptor_modelclear_descriptor_modelClearDescriptorModelClearDescriptorModelClearDescriptorModel frees the memory of a descriptor model that was created by create_calib_descriptor_modelcreate_calib_descriptor_modelCreateCalibDescriptorModelCreateCalibDescriptorModelCreateCalibDescriptorModel or create_uncalib_descriptor_modelcreate_uncalib_descriptor_modelCreateUncalibDescriptorModelCreateUncalibDescriptorModelCreateUncalibDescriptorModel. After calling clear_descriptor_modelclear_descriptor_modelClearDescriptorModelClearDescriptorModelClearDescriptorModel, the 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) descriptor_model(-array) → (handle)

Handle of the descriptor model.

Result

If the handle of the model is valid, the operator clear_descriptor_modelclear_descriptor_modelClearDescriptorModelClearDescriptorModelClearDescriptorModel returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

Module

Matching

Operators