Skip to content

test_subset_regionTestSubsetRegionTestSubsetRegiontest_subset_regiontest_subset_region🔗

Short description🔗

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

Signature🔗

test_subset_region( region Region1, region Region2, out integer IsSubset )void TestSubsetRegion( const HObject& Region1, const HObject& Region2, HTuple* IsSubset )static void HOperatorSet.TestSubsetRegion( HObject region1, HObject region2, out HTuple isSubset )def test_subset_region( region_1: HObject, region_2: HObject ) -> Sequence[int]

def test_subset_region_s( region_1: HObject, region_2: HObject ) -> intHerror test_subset_region( const Hobject Region1, const Hobject Region2, Hlong* IsSubset )

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

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

HTuple HRegion.TestSubsetRegion( HRegion region2 )

Description🔗

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

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

Execution information🔗

Execution information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

Parameters🔗

Region1region1region_1 (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Test region.

Region2region2region_2 (input_object) region(-array) → objectHObjectHRegionHObjectHobject

Region for comparison.

Number of elements: Region1 == Region2

IsSubsetisSubsetis_subset (output_control) integer(-array) → (integer)HTuple (Hlong)HTuple (int / long)Sequence[int]Htuple (Hlong)

Is Region1region1region_1 contained in Region2region2region_2?

Result🔗

test_subset_regionTestSubsetRegion 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>:). If the number of objects differs an exception is raised.

Combinations with other operators🔗

Combinations

Alternatives

differenceDifference, area_centerAreaCenter

See also

test_equal_regionTestEqualRegion, compare_objCompareObj

Module🔗

Foundation