Herror ::test_region_point (
    Hobject Regions,
    const HTuple &Row,
    const HTuple &Column
)
HBool HRegion::TestRegionPoint (
    const HTuple &Row,
    const HTuple &Column
) const
HBool HRegionArray::TestRegionPoint (
    const HTuple &Row,
    const HTuple &Column
) const

Test if the region consists of the given point.

::test_region_point tests if at least one input region of Regions consists of the test point (Row,Column).


Attention

In case of empty input (= no region) and ::set_system('no_object_result','true') FALSE is returned (no region contains the pixel).

The test pixel is not contained in an empty region (no pixel of the region corresponds to the pixel). If all regions are empty FALSE is also returned, i.e. an empty region behaves as if it did not exist.


Parameters

Regions (input_object)
region(-array) -> Hobject: HRegion(Array)
Region(s) to be examined.

Row (input_control)
point.y -> HTuple.long
Line index of the test pixel.
Default value: 100
Typical range of values: 0 <= Row <= 512 (lin)
Minimum increment: 1
Recommended increment: 1

Column (input_control)
point.x -> HTuple.long
Column index of the test pixel.
Default value: 100
Typical range of values: 0 <= Column <= 512 (lin)
Minimum increment: 1
Recommended increment: 1


Complexity

If F is the area of one region and N is the number of regions, the runtime complexity is O(F) * N).


Result

The operator ::test_region_point returns the value H_MSG_TRUE if a region contains the test pixel. If this is not the case ::test_region_point returns H_MSG_FALSE. The behavior in case of empty input (no input regions available) is set via the operator ::set_system('no_object_result',<Result>). If necessary an exception handling is raised.


Possible Predecessors

::threshold, ::regiongrowing, ::connection


Alternatives

::union1, ::intersection, ::area_center


See also

::select_region_point


Return Value

bool


Module

Region processing



Copyright © 1996-2002 MVTec Software GmbH