clear_structured_light_modelT_clear_structured_light_modelClearStructuredLightModelClearStructuredLightModelclear_structured_light_model (Operator)
Name
clear_structured_light_modelT_clear_structured_light_modelClearStructuredLightModelClearStructuredLightModelclear_structured_light_model — Clear a structured light model and free the allocated memory.
Signature
Description
The operator clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModelclear_structured_light_model deletes a structured
light model that was created by create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModelcreate_structured_light_model.
All memory used by the model is freed.
The handle of the model is passed in StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model. 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:
During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.
Parameters
StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModelstructured_light_model (input_control, state is modified) structured_light_model(-array) → HStructuredLightModel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the structured light model.
Result
The operator clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModelclear_structured_light_model 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.
See also
create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModelcreate_structured_light_model
Module
3D Metrology