eVision.EasyDeepOCR.ESampleList Class Reference

Holds a list of samples. More...

Public Member Functions
None	__init__ (self)
	Creates a eVision.EasyDeepOCR.ESampleList.
None	__init__ (self, eVision.EasyDeepOCR.ESampleList other)
	Creates a eVision.EasyDeepOCR.ESampleList.
None	__init__ (self, list[eVision._eVision.EasyDeepOCR.ESample] samples)
	Creates a eVision.EasyDeepOCR.ESampleList.
bool	IsEqual (self, eVision.EasyDeepOCR.ESampleList other)
	Checks if this eVision.EasyDeepOCR.ESampleList instance is strictly equal to another eVision.EasyDeepOCR.ESampleList instance.
None	Load (self, str path)
	Loads the eVision.EasyDeepOCR.ESampleList.
None	Load (self, eVision.ESerializer|None serializer)
	Loads the eVision.EasyDeepOCR.ESampleList.
None	Save (self, str path)
	Saves the eVision.EasyDeepOCR.ESampleList.
None	Save (self, eVision.ESerializer|None serializer)
	Saves the eVision.EasyDeepOCR.ESampleList.
None	ReplaceBasePath (self, str oldBasePath, str newBasePath)
	Replaces the old base path with a new base path in the image path of all eVision.EasyDeepOCR.ESample of the list.
str	CommonBasePath (self)
	Returns the longuest base path shared by the all the image paths of the eVision.EasyDeepOCR.ESample in the list.
list[eVision._eVision.EasyDeepOCR.ESample]	Samples (self)
	List of eVision.EasyDeepOCR.ESample.
	Samples (self, list[eVision._eVision.EasyDeepOCR.ESample] value)
	List of eVision.EasyDeepOCR.ESample.
eVision.EImageType	AutomaticImageType (self)
	Returns the automatically deduced type of the sample images, provided it is the same for all samples in the list.

Detailed Description

Holds a list of samples.

A sample is composed of an image, and optionally a region, together with one or several text strings of interests. These text strings indicate what outputs are expected when calling eVision.EasyDeepOCR.ETextReader.Read on this image. A eVision.EasyDeepOCR.ESampleList is meant to be used with eVision.EasyDeepOCR.ETextReader.Optimize, to specialize and increase the processing speed of subsequent calls to eVision.EasyDeepOCR.ETextReader.Read. For the eVision.EasyDeepOCR.ESampleList to be consistent, all the texts must belong to the same context, i.e. all the texts must share similar geometrical properties.

Remarks:

License(s): EasyDeepOCR

Constructor & Destructor Documentation

__init__() [1/3]

None eVision.EasyDeepOCR.ESampleList.__init__

(

self

)

Creates a eVision.EasyDeepOCR.ESampleList.

__init__() [2/3]

None eVision.EasyDeepOCR.ESampleList.__init__	(		self,
		eVision.EasyDeepOCR.ESampleList	other )

Creates a eVision.EasyDeepOCR.ESampleList.

Parameters

other

Another eVision.EasyDeepOCR.ESampleList to be copied in the new eVision.EasyDeepOCR.ESampleList.

__init__() [3/3]

None eVision.EasyDeepOCR.ESampleList.__init__	(		self,
		list[eVision._eVision.EasyDeepOCR.ESample]	samples )

Creates a eVision.EasyDeepOCR.ESampleList.

Parameters

samples

List of eVision.EasyDeepOCR.ESample to add to the eVision.EasyDeepOCR.ESampleList.

Member Function Documentation

AutomaticImageType()

eVision.EImageType eVision.EasyDeepOCR.ESampleList.AutomaticImageType

(

self

)

Returns the automatically deduced type of the sample images, provided it is the same for all samples in the list.

Throws an exception otherwise.

CommonBasePath()

str eVision.EasyDeepOCR.ESampleList.CommonBasePath

(

self

)

Returns the longuest base path shared by the all the image paths of the eVision.EasyDeepOCR.ESample in the list.

IsEqual()

bool eVision.EasyDeepOCR.ESampleList.IsEqual	(		self,
		eVision.EasyDeepOCR.ESampleList	other )

Checks if this eVision.EasyDeepOCR.ESampleList instance is strictly equal to another eVision.EasyDeepOCR.ESampleList instance.

Parameters

other

Reference to the eVision.EasyDeepOCR.ESampleList instance to compare with

Load() [1/2]

None eVision.EasyDeepOCR.ESampleList.Load	(		self,
		eVision.ESerializer | None	serializer )

Loads the eVision.EasyDeepOCR.ESampleList.

Parameters

serializer

-

Load() [2/2]

None eVision.EasyDeepOCR.ESampleList.Load	(		self,
		str	path )

Loads the eVision.EasyDeepOCR.ESampleList.

Parameters

path	Path where to save the eVision.EasyDeepOCR.ESampleList.

ReplaceBasePath()

None eVision.EasyDeepOCR.ESampleList.ReplaceBasePath	(		self,
		str	oldBasePath,
		str	newBasePath )

Replaces the old base path with a new base path in the image path of all eVision.EasyDeepOCR.ESample of the list.

Throws if the old base path is not contained in one of the image paths.

Parameters

oldBasePath	Old base path to be replaced.
newBasePath	New path to replace the old base path with.

Samples() [1/2]

list[eVision._eVision.EasyDeepOCR.ESample] eVision.EasyDeepOCR.ESampleList.Samples

(

self

)

List of eVision.EasyDeepOCR.ESample.

Samples() [2/2]

eVision.EasyDeepOCR.ESampleList.Samples	(		self,
		list[eVision._eVision.EasyDeepOCR.ESample]	value )

List of eVision.EasyDeepOCR.ESample.

Save() [1/2]

None eVision.EasyDeepOCR.ESampleList.Save	(		self,
		eVision.ESerializer | None	serializer )

Saves the eVision.EasyDeepOCR.ESampleList.

Parameters

serializer

-

Save() [2/2]

None eVision.EasyDeepOCR.ESampleList.Save	(		self,
		str	path )

Saves the eVision.EasyDeepOCR.ESampleList.

Parameters

path	Path where to save the eVision.EasyDeepOCR.ESampleList.