select_xld_pointSelectXldPointSelectXldPointselect_xld_pointselect_xld_point🔗

Short description🔗

select_xld_pointSelectXldPointSelectXldPointselect_xld_pointselect_xld_point — Choose all contours or polygons containing a given point.

Signature🔗

select_xld_point( xld XLDs, out xld DestXLDs, point.y Row, point.x Column )

Description🔗

The operator select_xld_pointSelectXldPoint selects all contours or polygons from XLDsXLDsxlds containing the test point (Rowrowrow,Columncolumncolumn). If the contours or polygons overlap, more than one contour or polygon might contain the point. In this case, all these contours or polygons are returned. If no contour or polygon contains the indicated point, an empty object is returned. It is assumed that the contours or polygons are closed. If this is not the case, select_xld_pointSelectXldPoint will artificially close the contours or polygons. Nevertheless, it is strongly recommended to pass only meaningful and closed contours or polygons in XLDsXLDsxlds by calling select_contours_xldSelectContoursXld with the parameter 'closed'"closed" before calling select_xld_pointSelectXldPoint.

Attention🔗

If the test point is on the border of a contour or polygon, select_xld_pointSelectXldPoint will deliver unpredictable results, i.e., the contour or polygon may be or may not be added to DestXLDsdestXLDsdest_xlds, depending on arbitrary factors such as how the polygon is oriented with respect to the coordinate system. Note further that for points in the near proximity of the contour or polygon sides, a reliable classification is practically impossible because of numerical inaccuracies.

Execution information🔗

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🔗

XLDsXLDsxlds (input_object) xld(-array) → objectHObjectHXLDHObjectHobject

Contours or polygons to be examined.

DestXLDsdestXLDsdest_xlds (output_object) xld(-array) → objectHObjectHXLDHObjectHobject *

All contours or polygons containing the test point.

Rowrowrow (input_control) point.y → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[float, int]Htuple (double / Hlong)

Line coordinate of the test point.

Default: 100.0100.0

Columncolumncolumn (input_control) point.x → (real / integer)HTuple (double / Hlong)HTuple (double / int / long)Union[float, int]Htuple (double / Hlong)

Column coordinate of the test point.

Default: 100.0100.0

Result🔗

The operator select_xld_pointSelectXldPoint returns the value 2 (H_MSG_TRUE) if the parameters are correct. The behavior in case of empty input (no input contours or polygons available) is set via the operator set_system('no_object_result',<Result>). If necessary an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

select_contours_xldSelectContoursXld, close_contours_xldCloseContoursXld, threshold_sub_pixThresholdSubPix

Alternatives

test_xld_pointTestXldPoint

Module🔗

Foundation