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 : )

Herror T_write_surface_model(const Htuple SurfaceModelID, const Htuple FileName)

void WriteSurfaceModel(const HTuple& SurfaceModelID, const HTuple& FileName)

void HSurfaceModel::WriteSurfaceModel(const HString& FileName) const

void HSurfaceModel::WriteSurfaceModel(const char* FileName) const

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

static void HOperatorSet.WriteSurfaceModel(HTuple surfaceModelID, HTuple fileName)

void HSurfaceModel.WriteSurfaceModel(string fileName)

Description

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

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelID (input_control)  surface_model HSurfaceModel, HTupleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface model.

FileNameFileNameFileNameFileNamefileName (input_control)  filename.write HTupleHTupleHtuple (string) (string) (HString) (char*)

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.

Possible Predecessors

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamGetSurfaceModelParam

Possible Successors

clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelClearSurfaceModel

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelCreateSurfaceModel, read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelReadSurfaceModel

Module

3D Metrology