eVision.ESearchParamsType Class Reference

This class is instantiated once in each eVision.EMatrixCodeReader and represents the search parameters that are explored when reading a eVision.EMatrixCode. More...

Public Member Functions
None	AddLogicalSize (self, eVision.ELogicalSize searchLogicalSize)
	Adds a new logical size to the list of eVision.ELogicalSize the candidate is matched against at read time.
None	ClearLogicalSize (self)
	Clears the list of logical sizes the candidate is matched against at read time.
None	RemoveLogicalSize (self, eVision.ELogicalSize searchLogicalSize)
	Removes the logical size from the list of eVision.ELogicalSize the candidate is matched against at read time.
eVision.ELogicalSize	GetLogicalSize (self, int index)
	Gets an item in the list of eVision.ELogicalSize the candidate is matched against at read time.
None	AddContrast (self, eVision.EMatrixCodeContrastMode searchContrast)
	Adds a new contrast mode to the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.
None	ClearContrast (self)
	Clears the list of contrast modes the candidate is matched against at read time.
None	RemoveContrast (self, eVision.EMatrixCodeContrastMode searchContrast)
	Removes the contrast mode from the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.
eVision.EMatrixCodeContrastMode	GetContrast (self, int index)
	Gets an item in the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.
None	AddFlipping (self, eVision.EFlipping searchFlipping)
	Adds a new flipping to the list of eVision.EFlipping the candidate is matched against at read time.
None	ClearFlipping (self)
	Clears the list of flippings the candidate is matched against at read time.
None	RemoveFlipping (self, eVision.EFlipping searchFlipping)
	Removes the flipping from the list of eVision.EFlipping the candidate is matched against at read time.
eVision.EFlipping	GetFlipping (self, int index)
	Gets an item in the list of eVision.EFlipping the candidate is matched against at read time.
None	AddFamily (self, eVision.EFamily searchFamily)
	Adds a new family to the list of eVision.EFamily the candidate is matched against at read time.
None	ClearFamily (self)
	Clears the list of families the candidate is matched against at read time.
None	RemoveFamily (self, eVision.EFamily searchFamily)
	Removes the family from the list of eVision.EFamily the candidate is matched against at read time.
eVision.EFamily	GetFamily (self, int index)
	Gets an item in the list of eVision.EFamily the candidate is matched against at read time.
int	LogicalSizeCount (self)
	The size of the list of eVision.ELogicalSize the candidate is matched against at read time.
int	ContrastCount (self)
	The size of the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.
int	FlippingCount (self)
	The size of the list of eVision.EFlipping the candidate is matched against at read time.
int	FamilyCount (self)
	The size of the list of eVision.EFamily the candidate is matched against at read time.

Detailed Description

This class is instantiated once in each eVision.EMatrixCodeReader and represents the search parameters that are explored when reading a eVision.EMatrixCode.

Remarks:

This class contains 4 sets of search parameters that are scanned at read time. At eVision.EMatrixCodeReader construction time, these sets of values are initialized with all possible values. This means, for instance, that a data matrix code read in a freshly created reader is matched against all possible logical sizes. As a consequence, the default values of these sets are not repeated here. They are assumed to represent every possible search parameters. The eVision.ESearchParamsType object needs to be used only if you wish to "override" the learning process.

License(s): None

Deprecated

Deprecated in version 23.12. Scheduled to be removed in version 27.6.

Member Function Documentation

AddContrast()

None eVision.ESearchParamsType.AddContrast	(		self,
		eVision.EMatrixCodeContrastMode	searchContrast )

Adds a new contrast mode to the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

searchContrast

Contrast mode to add to the list.

AddFamily()

None eVision.ESearchParamsType.AddFamily	(		self,
		eVision.EFamily	searchFamily )

Adds a new family to the list of eVision.EFamily the candidate is matched against at read time.

Parameters

searchFamily

Family to add to the list.

