eVision .NET API
Loading...
Searching...
No Matches
eVision.EStitchingGridOrder Class Reference

Defines the grid order when stitching in grid mode. The grid order is used to convert a linear index into coordinates. More...

Inheritance diagram for eVision.EStitchingGridOrder:
Collaboration diagram for eVision.EStitchingGridOrder:

Public Member Functions

 EStitchingGridOrder ()
 Constructs a EStitchingGridOrder.EStitchingGridOrder.
 EStitchingGridOrder (eVision.EStitchingGridStartingCorner gridStartingCorner, eVision.EStitchingGridTraversal traversal)
 Constructs a EStitchingGridOrder.EStitchingGridOrder.
bool HasCustomTraversal ()
 Gets if a custom traversal (list of ordered image coordinates) has been set.
void ResetCustomTraversal ()
 Resets the custom traversal. If none are set or if the type of traversal is not set before using this class instance in the EImageStitcher an exception will be thrown.
void SetCustomTraversal (int colCount, int rowCount, eVision.EIntPoint[] coordinates)
 Sets the custom traversal. The coordinates to specify is an ordered list of 2D coordinates where each image at index i is placed at the position (x, y) in the grid.

Properties

eVision.EStitchingGridTraversal GridTraversal [get, set]
 Gets the type of grid traversal to apply.
eVision.EStitchingGridStartingCorner GridStartingCorner [get, set]
 Gets the grid position of the first image of the image list.
eVision.EIntPoint[] CustomTraversal [get]
 Gets the custom traversal.

Detailed Description

Defines the grid order when stitching in grid mode. The grid order is used to convert a linear index into coordinates.

Two values are used to define the traversal. Here are some configuration examples:

  • GridTraversal = EStitchingGridDirection_RowMajor and GridStartingCorner = EStitchingGridStartingCorner_TopLeft. This is the default grid order configuration. | 0 | 1 | 2 | 3 | | 4 | 5 | 6 | 7 | | 8 | 9 | 10 | 11 |
  • GridTraversal = EStitchingGridDirection_ColumnMajor and GridStartingCorner = EStitchingGridStartingCorner_BottomRight. | 11 | 8 | 5 | 2 | | 10 | 7 | 4 | 1 | | 9 | 6 | 3 | 0 |
  • GridTraversal = EStitchingGridDirection_ColumnMajor_Snail and GridStartingCorner = EStitchingGridStartingCorner_BottomLeft. | 2 | 3 | 8 | 9 | | 1 | 4 | 7 | 10 | | 0 | 5 | 6 | 11 |

License(s): EasyImage

Constructor & Destructor Documentation

◆ EStitchingGridOrder() [1/2]

eVision.EStitchingGridOrder.EStitchingGridOrder ( )

◆ EStitchingGridOrder() [2/2]

eVision.EStitchingGridOrder.EStitchingGridOrder ( eVision.EStitchingGridStartingCorner gridStartingCorner,
eVision.EStitchingGridTraversal traversal )

Constructs a EStitchingGridOrder.EStitchingGridOrder.

Parameters
gridStartingCornerGrid starting corner, the grid position of the first image of the image list.
traversalType of grid traversal to apply.

Member Function Documentation

◆ HasCustomTraversal()

bool eVision.EStitchingGridOrder.HasCustomTraversal ( )

Gets if a custom traversal (list of ordered image coordinates) has been set.

◆ ResetCustomTraversal()

void eVision.EStitchingGridOrder.ResetCustomTraversal ( )

Resets the custom traversal. If none are set or if the type of traversal is not set before using this class instance in the EImageStitcher an exception will be thrown.

◆ SetCustomTraversal()

void eVision.EStitchingGridOrder.SetCustomTraversal ( int colCount,
int rowCount,
eVision.EIntPoint[] coordinates )

Sets the custom traversal. The coordinates to specify is an ordered list of 2D coordinates where each image at index i is placed at the position (x, y) in the grid.

In the following example, we have a 3 by 3 grid where the traversal resembles a spiral:

| 6 | 7 | 8 | | 5 | 0 | 1 | | 4 | 3 | 2 |

The coordinates list to pass as arguments will look like (in pseudocode):

coordinates = [
(1, 1), // 0
(2, 1), // 1
(2, 2), // 2
(1, 2), // 3
(0, 2), // 4
(0, 1), // 5
(0, 0), // 6
(1, 0), // 7
(2, 0), // 8
]

Each coordinate must be unique and the x and y components must be contained in [0, colCount[ and [0, rowCount[ respectively.

Parameters
colCountNumber of column for the grid being specified.
rowCountNumber of row for the grid being specified.
coordinatesList of ordered 2D coordinates.

Property Documentation

◆ CustomTraversal

eVision.EIntPoint [] eVision.EStitchingGridOrder.CustomTraversal
get

Gets the custom traversal.

◆ GridStartingCorner

eVision.EStitchingGridStartingCorner eVision.EStitchingGridOrder.GridStartingCorner
getset

Gets the grid position of the first image of the image list.

◆ GridTraversal

eVision.EStitchingGridTraversal eVision.EStitchingGridOrder.GridTraversal
getset

Gets the type of grid traversal to apply.