Skip to content

write_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_modelT_write_sheet_of_light_model🔗

Short description🔗

write_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_modelT_write_sheet_of_light_model — Write a sheet-of-light model to a file.

Signature🔗

write_sheet_of_light_model( sheet_of_light_model SheetOfLightModelID, filename.write FileName )void WriteSheetOfLightModel( const HTuple& SheetOfLightModelID, const HTuple& FileName )static void HOperatorSet.WriteSheetOfLightModel( HTuple sheetOfLightModelID, HTuple fileName )def write_sheet_of_light_model( sheet_of_light_model_id: HHandle, file_name: str ) -> None

Herror T_write_sheet_of_light_model( const Htuple SheetOfLightModelID, const Htuple FileName )

void HSheetOfLightModel::WriteSheetOfLightModel( const HString& FileName ) const

void HSheetOfLightModel::WriteSheetOfLightModel( const char* FileName ) const

void HSheetOfLightModel::WriteSheetOfLightModel( const wchar_t* FileName ) const (Windows only)

void HSheetOfLightModel.WriteSheetOfLightModel( string fileName )

Description🔗

The operator write_sheet_of_light_modelWriteSheetOfLightModel writes the sheet-of-light model SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id to the file FileNamefileNamefile_name. The model can be read again with read_sheet_of_light_modelReadSheetOfLightModel. The stored data contains all generic model parameters (see set_sheet_of_light_paramSetSheetOfLightParam) and the results of calibrate_sheet_of_lightCalibrateSheetOfLight.

The default HALCON file extension for sheet-of-light model is 'solm'.

Execution information🔗

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🔗

SheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control) sheet_of_light_model → (handle)HTuple (HHandle)HSheetOfLightModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the sheet-of-light model.

FileNamefileNamefile_name (input_control) filename.write → (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

Result🔗

The operator write_sheet_of_light_modelWriteSheetOfLightModel returns the value 2 (H_MSG_TRUE) if the passed handle is valid and if the model can be written into the named file. Otherwise, an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_sheet_of_light_modelCreateSheetOfLightModel, set_sheet_of_light_paramSetSheetOfLightParam

See also

read_sheet_of_light_modelReadSheetOfLightModel

Module🔗

3D Metrology