AddFlipping()

None eVision.ESearchParamsType.AddFlipping	(		self,
		eVision.EFlipping	searchFlipping )

Adds a new flipping to the list of eVision.EFlipping the candidate is matched against at read time.

Parameters

searchFlipping

Flipping to add to the list.

AddLogicalSize()

None eVision.ESearchParamsType.AddLogicalSize	(		self,
		eVision.ELogicalSize	searchLogicalSize )

Adds a new logical size to the list of eVision.ELogicalSize the candidate is matched against at read time.

Parameters

searchLogicalSize

Logical size to add to the list.

ClearContrast()

None eVision.ESearchParamsType.ClearContrast

(

self

)

Clears the list of contrast modes the candidate is matched against at read time.

ClearFamily()

None eVision.ESearchParamsType.ClearFamily

(

self

)

Clears the list of families the candidate is matched against at read time.

ClearFlipping()

None eVision.ESearchParamsType.ClearFlipping

(

self

)

Clears the list of flippings the candidate is matched against at read time.

ClearLogicalSize()

None eVision.ESearchParamsType.ClearLogicalSize

(

self

)

Clears the list of logical sizes the candidate is matched against at read time.

ContrastCount()

int eVision.ESearchParamsType.ContrastCount

(

self

)

The size of the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.

FamilyCount()

int eVision.ESearchParamsType.FamilyCount

(

self

)

The size of the list of eVision.EFamily the candidate is matched against at read time.

FlippingCount()

int eVision.ESearchParamsType.FlippingCount

(

self

)

The size of the list of eVision.EFlipping the candidate is matched against at read time.

GetContrast()

eVision.EMatrixCodeContrastMode eVision.ESearchParamsType.GetContrast	(		self,
		int	index )

Gets an item in the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

index

Position in the list.

GetFamily()

eVision.EFamily eVision.ESearchParamsType.GetFamily	(		self,
		int	index )

Gets an item in the list of eVision.EFamily the candidate is matched against at read time.

Parameters

index

Position in the list.

GetFlipping()

eVision.EFlipping eVision.ESearchParamsType.GetFlipping	(		self,
		int	index )

Gets an item in the list of eVision.EFlipping the candidate is matched against at read time.

Parameters

index

Position in the list.

GetLogicalSize()

eVision.ELogicalSize eVision.ESearchParamsType.GetLogicalSize	(		self,
		int	index )

Gets an item in the list of eVision.ELogicalSize the candidate is matched against at read time.

Parameters

index

Position in the list.

LogicalSizeCount()

int eVision.ESearchParamsType.LogicalSizeCount

(

self

)

The size of the list of eVision.ELogicalSize the candidate is matched against at read time.

RemoveContrast()

None eVision.ESearchParamsType.RemoveContrast	(		self,
		eVision.EMatrixCodeContrastMode	searchContrast )

Removes the contrast mode from the list of eVision.EMatrixCodeContrastMode the candidate is matched against at read time.

Parameters

searchContrast

Contrast mode to remove from the list.

RemoveFamily()

None eVision.ESearchParamsType.RemoveFamily	(		self,
		eVision.EFamily	searchFamily )

Removes the family from the list of eVision.EFamily the candidate is matched against at read time.

Parameters

searchFamily

Family to remove from the list.

RemoveFlipping()

None eVision.ESearchParamsType.RemoveFlipping	(		self,
		eVision.EFlipping	searchFlipping )

Removes the flipping from the list of eVision.EFlipping the candidate is matched against at read time.

Parameters

searchFlipping

Flipping to remove from the list.

RemoveLogicalSize()

None eVision.ESearchParamsType.RemoveLogicalSize	(		self,
		eVision.ELogicalSize	searchLogicalSize )

Removes the logical size from the list of eVision.ELogicalSize the candidate is matched against at read time.

Parameters

searchLogicalSize

Logical size to remove from the list.