eVision.EasyDeepOCR.ESampleList Class Reference

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 ETextReader.Read on this image. A ESampleList is meant to be used with ETextReader.Optimize, to specialize and increase the processing speed of subsequent calls to ETextReader.Read. For the ESampleList to be consistent, all the texts must belong to the same context, i.e. all the texts must share similar geometrical properties. More...

Inheritance diagram for eVision.EasyDeepOCR.ESampleList:

Collaboration diagram for eVision.EasyDeepOCR.ESampleList:

Public Member Functions
	ESampleList ()
	Creates a ESampleList.
	ESampleList (eVision.EasyDeepOCR.ESampleList other)
	Creates a ESampleList.
	ESampleList (eVision.EasyDeepOCR.ESample[] samples)
	Creates a ESampleList.
bool	IsEqual (eVision.EasyDeepOCR.ESampleList other)
	Checks if this ESampleList instance is strictly equal to another ESampleList instance.
void	Load (string path)
	Loads the ESampleList.
void	Load (eVision.ESerializer serializer)
	Loads the ESampleList.
void	Save (string path)
	Saves the ESampleList.
void	Save (eVision.ESerializer serializer)
	Saves the ESampleList.
void	ReplaceBasePath (string oldBasePath, string newBasePath)
	Replaces the old base path with a new base path in the image path of all ESample of the list. Throws if the old base path is not contained in one of the image paths.

Properties
string	CommonBasePath [get]
	Returns the longuest base path shared by the all the image paths of the ESample in the list.
eVision.EasyDeepOCR.ESample[]	Samples [get, set]
	List of ESample.
eVision.EImageType	AutomaticImageType [get]
	Returns the automatically deduced type of the sample images, provided it is the same for all samples in the list. Throws an exception otherwise.

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 ETextReader.Read on this image. A ESampleList is meant to be used with ETextReader.Optimize, to specialize and increase the processing speed of subsequent calls to ETextReader.Read. For the ESampleList to be consistent, all the texts must belong to the same context, i.e. all the texts must share similar geometrical properties.

License(s): EasyDeepOCR

Constructor & Destructor Documentation

ESampleList() [1/3]

eVision.EasyDeepOCR.ESampleList.ESampleList

(

)

Creates a ESampleList.

ESampleList() [2/3]

eVision.EasyDeepOCR.ESampleList.ESampleList

(

eVision.EasyDeepOCR.ESampleList

other

)

Creates a ESampleList.

Parameters

other

Another ESampleList to be copied in the new ESampleList.

ESampleList() [3/3]

eVision.EasyDeepOCR.ESampleList.ESampleList

(

eVision.EasyDeepOCR.ESample[]

samples

)

Creates a ESampleList.

Parameters

samples

List of ESample to add to the ESampleList.

Member Function Documentation

IsEqual()

bool eVision.EasyDeepOCR.ESampleList.IsEqual

(

eVision.EasyDeepOCR.ESampleList

other

)

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

Parameters

other

Reference to the ESampleList instance to compare with

Load() [1/2]

void eVision.EasyDeepOCR.ESampleList.Load

(

eVision.ESerializer

serializer

)

Loads the ESampleList.

Parameters

serializer

Load() [2/2]

void eVision.EasyDeepOCR.ESampleList.Load

(

string

path

)

Loads the ESampleList.

Parameters

path	Path where to save the ESampleList.

ReplaceBasePath()

void eVision.EasyDeepOCR.ESampleList.ReplaceBasePath	(	string	oldBasePath,
		string	newBasePath )

Replaces the old base path with a new base path in the image path of all 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.

Save() [1/2]

void eVision.EasyDeepOCR.ESampleList.Save

(

eVision.ESerializer

serializer

)

Saves the ESampleList.

Parameters

serializer

Save() [2/2]

void eVision.EasyDeepOCR.ESampleList.Save

(

string

path

)

Saves the ESampleList.

Parameters

path	Path where to save the ESampleList.

Property Documentation

AutomaticImageType

eVision.EImageType eVision.EasyDeepOCR.ESampleList.AutomaticImageType

get

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

string eVision.EasyDeepOCR.ESampleList.CommonBasePath

get

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

Samples

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

getset

List of ESample.