eVision::EOCR2CharacterDatabase Class Reference

Holds all information related to a character database. More...

#include <eVision/EasyOcr/EasyOCR2/EOCR2CharacterDatabase.h>

Collaboration diagram for eVision::EOCR2CharacterDatabase:

Public Member Functions
	EOCR2CharacterDatabase ()
	Constructs an EOCR2CharacterDatabase context.
	EOCR2CharacterDatabase (const eVision::EOCR2CharacterDatabase &other)
	Constructs an EOCR2CharacterDatabase context.
virtual	~EOCR2CharacterDatabase () throw ()
eVision::EOCR2CharacterDatabase &	operator= (const eVision::EOCR2CharacterDatabase &other)
	Copies all the data from another EOCR2CharacterDatabase object into the current EOCR2CharacterDatabase object.
void	AddCharacter (const eVision::EOCR2DatabaseCharacter &character)
	Adds a single character to the database.
void	AddCharacter (const eVision::EOCR2Char &character)
	Adds a single character to the database.
void	AddCharacters (const std::vector< eVision::EOCR2DatabaseCharacter > &characters)
	Add characters to the database.
void	AddCharacters (const std::string &path)
	Add characters to the database.
void	AddCharacters (const std::string &path, eVision::EasyOCR2CharacterFilter filter)
	Add characters to the database.
void	AddCharacters (const eVision::EOCR2Word &word)
	Add characters to the database.
void	AddCharacters (const eVision::EOCR2Line &line)
	Add characters to the database.
void	AddCharacters (const eVision::EOCR2Text &text)
	Add characters to the database.
void	RemoveCharacter (int32_t index)
	Removes a character from the database.
eVision::EOCR2DatabaseCharacter	GetCharacter (int32_t index)
	Returns a character from the database.
std::vector< eVision::EOCR2DatabaseCharacter >	GetCharacters ()
	Returns all character from the database.
std::vector< eVision::EOCR2CharacterCluster >	ClusterDatabase (int32_t nClusters) const
	Performs a clustering on the database.
void	AddCluster (const eVision::EOCR2CharacterCluster &cluster)
	Adds the characters from an EOCR2CharacterCluster to the database.
void	AddClusters (const std::vector< eVision::EOCR2CharacterCluster > &clusters)
	Adds the characters from a vector of EOCR2CharacterCluster objects to the database.
void	ClearDatabase ()
	Clears the database.
void	Load (const std::string &path)
	Load the character database from disk.
void	Load (eVision::ESerializer *serializer)
	Load the character database from disk.
void	Save (const std::string &path)
	Saves the character database to disk.
