read_sheet_of_light_modelT_read_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model (Operator)
Name
read_sheet_of_light_modelT_read_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model — Read a sheet-of-light model from a file and create a new model.
Signature
def read_sheet_of_light_model(file_name: str) -> HHandle
Description
The operator read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model reads the sheet-of-light model
from the file FileNameFileNameFileNameFileNamefileNamefile_name and creates a new model that is an identical
copy of the saved model. The parameter SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id returns
the handle of the new model.
The model file FileNameFileNameFileNameFileNamefileNamefile_name must have been created
by the operator write_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_model.
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
FileNameFileNameFileNameFileNamefileNamefile_name (input_control) filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
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"
"sheet_of_light_model.solm"
File extension: .solm
SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (output_control) sheet_of_light_model → HSheetOfLightModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the sheet-of-light model.
Result
The operator read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model returns the value 2 (H_MSG_TRUE)
if the named file was found and correctly read.
Otherwise, an exception is raised.
Possible Successors
measure_profile_sheet_of_lightmeasure_profile_sheet_of_lightMeasureProfileSheetOfLightMeasureProfileSheetOfLightMeasureProfileSheetOfLightmeasure_profile_sheet_of_light
Alternatives
create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model
See also
write_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_model
Module
3D Metrology