read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModel (Operator)

Name

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModel — Read a surface model from a file.

Signature

read_surface_model( : : FileName : SurfaceModelID)

Description

The operator read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel reads the surface model, which has been written with write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelWriteSurfaceModel, from the file FileNameFileNameFileNameFileNamefileName. The handle of the surface model is returned in SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID. If no absolute path is given in FileNameFileNameFileNameFileNamefileName, the file is searched in the current directory of the HALCON process. The default HALCON file extension for the surface model (SFM) file is 'sfm'. If no file named FileNameFileNameFileNameFileNamefileName exists, the default file extension is appended to FileNameFileNameFileNameFileNamefileName.

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

FileNameFileNameFileNameFileNamefileName (input_control) filename.read → (string)

Name of the SFM file.

File extension: .sfm

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (output_control) surface_model → (integer)

Handle of the read surface model.

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel returns 2 (H_MSG_TRUE) if all parameters are correct and the file can be read. If the file is not a surface model file, the error 9506 is raised. If the file has a version that can not be read by this version of HALCON, the error 9507 is raised. If necessary, an exception is raised.