Operator Reference

HALCON Operator Reference / Regions / Tests
ClassesClasses | | Operators

test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegiontest_subset_region (Operator)

test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegiontest_subset_region — Test whether a region is contained in another region.

Signature

test_subset_region(Region1, Region2 : : : IsSubset)

Herror test_subset_region(const Hobject Region1, const Hobject Region2, Hlong* IsSubset)

Herror T_test_subset_region(const Hobject Region1, const Hobject Region2, Htuple* IsSubset)

void TestSubsetRegion(const HObject& Region1, const HObject& Region2, HTuple* IsSubset)

HTuple HRegion::TestSubsetRegion(const HRegion& Region2) const

static void HOperatorSet.TestSubsetRegion(HObject region1, HObject region2, out HTuple isSubset)

HTuple HRegion.TestSubsetRegion(HRegion region2)

def test_subset_region(region_1: HObject, region_2: HObject) -> Sequence[int]

def test_subset_region_s(region_1: HObject, region_2: HObject) -> int

Description

test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegiontest_subset_region tests whether Region1Region1Region1region1region_1 is a subset of Region2Region2Region2region2region_2 and returns the result in IsSubsetIsSubsetIsSubsetisSubsetis_subset. If more than one region should be tested, Region1Region1Region1region1region_1 and Region2Region2Region2region2region_2 must have the same number of elements. In this case, a tuple that contains as many elements as Region1Region1Region1region1region_1 and Region2Region2Region2region2region_2 is returned in IsSubsetIsSubsetIsSubsetisSubsetis_subset.

For a short description of the iconic objects that are available in HALCON see the introduction of chapter Object.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Automatically parallelized on tuple level.

Parameters

Region1Region1Region1region1region_1 (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Test region.

Region2Region2Region2region2region_2 (input_object)  region(-array) → objectHRegionHObjectHObjectHobject

Region for comparison.

Number of elements: Region1 == Region2

IsSubsetIsSubsetIsSubsetisSubsetis_subset (output_control)  integer(-array) → HTupleSequence[int]HTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Is Region1Region1Region1region1region_1 contained in Region2Region2Region2region2region_2?

Result

test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegiontest_subset_region returns the value 2 ( H_MSG_TRUE) if the parameters are correct. The behavior in case of empty input (no input objects available) is set via the operator set_system(::'no_object_result',<Result>:)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>). If the number of objects differs an exception is raised.

Alternatives

differencedifferenceDifferenceDifferencedifference, area_centerarea_centerAreaCenterAreaCenterarea_center

See also

test_equal_regiontest_equal_regionTestEqualRegionTestEqualRegiontest_equal_region, compare_objcompare_objCompareObjCompareObjcompare_obj

Module

Foundation

ClassesClasses | | Operators