write_surface_modelT_write_surface_modelWriteSurfaceModelWriteSurfaceModel (Operator)

Name

write_surface_modelT_write_surface_modelWriteSurfaceModelWriteSurfaceModel — Write a surface model to a file.

Signature

write_surface_model( : : SurfaceModelID, FileName : )

The operator write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel writes a surface model to the file FileNameFileNameFileNameFileNamefileName. The file can be read again with read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel. The default HALCON file extension for the surface model (SFM) file is 'sfm'.

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

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control) surface_model → (handle)

Handle of the surface model.

FileNameFileNameFileNameFileNamefileName (input_control) filename.write → (string)

File name.

File extension: .sfm

Result

write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel returns 2 (H_MSG_TRUE) if all parameters are correct and the HALCON process has write permission to the file. If necessary, an exception is raised.