read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_modelT_read_sheet_of_light_model
Short description
read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_modelT_read_sheet_of_light_model — Read a sheet-of-light model from a file and create a new model.
Signature
read_sheet_of_light_model( filename.read FileName, out sheet_of_light_model SheetOfLightModelID )read_sheet_of_light_model( : : FileName : SheetOfLightModelID )void ReadSheetOfLightModel( const HTuple& FileName, HTuple* SheetOfLightModelID )static void HOperatorSet.ReadSheetOfLightModel( HTuple fileName, out HTuple sheetOfLightModelID )def read_sheet_of_light_model( file_name: str ) -> HHandle
Herror T_read_sheet_of_light_model( const Htuple FileName, Htuple* SheetOfLightModelID )
void HSheetOfLightModel::HSheetOfLightModel( const HString& FileName )
void HSheetOfLightModel::HSheetOfLightModel( const char* FileName )
void HSheetOfLightModel::HSheetOfLightModel( const wchar_t* FileName ) (Windows only)
public HSheetOfLightModel( string fileName )
void HSheetOfLightModel::ReadSheetOfLightModel( const HString& FileName )
void HSheetOfLightModel::ReadSheetOfLightModel( const char* FileName )
void HSheetOfLightModel::ReadSheetOfLightModel( const wchar_t* FileName ) (Windows only)
void HSheetOfLightModel.ReadSheetOfLightModel( string fileName )
Description
The operator read_sheet_of_light_modelReadSheetOfLightModel reads the sheet-of-light model
from the file FileNamefileNamefile_name and creates a new model that is an identical
copy of the saved model. The parameter SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id returns
the handle of the new model.
The model file FileNamefileNamefile_name must have been created
by the operator write_sheet_of_light_modelWriteSheetOfLightModel.
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
FileNamefileNamefile_name (input_control) filename.read → (string)(string)HTuple (HString)HTuple (string)strHtuple (char*)
Name of the sheet-of-light model file.
Default: 'sheet_of_light_model.solm'"sheet_of_light_model.solm"
File extension: .solm
SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (output_control) sheet_of_light_model → (handle)(handle)HTuple (HHandle)HSheetOfLightModel, HTuple (IntPtr)HHandleHtuple (handle)
Handle of the sheet-of-light model.
Result
The operator read_sheet_of_light_modelReadSheetOfLightModel returns the value 2 (H_MSG_TRUE)
if the named file was found and correctly read.
Otherwise, an exception is raised.
Combinations with other operators
Combinations
Possible successors
measure_profile_sheet_of_lightMeasureProfileSheetOfLight
Alternatives
create_sheet_of_light_modelCreateSheetOfLightModel
See also
write_sheet_of_light_modelWriteSheetOfLightModel
Module
3D Metrology