write_structured_light_modelT_write_structured_light_modelWriteStructuredLightModelWriteStructuredLightModel (Operator)

Name

write_structured_light_modelT_write_structured_light_modelWriteStructuredLightModelWriteStructuredLightModel — Write a structured light model to a file.

Signature

write_structured_light_model( : : StructuredLightModel, FileName : )

write_structured_light_modelwrite_structured_light_modelWriteStructuredLightModelWriteStructuredLightModelWriteStructuredLightModel writes the structured light model StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel to the file given by FileNameFileNameFileNameFileNamefileName. The default HALCON file extension for the structured light model is 'hslm'. The structured light model can be then read with read_structured_light_modelread_structured_light_modelReadStructuredLightModelReadStructuredLightModelReadStructuredLightModel. It should be noted that write_structured_light_modelwrite_structured_light_modelWriteStructuredLightModelWriteStructuredLightModelWriteStructuredLightModel does not write any previously generated pattern images in the structured light model. In other words, only the parameters of the model and objects that were already generated will be written in the file. The list of structured light objects and how to generate each can be found in get_structured_light_objectget_structured_light_objectGetStructuredLightObjectGetStructuredLightObjectGetStructuredLightObject.

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.

Parameters

StructuredLightModelStructuredLightModelStructuredLightModelStructuredLightModelstructuredLightModel (input_control) structured_light_model → (handle)

Handle of the structured light model.

FileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

File name.

File extension: .hslm

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)
* Write the model
write_structured_light_model (StructuredLightModel, 'ExampleModel.hslm')

Result

The operator write_structured_light_modelwrite_structured_light_modelWriteStructuredLightModelWriteStructuredLightModelWriteStructuredLightModel returns the value 2 (H_MSG_TRUE) if the given parameters are valid. Otherwise, an exception will be raised.

Possible Successors

clear_structured_light_modelclear_structured_light_modelClearStructuredLightModelClearStructuredLightModelClearStructuredLightModel

Module

3D Metrology

Operators