Operator Reference

HALCON Operator Reference / 3D Matching / Surface-Based

• HDevelop
• .NET
• Python
• C++
• C

ClassesClasses | | Operators

read_surface_modelT_read_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model (Operator)

read_surface_modelT_read_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model — Read a surface model from a file.

Signature

read_surface_model( : : FileName : SurfaceModelID)

Herror T_read_surface_model(const Htuple FileName, Htuple* SurfaceModelID)

void ReadSurfaceModel(const HTuple& FileName, HTuple* SurfaceModelID)

void HSurfaceModel::HSurfaceModel(const HString& FileName)

void HSurfaceModel::HSurfaceModel(const char* FileName)

void HSurfaceModel::HSurfaceModel(const wchar_t* FileName)   ( Windows only)

void HSurfaceModel::ReadSurfaceModel(const HString& FileName)

void HSurfaceModel::ReadSurfaceModel(const char* FileName)

void HSurfaceModel::ReadSurfaceModel(const wchar_t* FileName)   ( Windows only)

static void HOperatorSet.ReadSurfaceModel(HTuple fileName, out HTuple surfaceModelID)

public HSurfaceModel(string fileName)

void HSurfaceModel.ReadSurfaceModel(string fileName)

def read_surface_model(file_name: str) -> HHandle

Description

The operator read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model reads the surface model, which has been written with write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model, from the file FileNameFileNameFileNamefileNamefile_name. The handle of the surface model is returned in SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id. If no absolute path is given in FileNameFileNameFileNamefileNamefile_name, 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 FileNameFileNameFileNamefileNamefile_name exists, the default file extension is appended to FileNameFileNameFileNamefileNamefile_name.

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

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

Name of the SFM file.

File extension: .sfm

SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id (output_control)  surface_model → HSurfaceModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the read surface model.

Result

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model 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.

Possible Predecessors

read_object_model_3dread_object_model_3dReadObjectModel3dReadObjectModel3dread_object_model_3d, xyz_to_object_model_3dxyz_to_object_model_3dXyzToObjectModel3dXyzToObjectModel3dxyz_to_object_model_3d

Possible Successors

find_surface_modelfind_surface_modelFindSurfaceModelFindSurfaceModelfind_surface_model, refine_surface_model_poserefine_surface_model_poseRefineSurfaceModelPoseRefineSurfaceModelPoserefine_surface_model_pose, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamget_surface_model_param, clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model, find_surface_model_imagefind_surface_model_imageFindSurfaceModelImageFindSurfaceModelImagefind_surface_model_image, refine_surface_model_pose_imagerefine_surface_model_pose_imageRefineSurfaceModelPoseImageRefineSurfaceModelPoseImagerefine_surface_model_pose_image

Alternatives

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model, write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model

Module

3D Metrology

---

ClassesClasses | | Operators