sort_region ( Regions : SortedRegions : SortMode, Order, RowOrCol : )

Sorting of regions with respect of their relative position.

The operator sort_region sorts the regions with respect to their relative position. All sorting methods with the exception of 'character' use one point of the region. With the help of the parameter RowOrCol = 'row' these points will be sorted according to their row and then according to their column; by using 'column', the column value will be used first. The following values are available for the parameter SortMode:

  'character'
      The regions will be treated like characters in a row
      and will be sorted according to their order in the line:
      If two regions overlap horizontally, they will be sorted
      with respect to their column values, otherwise they will
      be sorted with regard to their row values.

  'first_point'
      The point with the lowest column value in the first row
      of the region.

  'last_point'
      The point with the highest column value in the last row
      of the region.

  'upper_left'
      Upper lefthand corner of the surrounding rectangle. 

  'upper_right'
      Upper righthand corner of the surrounding rectangle.

  'lower_left'
      Lower lefthand corner of the surrounding rectangle.

  'lower_right'
      Lower righthand corner of the surrounding rectangle.
The parameter Order determines whether the sorting order is increasing or decreasing: using 'true' the order will be increasing, using 'false' the order will be decreasing.


Parameters

Regions (input_object)
region-array -> object
Regions to be sorted.

SortedRegions (output_object)
region-array -> object
Sorted regions.

SortMode (input_control)
string -> string
Kind of sorting.
Default value: 'first_point'
List of values: 'character', 'first_point', 'last_point', 'upper_left', 'lower_left', 'upper_right', 'lower_right'

Order (input_control)
string -> string
Increasing or decreasing sorting order.
Default value: 'true'
List of values: 'true', 'false'

RowOrCol (input_control)
string -> string
Sorting first with respect to row, then to column.
Default value: 'row'
List of values: 'row', 'column'


Result

If the parameter are correct, the operator sort_region returns the value TRUE. Otherwise an exception will be raised.


Possible Successors

do_ocr_b, do_ocr_m


See also

create_ocr_net



Copyright © 1996-1997 MVTec Software GmbH