create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModel (Operator)

Name

create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModel — Create a structured light model.

Signature

create_structured_light_model( : : ModelType : StructuredLightModel)

create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModel creates a new structured light model of type ModelTypeModelTypeModelTypeModelTypemodelType. Currently, only the type 'deflectometry'"deflectometry""deflectometry""deflectometry""deflectometry" is supported.

The parameters of the structured light model can be queried with get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamGetStructuredLightModelParam and manipulated by calls to set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamSetStructuredLightModelParam.

Since create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModel and the succeeding operators allocate memory for the structured light model, the model has to be cleared with clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModel when it is no longer required.

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 returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

ModelTypeModelTypeModelTypeModelTypemodelType (input_control) string → (string)

The type of the created structured light model.

Default value: 'deflectometry' "deflectometry" "deflectometry" "deflectometry" "deflectometry"

StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel (output_control) structured_light_model → (integer)

Handle for using and accessing the structured light model.

Example (HDevelop)

* Create the model
create_structured_light_model ('deflectometry', StructuredLightModel)
* Generate the patterns to project
gen_structured_light_pattern (PatternImages, StructuredLightModel)
* Decode the camera images
decode_structured_light_pattern (CameraImages, StructuredLightModel)
* Clean up
clear_structured_light_model (StructuredLightModel)

Result

The operator create_structured_light_modelcreate_structured_light_modelCreateStructuredLightModelCreateStructuredLightModelCreateStructuredLightModel returns the value 2 (H_MSG_TRUE) if the structured light model can be allocated correctly. Otherwise, an exception will be raised.

Possible Successors

set_structured_light_model_paramset_structured_light_model_paramSetStructuredLightModelParamSetStructuredLightModelParamSetStructuredLightModelParam, get_structured_light_model_paramget_structured_light_model_paramGetStructuredLightModelParamGetStructuredLightModelParamGetStructuredLightModelParam

Module

3D Metrology

Operators