ClassesClassesClassesClasses | | | | Operators

sort_contours_xldsort_contours_xldSortContoursXldsort_contours_xldSortContoursXldSortContoursXld (Operator)

Name

sort_contours_xldsort_contours_xldSortContoursXldsort_contours_xldSortContoursXldSortContoursXld — Sort contours with respect to their relative position.

Signature

sort_contours_xld(Contours : SortedContours : SortMode, Order, RowOrCol : )

Herror sort_contours_xld(const Hobject Contours, Hobject* SortedContours, const char* SortMode, const char* Order, const char* RowOrCol)

Herror T_sort_contours_xld(const Hobject Contours, Hobject* SortedContours, const Htuple SortMode, const Htuple Order, const Htuple RowOrCol)

Herror sort_contours_xld(Hobject Contours, Hobject* SortedContours, const HTuple& SortMode, const HTuple& Order, const HTuple& RowOrCol)

HXLDContArray HXLDContArray::SortContoursXld(const HTuple& SortMode, const HTuple& Order, const HTuple& RowOrCol) const

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

void HOperatorSetX.SortContoursXld(
[in] IHUntypedObjectX* Contours, [out] IHUntypedObjectX*SortedContours, [in] VARIANT SortMode, [in] VARIANT Order, [in] VARIANT RowOrCol)

IHXLDContX* HXLDContX.SortContoursXld(
[in] BSTR SortMode, [in] BSTR Order, [in] BSTR RowOrCol)

static void HOperatorSet.SortContoursXld(HObject contours, out HObject sortedContours, HTuple sortMode, HTuple order, HTuple rowOrCol)

HXLDCont HXLDCont.SortContoursXld(string sortMode, string order, string rowOrCol)

Description

The operator sort_contours_xldsort_contours_xldSortContoursXldsort_contours_xldSortContoursXldSortContoursXld sorts the contours with respect to their relative position. RowOrColRowOrColRowOrColRowOrColRowOrColrowOrCol 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. SortModeSortModeSortModeSortModeSortModesortMode 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 RowOrColRowOrColRowOrColRowOrColRowOrColrowOrCol.

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.

Parallelization

Parameters

ContoursContoursContoursContoursContourscontours (input_object)  xld_cont-array objectHXLDContHXLDContHXLDContArrayHXLDContXHobject

Contours to be sorted.

SortedContoursSortedContoursSortedContoursSortedContoursSortedContourssortedContours (output_object)  xld_cont-array objectHXLDContHXLDContHXLDContArrayHXLDContXHobject *

Sorted contours.

SortModeSortModeSortModeSortModeSortModesortMode (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Kind of sorting.

Default value: '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 HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Increasing or decreasing sorting order.

Default value: 'true' "true" "true" "true" "true" "true"

List of values: 'false'"false""false""false""false""false", 'true'"true""true""true""true""true"

RowOrColRowOrColRowOrColRowOrColRowOrColrowOrCol (input_control)  string HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

Sorting first with respect to row, then to column.

Default value: '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_xldSortContoursXldsort_contours_xldSortContoursXldSortContoursXld returns the value 2 (H_MSG_TRUE). Otherwise an exception will be raised.

See also

sort_regionsort_regionSortRegionsort_regionSortRegionSortRegion

Module

Foundation


ClassesClassesClassesClasses | | | | Operators