sort_contours_xldsort_contours_xldSortContoursXldSortContoursXldsort_contours_xld (Operator)
Name
sort_contours_xldsort_contours_xldSortContoursXldSortContoursXldsort_contours_xld — Sort contours with respect to their relative position.
Signature
void SortContoursXld(const HObject& Contours, HObject* SortedContours, const HTuple& SortMode, const HTuple& Order, const HTuple& RowOrCol)
HXLDCont HXLDCont::SortContoursXld(const HString& SortMode, const HString& Order, const HString& RowOrCol) const
HXLDCont HXLDCont::SortContoursXld(const char* SortMode, const char* Order, const char* RowOrCol) const
HXLDCont HXLDCont::SortContoursXld(const wchar_t* SortMode, const wchar_t* Order, const wchar_t* RowOrCol) const
(
Windows only)
Description
The operator sort_contours_xldsort_contours_xldSortContoursXldSortContoursXldSortContoursXldsort_contours_xld sorts the contours
with respect to their relative position. RowOrColRowOrColRowOrColRowOrColrowOrColrow_or_col specifies the
sorting criteria:
'row'"row""row""row""row""row" sorts the contours with respect to the row coordinate of
their position first and, if the row coordinates are identical, with respect
to the column coordinate. In contrast, 'column'"column""column""column""column""column" sorts
contours according to the column coordinate first.
SortModeSortModeSortModeSortModesortModesort_mode defines the position of a contour by individual reference
points. The following parameter values are available:
- 'upper_left'"upper_left""upper_left""upper_left""upper_left""upper_left":
-
The position is determined by the upper left corner of the
surrounding rectangle.
- 'upper_right'"upper_right""upper_right""upper_right""upper_right""upper_right":
-
The position is determined by the upper right corner of the
surrounding rectangle.
- 'lower_left'"lower_left""lower_left""lower_left""lower_left""lower_left":
-
The position is determined by the lower left corner of the
surrounding rectangle.
- 'lower_right'"lower_right""lower_right""lower_right""lower_right""lower_right":
-
The position is determined by the lower right corner of the
surrounding rectangle.
- 'character'"character""character""character""character""character":
-
The position is determined by the upper left corner of the
surrounding rectangle. In contrast to 'upper_left'"upper_left""upper_left""upper_left""upper_left""upper_left",
the contours
are also sorted according to the remaining coordinate, if they
overlap in
the direction of the coordinate which is specified by the
parameter RowOrColRowOrColRowOrColRowOrColrowOrColrow_or_col.
The parameter OrderOrderOrderOrderorderorder determines whether the
sorting order is increasing or decreasing: using
'true'"true""true""true""true""true" the order will be increasing, using
'false'"false""false""false""false""false" the order will be decreasing.
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
ContoursContoursContoursContourscontourscontours (input_object) xld_cont-array → objectHXLDContHObjectHXLDContHobject
Contours to be sorted.
SortedContoursSortedContoursSortedContoursSortedContourssortedContourssorted_contours (output_object) xld_cont-array → objectHXLDContHObjectHXLDContHobject *
Sorted contours.
SortModeSortModeSortModeSortModesortModesort_mode (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Kind of sorting.
Default:
'upper_left'
"upper_left"
"upper_left"
"upper_left"
"upper_left"
"upper_left"
List of values:
'character'"character""character""character""character""character", 'lower_left'"lower_left""lower_left""lower_left""lower_left""lower_left", 'lower_right'"lower_right""lower_right""lower_right""lower_right""lower_right", 'upper_left'"upper_left""upper_left""upper_left""upper_left""upper_left", 'upper_right'"upper_right""upper_right""upper_right""upper_right""upper_right"
OrderOrderOrderOrderorderorder (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Increasing or decreasing sorting order.
Default:
'true'
"true"
"true"
"true"
"true"
"true"
List of values:
'false'"false""false""false""false""false", 'true'"true""true""true""true""true"
RowOrColRowOrColRowOrColRowOrColrowOrColrow_or_col (input_control) string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)
Sorting first with respect to row, then to column.
Default:
'row'
"row"
"row"
"row"
"row"
"row"
List of values:
'column'"column""column""column""column""column", 'row'"row""row""row""row""row"
Result
If the parameters are correct, the operator
sort_contours_xldsort_contours_xldSortContoursXldSortContoursXldSortContoursXldsort_contours_xld returns the value 2 (
H_MSG_TRUE)
.
Otherwise an exception will be raised.
See also
sort_regionsort_regionSortRegionSortRegionSortRegionsort_region
Module
Foundation