Operator Reference

write_surface_modelT_write_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model (Operator)

write_surface_modelT_write_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model — 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)

def write_surface_model(surface_model_id: HHandle, file_name: str) -> None

Description

The operator write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model writes a surface model to the file FileNameFileNameFileNamefileNamefile_name. The file can be read again with read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model. 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

SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id (input_control)  surface_model HSurfaceModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface model.

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

File name.

File extension: .sfm

Result

write_surface_modelwrite_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_model 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_modelReadSurfaceModelReadSurfaceModelread_surface_model, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model, get_surface_model_paramget_surface_model_paramGetSurfaceModelParamGetSurfaceModelParamget_surface_model_param

Possible Successors

clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model

See also

create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model, read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model

Module

3D Metrology