Operator Reference

HALCON Operator Reference / 3D Reconstruction / Sheet of Light
ClassesClasses | | Operators

write_sheet_of_light_modelT_write_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_model (Operator)

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

Signature

write_sheet_of_light_model( : : SheetOfLightModelID, FileName : )

Herror T_write_sheet_of_light_model(const Htuple SheetOfLightModelID, const Htuple FileName)

void WriteSheetOfLightModel(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)

static void HOperatorSet.WriteSheetOfLightModel(HTuple sheetOfLightModelID, HTuple fileName)

void HSheetOfLightModel.WriteSheetOfLightModel(string fileName)

def write_sheet_of_light_model(sheet_of_light_model_id: HHandle, file_name: str) -> None

Description

The operator write_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_model writes the sheet-of-light model SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id to the file FileNameFileNameFileNamefileNamefile_name. The model can be read again with read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model. The stored data contains all generic model parameters (see set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param) and the results of calibrate_sheet_of_lightcalibrate_sheet_of_lightCalibrateSheetOfLightCalibrateSheetOfLightcalibrate_sheet_of_light.

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.

Parameters

SheetOfLightModelIDSheetOfLightModelIDSheetOfLightModelIDsheetOfLightModelIDsheet_of_light_model_id (input_control)  sheet_of_light_model → HSheetOfLightModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the sheet-of-light model.

FileNameFileNameFileNamefileNamefile_name (input_control)  filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Name of the sheet-of-light model file.

Default: '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

Result

The operator write_sheet_of_light_modelwrite_sheet_of_light_modelWriteSheetOfLightModelWriteSheetOfLightModelwrite_sheet_of_light_model 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.

Possible Predecessors

create_sheet_of_light_modelcreate_sheet_of_light_modelCreateSheetOfLightModelCreateSheetOfLightModelcreate_sheet_of_light_model, set_sheet_of_light_paramset_sheet_of_light_paramSetSheetOfLightParamSetSheetOfLightParamset_sheet_of_light_param

See also

read_sheet_of_light_modelread_sheet_of_light_modelReadSheetOfLightModelReadSheetOfLightModelread_sheet_of_light_model

Module

3D Metrology

ClassesClasses | | Operators