eVision.EStitchingGridOrder Class Reference

Defines the grid order when stitching in grid mode. More...

Public Member Functions
None	__init__ (self)
	Constructs a eVision.EStitchingGridOrder.__init__.
None	__init__ (self, eVision.EStitchingGridStartingCorner gridStartingCorner, eVision.EStitchingGridTraversal traversal)
	Constructs a eVision.EStitchingGridOrder.__init__.
bool	HasCustomTraversal (self)
	Gets if a custom traversal (list of ordered image coordinates) has been set.
None	ResetCustomTraversal (self)
	Resets the custom traversal.
None	SetCustomTraversal (self, int colCount, int rowCount, list[eVision._eVision.EIntPoint] coordinates)
	Sets the custom traversal.

Properties
	GridTraversal = property(_GridTraversal__getter, _GridTraversal__setter)
	Gets the type of grid traversal to apply.
	GridStartingCorner = property(_GridStartingCorner__getter, _GridStartingCorner__setter)
	Gets the grid position of the first image of the image list.
	CustomTraversal = property(_CustomTraversal__getter, None)
	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 |

Remarks:

License(s): EasyImage

Constructor & Destructor Documentation

__init__() [1/2]

None eVision.EStitchingGridOrder.__init__

(

self

)

Constructs a eVision.EStitchingGridOrder.__init__.

__init__() [2/2]

None eVision.EStitchingGridOrder.__init__	(		self,
		eVision.EStitchingGridStartingCorner	gridStartingCorner,
		eVision.EStitchingGridTraversal	traversal )

Constructs a eVision.EStitchingGridOrder.__init__.

Parameters

gridStartingCorner	Grid starting corner, the grid position of the first image of the image list.
traversal	Type of grid traversal to apply.

Member Function Documentation

HasCustomTraversal()

bool eVision.EStitchingGridOrder.HasCustomTraversal

(

self

)

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

ResetCustomTraversal()

None eVision.EStitchingGridOrder.ResetCustomTraversal

(

self

)

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()

None eVision.EStitchingGridOrder.SetCustomTraversal	(		self,
		int	colCount,
		int	rowCount,
		list[eVision._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

colCount	Number of column for the grid being specified.
rowCount	Number of row for the grid being specified.
coordinates	List of ordered 2D coordinates.

Property Documentation

CustomTraversal

eVision.EStitchingGridOrder.CustomTraversal = property(_CustomTraversal__getter, None)

static

Gets the custom traversal.

GridStartingCorner

eVision.EStitchingGridOrder.GridStartingCorner = property(_GridStartingCorner__getter, _GridStartingCorner__setter)

static

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

GridTraversal

eVision.EStitchingGridOrder.GridTraversal = property(_GridTraversal__getter, _GridTraversal__setter)

static

Gets the type of grid traversal to apply.