void	Save (eVision::ESerializer *serializer)
	Saves the character database to disk.
	EOCR2CharacterDatabase (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

Holds all information related to a character database.

License(s): None

Constructor & Destructor Documentation

EOCR2CharacterDatabase() [1/3]

eVision::EOCR2CharacterDatabase::EOCR2CharacterDatabase

(

)

Constructs an EOCR2CharacterDatabase context.

EOCR2CharacterDatabase() [2/3]

eVision::EOCR2CharacterDatabase::EOCR2CharacterDatabase

(

const eVision::EOCR2CharacterDatabase &

other

)

Constructs an EOCR2CharacterDatabase context.

Parameters

other

EOCR2CharacterDatabase object to be copied.

~EOCR2CharacterDatabase()

eVision::EOCR2CharacterDatabase::~EOCR2CharacterDatabase ( ) throw (  )

virtual

EOCR2CharacterDatabase() [3/3]

eVision::EOCR2CharacterDatabase::EOCR2CharacterDatabase

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

AddCharacter() [1/2]

void eVision::EOCR2CharacterDatabase::AddCharacter

(

const eVision::EOCR2Char &

character

)

Adds a single character to the database.

Parameters

character

The EOCR2DatabaseCharacter or EOCR2Char to be added to the database.

AddCharacter() [2/2]

void eVision::EOCR2CharacterDatabase::AddCharacter

(

const eVision::EOCR2DatabaseCharacter &

character

)

Adds a single character to the database.

Parameters

character

The EOCR2DatabaseCharacter or EOCR2Char to be added to the database.

AddCharacters() [1/6]

void eVision::EOCR2CharacterDatabase::AddCharacters

(

const eVision::EOCR2Line &

line

)

Add characters to the database.

Parameters

line	An EOCR2Line object to be added to this database.

AddCharacters() [2/6]

void eVision::EOCR2CharacterDatabase::AddCharacters

(

const eVision::EOCR2Text &

text

)

Add characters to the database.

Parameters

text	An EOCR2Text object to be added to this database.

AddCharacters() [3/6]

void eVision::EOCR2CharacterDatabase::AddCharacters

(

const eVision::EOCR2Word &

word

)

Add characters to the database.

Parameters

word	An EOCR2Word object to be added to this database.

AddCharacters() [4/6]

void eVision::EOCR2CharacterDatabase::AddCharacters

(

const std::string &

path

)

Add characters to the database.

Parameters

path	The path on disk of the character database to be added to this database.

AddCharacters() [5/6]

void eVision::EOCR2CharacterDatabase::AddCharacters	(	const std::string &	path,
		eVision::EasyOCR2CharacterFilter	filter )

Add characters to the database.

Parameters

path	The path on disk of the character database to be added to this database.
filter	An EasyOCR2CharacterFilter that tells the method which subset of the character-set should be loaded.

AddCharacters() [6/6]

void eVision::EOCR2CharacterDatabase::AddCharacters

(

const std::vector< eVision::EOCR2DatabaseCharacter > &

characters

)

Add characters to the database.

Parameters

characters

A vector of EOCR2DatabaseCharacter objects to be added to this database.

AddCluster()

void eVision::EOCR2CharacterDatabase::AddCluster

(

const eVision::EOCR2CharacterCluster &

cluster

)

Adds the characters from an EOCR2CharacterCluster to the database.

Parameters

cluster

The EOCR2CharacterCluster to be added to the database.

The characters in the cluster should be checked and assigned their correct code before adding them to the database

AddClusters()

void eVision::EOCR2CharacterDatabase::AddClusters

(

const std::vector< eVision::EOCR2CharacterCluster > &

clusters

)

Adds the characters from a vector of EOCR2CharacterCluster objects to the database.

Parameters

clusters

The vector of EOCR2CharacterCluster objects to be added to the database.

The characters in the clusters should be checked and assigned their correct code before adding them to the database

ClearDatabase()

void eVision::EOCR2CharacterDatabase::ClearDatabase

(

)

Clears the database.

ClusterDatabase()

std::vector< eVision::EOCR2CharacterCluster > eVision::EOCR2CharacterDatabase::ClusterDatabase

(

int32_t

nClusters

)

const

Performs a clustering on the database.

Parameters

nClusters

The amount of clusters to be generated.

GetCharacter()

eVision::EOCR2DatabaseCharacter eVision::EOCR2CharacterDatabase::GetCharacter

(

int32_t

index

)

Returns a character from the database.

Parameters

index

The index of the character to be returned.

GetCharacters()

std::vector< eVision::EOCR2DatabaseCharacter > eVision::EOCR2CharacterDatabase::GetCharacters

(

)

Returns all character from the database.

Load() [1/2]

void eVision::EOCR2CharacterDatabase::Load

(

const std::string &

path

)

Load the character database from disk.

Parameters

path	The path of the file.

Load() [2/2]

void eVision::EOCR2CharacterDatabase::Load

(

eVision::ESerializer *

serializer

)

Load the character database from disk.

Parameters

serializer

The serializer.

operator=()

eVision::EOCR2CharacterDatabase & eVision::EOCR2CharacterDatabase::operator=

(

const eVision::EOCR2CharacterDatabase &

other

)

Copies all the data from another EOCR2CharacterDatabase object into the current EOCR2CharacterDatabase object.

Parameters

other

EOCR2CharacterDatabase object to be copied

RemoveCharacter()

void eVision::EOCR2CharacterDatabase::RemoveCharacter

(

int32_t

index

)

Removes a character from the database.

Parameters

index

The index of the character to be removed.

Save() [1/2]

void eVision::EOCR2CharacterDatabase::Save

(

const std::string &

path

)

Saves the character database to disk.

Parameters

path	The path of the file.

Save() [2/2]

void eVision::EOCR2CharacterDatabase::Save

(

eVision::ESerializer *

serializer

)

Saves the character database to disk.

Parameters

serializer

The serializer.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EOCR2CharacterDatabase::wrappedClass_