A sample is composed of an image, and optionally a region, together with one or several texts, which are visible in the image. These texts indicate what outputs are expected when calling ETextReader.Read on this image. A ESample is only meant to be contained in ESampleList. More...

Inheritance diagram for eVision.EasyDeepOCR.ESample:

[legend]

Collaboration diagram for eVision.EasyDeepOCR.ESample:

[legend]

Public Member Functions
	ESample ()
	Creates a ESample.
	ESample (eVision.EasyDeepOCR.ESample other)
	Creates a ESample.
	ESample (string path)
	Creates a ESample.
	ESample (string path, eVision.EasyDeepOCR.EText[] texts)
	Creates a ESample.
	ESample (string path, eVision.ERegion region)
	Creates a ESample.
	ESample (string path, eVision.ERegion region, eVision.EasyDeepOCR.EText[] texts)
	Creates a ESample.
bool	IsEqual (eVision.EasyDeepOCR.ESample other)
	Checks if this ESample instance is strictly equal to another ESample instance.
void	Load (string path)
	Loads the ESample.
void	Load (eVision.ESerializer serializer)
	Loads the ESample.
void	Save (string path)
	Saves the ESample.
void	Save (eVision.ESerializer serializer)
	Saves the ESample.
eVision.EBaseROI	GetImage (eVision.EImageType imageType)
	Returns the image of the sample.
eVision.EBaseROI	GetROI (eVision.EImageType imageType)
	Returns the ROI enclosing the region of the sample. If no region is defined, the full image is returned.
void	ReplaceBasePath (string oldBasePath, string newBasePath)
	Replaces the old base path with a new base path in the image path. Throws if the old base path is not contained in the image path.

Properties
eVision.EBaseROI	Image `[get]`
	Returns the image of the sample.
eVision.EBaseROI	ROI `[get]`
	Returns the ROI enclosing the region of the sample. If no region is defined, the full image is returned.
eVision.EImageType	AutomaticImageType `[get]`
	Returns the image type of ESample.GetImage when called without arguments.
string	ImagePath `[get, set]`
	Path to the image of the sample.
eVision.EasyDeepOCR.EText[]	Texts `[get, set]`
	List of texts.
eVision.ERegion	Region `[get, set]`
	Region of the sample.
bool	HasRegion `[get]`
	Returns whether there is a region attached to this sample.

Detailed Description

A sample is composed of an image, and optionally a region, together with one or several texts, which are visible in the image. These texts indicate what outputs are expected when calling ETextReader.Read on this image. A ESample is only meant to be contained in ESampleList.

License(s): EasyDeepOCR

Constructor & Destructor Documentation

◆ ESample() [1/6]

eVision.EasyDeepOCR.ESample.ESample ( )

Creates a ESample.

◆ ESample() [2/6]

eVision.EasyDeepOCR.ESample.ESample ( eVision.EasyDeepOCR.ESample other )

Creates a ESample.

Parameters

other Another ESample to be copied in the new ESample.

◆ ESample() [3/6]

eVision.EasyDeepOCR.ESample.ESample ( string path )

Creates a ESample.

Parameters

path	Path to the image.

◆ ESample() [4/6]

eVision.EasyDeepOCR.ESample.ESample	(	string	path,
		eVision.EasyDeepOCR.EText[]	texts )

Creates a ESample.

Parameters

path	Path to the image.
texts	Texts of interest.

◆ ESample() [5/6]

eVision.EasyDeepOCR.ESample.ESample	(	string	path,
		eVision.ERegion	region )

Creates a ESample.

Parameters

path	Path to the image.
region	Region containing the texts of interest.

◆ ESample() [6/6]

eVision.EasyDeepOCR.ESample.ESample	(	string	path,
		eVision.ERegion	region,
		eVision.EasyDeepOCR.EText[]	texts )

Creates a ESample.

Parameters

path	Path to the image.
region	Region containing the texts of interest.
texts	Texts of interest.

Member Function Documentation

◆ GetImage()

eVision.EBaseROI eVision.EasyDeepOCR.ESample.GetImage ( eVision.EImageType imageType )

Returns the image of the sample.

Parameters

imageType Specifies the image type for loading the sample image. If not provided, the image type will be automatically determined based on the sample image files.

◆ GetROI()

eVision.EBaseROI eVision.EasyDeepOCR.ESample.GetROI ( eVision.EImageType imageType )

Returns the ROI enclosing the region of the sample. If no region is defined, the full image is returned.

Parameters

imageType Specifies the image type for loading the sample image. If not provided, the image type will be automatically determined based on the sample image files.

◆ IsEqual()

bool eVision.EasyDeepOCR.ESample.IsEqual ( eVision.EasyDeepOCR.ESample other )

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

Parameters

other Reference to the ESample instance to compare with

◆ Load() [1/2]

void eVision.EasyDeepOCR.ESample.Load ( eVision.ESerializer serializer )

Loads the ESample.

Parameters

serializer

◆ Load() [2/2]

void eVision.EasyDeepOCR.ESample.Load ( string path )

Loads the ESample.

Parameters

path	Path where to save the ESample.

◆ ReplaceBasePath()

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

Replaces the old base path with a new base path in the image path. Throws if the old base path is not contained in the image path.

Parameters

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

◆ Save() [1/2]

void eVision.EasyDeepOCR.ESample.Save ( eVision.ESerializer serializer )

Saves the ESample.

Parameters

serializer

◆ Save() [2/2]

void eVision.EasyDeepOCR.ESample.Save ( string path )

Saves the ESample.

Parameters

path	Path where to save the ESample.

Property Documentation

◆ AutomaticImageType

eVision.EImageType eVision.EasyDeepOCR.ESample.AutomaticImageType

get

Returns the image type of ESample.GetImage when called without arguments.

◆ HasRegion

bool eVision.EasyDeepOCR.ESample.HasRegion

get

Returns whether there is a region attached to this sample.

◆ Image

eVision.EBaseROI eVision.EasyDeepOCR.ESample.Image

get

Returns the image of the sample.

◆ ImagePath

string eVision.EasyDeepOCR.ESample.ImagePath

getset

Path to the image of the sample.

◆ Region

eVision.ERegion eVision.EasyDeepOCR.ESample.Region

getset

Region of the sample.

◆ ROI

eVision.EBaseROI eVision.EasyDeepOCR.ESample.ROI

get

Returns the ROI enclosing the region of the sample. If no region is defined, the full image is returned.

◆ Texts

eVision.EasyDeepOCR.EText [] eVision.EasyDeepOCR.ESample.Texts

getset

List of texts.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ ESample() [1/6]

◆ ESample() [2/6]

◆ ESample() [3/6]

◆ ESample() [4/6]

◆ ESample() [5/6]

◆ ESample() [6/6]

Member Function Documentation

◆ GetImage()

◆ GetROI()

◆ IsEqual()

◆ Load() [1/2]

◆ Load() [2/2]

◆ ReplaceBasePath()

◆ Save() [1/2]

◆ Save() [2/2]

Property Documentation

◆ AutomaticImageType

◆ HasRegion

◆ Image

◆ ImagePath

◆ Region

◆ ROI

◆ Texts