Skip to content

write_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_modelT_write_surface_model🔗

Short description🔗

write_surface_modelWriteSurfaceModelWriteSurfaceModelwrite_surface_modelT_write_surface_model — Write a surface model to a file.

Signature🔗

write_surface_model( surface_model SurfaceModelID, filename.write FileName )void WriteSurfaceModel( const HTuple& SurfaceModelID, const HTuple& FileName )static void HOperatorSet.WriteSurfaceModel( HTuple surfaceModelID, HTuple fileName )def write_surface_model( surface_model_id: HHandle, file_name: str ) -> None

Herror T_write_surface_model( 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)

void HSurfaceModel.WriteSurfaceModel( string fileName )

Description🔗

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

Execution information🔗

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🔗

SurfaceModelIDsurfaceModelIDsurface_model_id (input_control) surface_model → (handle)HTuple (HHandle)HSurfaceModel, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the surface model.

FileNamefileNamefile_name (input_control) filename.write → (string)HTuple (HString)HTuple (string)strHtuple (char*)

File name.

File extension: .sfm

Result🔗

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

Combinations with other operators🔗

Combinations

Possible predecessors

read_surface_modelReadSurfaceModel, create_surface_modelCreateSurfaceModel, get_surface_model_paramGetSurfaceModelParam

Possible successors

clear_surface_modelClearSurfaceModel

See also

create_surface_modelCreateSurfaceModel, read_surface_modelReadSurfaceModel

Module🔗

3D Metrology