HALCON 17.12 / HALCON Operator Reference / 2D Metrology
ClassesClasses | | Operators

clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObject (Operator)

Name

clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObject — Delete metrology objects and free the allocated memory.

Signature

clear_metrology_object( : : MetrologyHandle, Index : )

Herror clear_metrology_object(const Hlong MetrologyHandle, const char* Index)

Herror T_clear_metrology_object(const Htuple MetrologyHandle, const Htuple Index)

void ClearMetrologyObject(const HTuple& MetrologyHandle, const HTuple& Index)

void HMetrologyModel::ClearMetrologyObject(const HTuple& Index) const

void HMetrologyModel::ClearMetrologyObject(const HString& Index) const

void HMetrologyModel::ClearMetrologyObject(const char* Index) const

static void HOperatorSet.ClearMetrologyObject(HTuple metrologyHandle, HTuple index)

void HMetrologyModel.ClearMetrologyObject(HTuple index)

void HMetrologyModel.ClearMetrologyObject(string index)

Description

clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObjectClearMetrologyObject deletes in a metrology model metrology objects created, e.g, by add_metrology_object_circle_measureadd_metrology_object_circle_measureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasureAddMetrologyObjectCircleMeasure, add_metrology_object_ellipse_measureadd_metrology_object_ellipse_measureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasureAddMetrologyObjectEllipseMeasure, add_metrology_object_line_measureadd_metrology_object_line_measureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasureAddMetrologyObjectLineMeasure, or add_metrology_object_rectangle2_measureadd_metrology_object_rectangle2_measureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2MeasureAddMetrologyObjectRectangle2Measure.

For an explanation of the concept of 2D metrology see the introduction of chapter 2D Metrology.

All memory used by the metrology objects is freed. The handle of the metrology model is passed in MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle. The index of the metrology objects is passed in IndexIndexIndexIndexindex. If IndexIndexIndexIndexindex is set to 'all'"all""all""all""all", all metrology objects are deleted. After the operator call the metrology objects are invalid.

Execution Information

This operator modifies the state of the following input parameter:

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

MetrologyHandleMetrologyHandleMetrologyHandleMetrologyHandlemetrologyHandle (input_control, state is modified)  metrology_model → HMetrologyModel, HTupleHTupleHtuple (integer) (IntPtr) (Hlong) (Hlong)

Handle of the metrology model.

IndexIndexIndexIndexindex (input_control)  integer(-array) → HTupleHTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Index of the metrology objects.

Default value: 'all' "all" "all" "all" "all"

Suggested values: 'all'"all""all""all""all", 0, 1, 2

Result

If the parameters are valid, the operator clear_metrology_objectclear_metrology_objectClearMetrologyObjectClearMetrologyObjectClearMetrologyObject returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Module

2D Metrology

ClassesClasses | | Operators
HALCON Operator Reference 17.12 Copyright © 1996-2017 MVTec Software GmbH