test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegion (Operator)

Name

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

Description

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

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

Execution Information

Parameters

Region1Region1Region1Region1region1 (input_object)  region(-array) objectHRegionHRegionHobject

Test region.

Region2Region2Region2Region2region2 (input_object)  region(-array) objectHRegionHRegionHobject

Region for comparison.

Number of elements: Region1 == Region2

IsSubsetIsSubsetIsSubsetIsSubsetisSubset (output_control)  integer(-array) HTupleHTupleHtuple (integer) (int / long) (Hlong) (Hlong)

Is Region1Region1Region1Region1region1 contained in Region2Region2Region2Region2region2?

Result

test_subset_regiontest_subset_regionTestSubsetRegionTestSubsetRegionTestSubsetRegion 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>)SetSystem("no_object_result",<Result>). If the number of objects differs an exception is raised.

Alternatives

differencedifferenceDifferenceDifferenceDifference, area_centerarea_centerAreaCenterAreaCenterAreaCenter

See also

test_equal_regiontest_equal_regionTestEqualRegionTestEqualRegionTestEqualRegion, compare_objcompare_objCompareObjCompareObjCompareObj

Module

Foundation