read_sheet_of_light_modelT_read_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModel (Operator)

Name

read_sheet_of_light_modelT_read_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModel — Read a sheet-of-light model from a file and create a new model.

Signature

read_sheet_of_light_model( : : FileName : SheetOfLightModelID)

Description

The operator read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelReadSheetOfLightModel reads the sheet-of-light model from the file FileNameFileNameFileNameFileNamefileName and creates a new model that is an identical copy of the saved model. The parameter SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID returns the handle of the new model. The model file FileNameFileNameFileNameFileNamefileName must have been created by the operator write_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelWriteSheetOfLightModel. The default HALCON file extension for sheet-of-light model is 'solm'.

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

FileNameFileNameFileNameFileNamefileName (input_control) filename.read → (string)

Name of the sheet-of-light model file.

Default value: 'sheet_of_light_model.solm' "sheet_of_light_model.solm" "sheet_of_light_model.solm" "sheet_of_light_model.solm" "sheet_of_light_model.solm"

File extension: .solm

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelID (output_control) sheet_of_light_model → (handle)

Handle of the sheet-of-light model.

Result

The operator read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelReadSheetOfLightModel returns the value 2 (H_MSG_TRUE) if the named file was found and correctly read. Otherwise, an exception is raised.