ILSorter Interface Reference

This interface expose APIs to sort or apply permutation to a collection of objects implemented ILSortable interface. More...

Inheritance diagram for ILSorter:

Public Member Functions
LPVErrorCode	SortToArray (ILSortables *sortables, ILSortedArray **sortedResult)
LPVErrorCode	SortToArray2 (LArray< ILSortable * > sortableArray, ILSortedArray **sortedResult)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Properties
double	ColumnSpace [get, set]
	The approximated column space used for array initialization. By default, it's set to 0, means we'll generate a proper value on the fly, based on the positions of the source points.
LPVPositionMode	PositionMode [get, set]
	Specify which point is used as the source object's position.
double	RowSpace [get, set]
	The approximated row space used for array initialization. By default, it's set to 0, means we'll generate a proper value on the fly, based on the positions of the source points.
double	ToleranceFactor [get, set]
	The factor is used to control the filtering behavior for the source points which do not locate exactly on the array's grid. It's in range 0 ~ 1, the smaller factor indicates the stricter filtering. Set it to 1 means no filtering. By default, it's 0.5.

Detailed Description

This interface expose APIs to sort or apply permutation to a collection of objects implemented ILSortable interface.

To use this interface, you should create a LSorter object.

Example Code

C++

Code snippets: snippets/Sort.cpp

ILMatchResultsPtr matchResults;
// ... do pattern matching
ILSorterPtr sorter = LSorter::Create();
sorter->RowSpace = 170;
sorter->ColumnSpace = 150;
sorter->ToleranceFactor = 1;
sorter->PositionMode = LPVPositionMode::LPVPosModeCenter;
// sort into an array
ILSortedArrayPtr sortedArray;
LPVErrorCode err = sorter->SortToArray2(ILSortables::Cast(matchResults), &sortedArray);

C#

Code snippets: snippets/Sort.cs

LMatchResults matchResults;
// ... do pattern matching
LSorter sorter = new LSorter();
sorter.RowSpace = 170;
sorter.ColumnSpace = 150;
sorter.ToleranceFactor = 1;
sorter.PositionMode = LPVPositionMode.LPVPosModeCenter;
// sort into an array
LSortedArray sortedArray;
LPVErrorCode err = sorter.SortToArray2((ILSortables)matchResults, out sortedArray);

COM

ILMatchResultsPtr matchResults;
// ... do pattern matching
ILSorterPtr sorter = LSorter::Create();
// or, ILSorterPtr sorter(__uuidof(LSorter)), for absence of built-in Create functions (before 2.2.0)
sorter->RowSpace = 170;
sorter->ColumnSpace = 150;
sorter->ToleranceFactor = 1;
sorter->PositionMode = LPVPositionMode::LPVPosModeCenter;
// sort into an array
ILSortedArrayPtr sortedArray;
LPVErrorCode err = sorter->SortToArray2((ILSortablesPtr)matchResults, &sortedArray);

Member Function Documentation

SortToArray()

LPVErrorCode SortToArray	(	ILSortables *	sortables,
		ILSortedArray **	sortedResult
	)

Sort the source sortable collection object to an sorted array for row and column indexing and metrics calculation via ILSortedArray interface.

Parameters

[in]	sortables	The input source object to be sorted which implemented ILSortable interface, such as LPoints, LMatchResults, LBlobResults, etc.
[out]	sortedResult	Return the sorted array.

Return values

error

Return error code if anything is wrong.

SortToArray2()

LPVErrorCode SortToArray2	(	LArray< ILSortable * >	sortableArray,
		ILSortedArray **	sortedResult
	)

Sort the source sortable objects to an sorted array for row and column indexing and metrics calculation via ILSortedArray interface.

Parameters

[in]	sortableArray	The input source sortable objects to be sorted, it should be objects that implemented ILSortable interface, such as: LLine, LMatchResult, LBarcodeResult, etc.
[out]	sortedResult	Return the sorted array.

Return values

error

Return error code if anything is wrong.