select_xld_pointselect_xld_pointSelectXldPointSelectXldPointselect_xld_point (Operator)
Name
select_xld_pointselect_xld_pointSelectXldPointSelectXldPointselect_xld_point
— Choose all contours or polygons containing a given point.
Signature
void SelectXldPoint(const HObject& XLDs, HObject* DestXLDs, const HTuple& Row, const HTuple& Column)
HXLD HXLD::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLD HXLD::SelectXldPoint(double Row, double Column) const
HXLDCont HXLDCont::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLDCont HXLDCont::SelectXldPoint(double Row, double Column) const
HXLDPoly HXLDPoly::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLDPoly HXLDPoly::SelectXldPoint(double Row, double Column) const
HXLDPara HXLDPara::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLDPara HXLDPara::SelectXldPoint(double Row, double Column) const
HXLDModPara HXLDModPara::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLDModPara HXLDModPara::SelectXldPoint(double Row, double Column) const
HXLDExtPara HXLDExtPara::SelectXldPoint(const HTuple& Row, const HTuple& Column) const
HXLDExtPara HXLDExtPara::SelectXldPoint(double Row, double Column) const
static void HOperatorSet.SelectXldPoint(HObject XLDs, out HObject destXLDs, HTuple row, HTuple column)
HXLD HXLD.SelectXldPoint(HTuple row, HTuple column)
HXLD HXLD.SelectXldPoint(double row, double column)
HXLDCont HXLDCont.SelectXldPoint(HTuple row, HTuple column)
HXLDCont HXLDCont.SelectXldPoint(double row, double column)
HXLDPoly HXLDPoly.SelectXldPoint(HTuple row, HTuple column)
HXLDPoly HXLDPoly.SelectXldPoint(double row, double column)
HXLDPara HXLDPara.SelectXldPoint(HTuple row, HTuple column)
HXLDPara HXLDPara.SelectXldPoint(double row, double column)
HXLDModPara HXLDModPara.SelectXldPoint(HTuple row, HTuple column)
HXLDModPara HXLDModPara.SelectXldPoint(double row, double column)
HXLDExtPara HXLDExtPara.SelectXldPoint(HTuple row, HTuple column)
HXLDExtPara HXLDExtPara.SelectXldPoint(double row, double column)
def select_xld_point(xlds: HObject, row: Union[float, int], column: Union[float, int]) -> HObject
Description
The operator select_xld_pointselect_xld_pointSelectXldPointSelectXldPointSelectXldPointselect_xld_point
selects all contours or polygons from
XLDsXLDsXLDsXLDsXLDsxlds
containing the test point (RowRowRowRowrowrow
,ColumnColumnColumnColumncolumncolumn
).
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_pointselect_xld_pointSelectXldPointSelectXldPointSelectXldPointselect_xld_point
will artificially close the contours or
polygons.
Nevertheless, it is strongly recommended to pass only meaningful and closed
contours or polygons in XLDsXLDsXLDsXLDsXLDsxlds
by calling select_contours_xldselect_contours_xldSelectContoursXldSelectContoursXldSelectContoursXldselect_contours_xld
with the parameter 'closed'"closed""closed""closed""closed""closed" before calling
select_xld_pointselect_xld_pointSelectXldPointSelectXldPointSelectXldPointselect_xld_point
.
Attention
If the test point is on the border of a contour or polygon,
select_xld_pointselect_xld_pointSelectXldPointSelectXldPointSelectXldPointselect_xld_point
will deliver unpredictable results, i.e., the
contour or polygon may be or may not be added to DestXLDsDestXLDsDestXLDsDestXLDsdestXLDsdest_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
- 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
XLDsXLDsXLDsXLDsXLDsxlds
(input_object) xld(-array) →
objectHXLDHObjectHXLDHobject
Contours or polygons to be examined.
DestXLDsDestXLDsDestXLDsDestXLDsdestXLDsdest_xlds
(output_object) xld(-array) →
objectHXLDHObjectHXLDHobject *
All contours or polygons containing the test
point.
RowRowRowRowrowrow
(input_control) point.y →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Line coordinate of the test point.
Default:
100.0
ColumnColumnColumnColumncolumncolumn
(input_control) point.x →
HTupleUnion[float, int]HTupleHtuple (real / integer) (double / int / long) (double / Hlong) (double / Hlong)
Column coordinate of the test point.
Default:
100.0
Result
The operator select_xld_pointselect_xld_pointSelectXldPointSelectXldPointSelectXldPointselect_xld_point
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>)set_system("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)SetSystem("no_object_result",<Result>)set_system("no_object_result",<Result>)
.
If necessary an exception is raised.
Possible Predecessors
select_contours_xldselect_contours_xldSelectContoursXldSelectContoursXldSelectContoursXldselect_contours_xld
,
close_contours_xldclose_contours_xldCloseContoursXldCloseContoursXldCloseContoursXldclose_contours_xld
,
threshold_sub_pixthreshold_sub_pixThresholdSubPixThresholdSubPixThresholdSubPixthreshold_sub_pix
Alternatives
test_xld_pointtest_xld_pointTestXldPointTestXldPointTestXldPointtest_xld_point
Module
Foundation