Operator Reference

HALCON Operator Reference / 3D Matching / Surface-Based

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

ClassesClasses | | Operators

clear_surface_modelT_clear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model (Operator)

clear_surface_modelT_clear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model — Free the memory of a surface model.

Signature

clear_surface_model( : : SurfaceModelID : )

Herror T_clear_surface_model(const Htuple SurfaceModelID)

void ClearSurfaceModel(const HTuple& SurfaceModelID)

static void HSurfaceModel::ClearSurfaceModel(const HSurfaceModelArray& SurfaceModelID)

void HSurfaceModel::ClearSurfaceModel() const

static void HOperatorSet.ClearSurfaceModel(HTuple surfaceModelID)

static void HSurfaceModel.ClearSurfaceModel(HSurfaceModel[] surfaceModelID)

void HSurfaceModel.ClearSurfaceModel()

def clear_surface_model(surface_model_id: MaybeSequence[HHandle]) -> None

Description

The operator clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model frees the memory of a surface model that was created by read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model or create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model. After calling clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model, the model can no longer be used. The handle SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id becomes invalid.

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 modifies the state of the following input parameter:

• SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

SurfaceModelIDSurfaceModelIDSurfaceModelIDsurfaceModelIDsurface_model_id (input_control, state is modified)  surface_model(-array) → HSurfaceModel, HTupleMaybeSequence[HHandle]HTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Handle of the surface model.

Result

If the handle of the model is valid, the operator clear_surface_modelclear_surface_modelClearSurfaceModelClearSurfaceModelclear_surface_model returns the value 2 ( H_MSG_TRUE) . If necessary an exception is raised.

Possible Predecessors

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model

See also

read_surface_modelread_surface_modelReadSurfaceModelReadSurfaceModelread_surface_model, create_surface_modelcreate_surface_modelCreateSurfaceModelCreateSurfaceModelcreate_surface_model

Module

3D Metrology

---

ClassesClasses | | Operators