clear_structured_light_modelT_clear_structured_light_modelClearStructuredLightModelClearStructuredLightModel (Operator)

Name

clear_structured_light_modelT_clear_structured_light_modelClearStructuredLightModelClearStructuredLightModel — Clear a structured light model and free the allocated memory.

Signature

clear_structured_light_model( : : StructuredLightModel : )

Description

The operator clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModel deletes a structured light model that was created by create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModel. All memory used by the model is freed. The handle of the model is passed in StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel. It is invalid after the operator call.

For an explanation of the concept of structured light and its supported applications, see the introduction of chapter Inspection / Structured Light.

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:

StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel

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

Parameters

StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel (input_control, state is modified) structured_light_model(-array) → (handle)

Handle of the structured light model.

Result

The operator clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModel returns the value 2 (H_MSG_TRUE) if a valid handle is passed and the referred structured light model can be freed correctly. Otherwise, an exception will be raised.

Module

3D Metrology

Operators