eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EasyDeepLearning::EDeepOCRToolResult Class Reference

Result for EDeepOCRTool. More...

#include <eVision/EasyDeepLearning/EasyDeepOCR/EDeepOCRToolResult.h>

Collaboration diagram for eVision::EasyDeepLearning::EDeepOCRToolResult:

Public Member Functions

 EDeepOCRToolResult ()
 Constructs a EDeepOCRToolResult.
 EDeepOCRToolResult (const eVision::EasyDeepLearning::EDeepOCRToolResult &other)
 Copy constructor of a EDeepOCRToolResult object.
virtual ~EDeepOCRToolResult () throw ()
eVision::EasyDeepLearning::EDeepOCRToolResult & operator= (const eVision::EasyDeepLearning::EDeepOCRToolResult &other)
 Assignment operator.
bool IsValid () const
 Whether the result is valid or not.
eVision::EasyDeepLearning::EDeepOCRModel GetModel () const
 The type of model for this result.
bool HasGroundTruth () const
 Whether the result object has an associated ground truth.
int32_t GetNumGroundTruthText () const
 Number of ground truth texts.
std::vector< eVision::EasyDeepOCR::ETextLine > GetGroundTruth () const
 Ground truth texts for the image.
float GetLocationThreshold () const
 Location threshold. Default value: 0.5.
void SetLocationThreshold (float val)
 Location threshold. Default value: 0.5.
int32_t GetNumAllLocationResults () const
 Number of texts box detected in the image, regardless of the threshold value.
int32_t GetNumThresholdedLocationResults () const
 Number of texts box detected in the image whose threshold is above EDeepOCRToolResult::GetLocationThreshold.
std::vector< bool > GetBoolOrientationResults () const
 Boolean vector whose indices correspond to correct text orientations.
std::vector< bool > GetBoolRecognitionResults () const
 Boolean vector whose indices correspond to correct text recognitions.
std::vector< eVision::ERectangle > GetThresholdedLocationResults () const
 Location results whose score are above EDeepOCRToolResult::GetLocationThreshold.
std::vector< float > GetThresholdedLocationScores () const
 Location scores for the results whose score are above EDeepOCRToolResult::GetLocationThreshold.
std::vector< eVision::ERectangle > GetAllLocationResults () const
 Location results.
std::vector< eVision::EasyDeepLearning::EClassificationResult > GetAllOrientationResults () const
 Orientation results.
std::vector< std::string > GetAllRecognitionResults () const
 Recognized text results.
std::vector< std::string > GetAllRecognitionGroundTruths () const
 Recognition ground truths.
std::vector< float > GetAllRecognitionScores () const
 Recognition scores.
std::vector< float > GetAllLocationScores () const
 Location scores.
void Load (const std::string &path)
 Loads the EDeepOCRToolResult. The given ESerializer must have been created for writing.
void Load (eVision::ESerializer *serializer)
 Loads the EDeepOCRToolResult. The given ESerializer must have been created for writing.
void Save (const std::string &path)
 Saves the EDeepOCRToolResult. The given ESerializer must have been created for writing.
void Save (eVision::ESerializer *serializer)
 Saves the EDeepOCRToolResult. The given ESerializer must have been created for writing.
 EDeepOCRToolResult (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Result for EDeepOCRTool.

License(s): EasyDeepOCR

Constructor & Destructor Documentation

◆ EDeepOCRToolResult() [1/3]

eVision::EasyDeepLearning::EDeepOCRToolResult::EDeepOCRToolResult ( )

Constructs a EDeepOCRToolResult.

◆ EDeepOCRToolResult() [2/3]

eVision::EasyDeepLearning::EDeepOCRToolResult::EDeepOCRToolResult ( const eVision::EasyDeepLearning::EDeepOCRToolResult & other)

Copy constructor of a EDeepOCRToolResult object.

Parameters
otherReference to the EDeepOCRToolResult object that should be copied

◆ ~EDeepOCRToolResult()

eVision::EasyDeepLearning::EDeepOCRToolResult::~EDeepOCRToolResult ( )
throw ( )
virtual

◆ EDeepOCRToolResult() [3/3]

eVision::EasyDeepLearning::EDeepOCRToolResult::EDeepOCRToolResult ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ GetAllLocationResults()

std::vector< eVision::ERectangle > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllLocationResults ( ) const

Location results.

◆ GetAllLocationScores()

std::vector< float > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllLocationScores ( ) const

Location scores.

◆ GetAllOrientationResults()

std::vector< eVision::EasyDeepLearning::EClassificationResult > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllOrientationResults ( ) const

Orientation results.

◆ GetAllRecognitionGroundTruths()

std::vector< std::string > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllRecognitionGroundTruths ( ) const

Recognition ground truths.

◆ GetAllRecognitionResults()

std::vector< std::string > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllRecognitionResults ( ) const

Recognized text results.

◆ GetAllRecognitionScores()

std::vector< float > eVision::EasyDeepLearning::EDeepOCRToolResult::GetAllRecognitionScores ( ) const

Recognition scores.

◆ GetBoolOrientationResults()

std::vector< bool > eVision::EasyDeepLearning::EDeepOCRToolResult::GetBoolOrientationResults ( ) const

Boolean vector whose indices correspond to correct text orientations.

◆ GetBoolRecognitionResults()

std::vector< bool > eVision::EasyDeepLearning::EDeepOCRToolResult::GetBoolRecognitionResults ( ) const

Boolean vector whose indices correspond to correct text recognitions.

◆ GetGroundTruth()

std::vector< eVision::EasyDeepOCR::ETextLine > eVision::EasyDeepLearning::EDeepOCRToolResult::GetGroundTruth ( ) const

Ground truth texts for the image.

◆ GetLocationThreshold()

float eVision::EasyDeepLearning::EDeepOCRToolResult::GetLocationThreshold ( ) const

Location threshold. Default value: 0.5.

The threshold must be between 0.0 and 1.

◆ GetModel()

eVision::EasyDeepLearning::EDeepOCRModel eVision::EasyDeepLearning::EDeepOCRToolResult::GetModel ( ) const

The type of model for this result.

◆ GetNumAllLocationResults()

int32_t eVision::EasyDeepLearning::EDeepOCRToolResult::GetNumAllLocationResults ( ) const

Number of texts box detected in the image, regardless of the threshold value.

◆ GetNumGroundTruthText()

int32_t eVision::EasyDeepLearning::EDeepOCRToolResult::GetNumGroundTruthText ( ) const

Number of ground truth texts.

◆ GetNumThresholdedLocationResults()

int32_t eVision::EasyDeepLearning::EDeepOCRToolResult::GetNumThresholdedLocationResults ( ) const

Number of texts box detected in the image whose threshold is above EDeepOCRToolResult::GetLocationThreshold.

◆ GetThresholdedLocationResults()

std::vector< eVision::ERectangle > eVision::EasyDeepLearning::EDeepOCRToolResult::GetThresholdedLocationResults ( ) const

Location results whose score are above EDeepOCRToolResult::GetLocationThreshold.

◆ GetThresholdedLocationScores()

std::vector< float > eVision::EasyDeepLearning::EDeepOCRToolResult::GetThresholdedLocationScores ( ) const

Location scores for the results whose score are above EDeepOCRToolResult::GetLocationThreshold.

◆ HasGroundTruth()

bool eVision::EasyDeepLearning::EDeepOCRToolResult::HasGroundTruth ( ) const

Whether the result object has an associated ground truth.

◆ IsValid()

bool eVision::EasyDeepLearning::EDeepOCRToolResult::IsValid ( ) const

Whether the result is valid or not.

◆ Load() [1/2]

void eVision::EasyDeepLearning::EDeepOCRToolResult::Load ( const std::string & path)

Loads the EDeepOCRToolResult. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Load() [2/2]

void eVision::EasyDeepLearning::EDeepOCRToolResult::Load ( eVision::ESerializer * serializer)

Loads the EDeepOCRToolResult. The given ESerializer must have been created for writing.

Parameters
serializerThe serializer.

◆ operator=()

eVision::EasyDeepLearning::EDeepOCRToolResult & eVision::EasyDeepLearning::EDeepOCRToolResult::operator= ( const eVision::EasyDeepLearning::EDeepOCRToolResult & other)

Assignment operator.

Parameters
otherReference to the EDeepOCRToolResult object that should be copied

◆ Save() [1/2]

void eVision::EasyDeepLearning::EDeepOCRToolResult::Save ( const std::string & path)

Saves the EDeepOCRToolResult. The given ESerializer must have been created for writing.

Parameters
pathThe file path.

◆ Save() [2/2]

void eVision::EasyDeepLearning::EDeepOCRToolResult::Save ( eVision::ESerializer * serializer)

Saves the EDeepOCRToolResult. The given ESerializer must have been created for writing.

Parameters
serializerThe serializer.

◆ SetLocationThreshold()

void eVision::EasyDeepLearning::EDeepOCRToolResult::SetLocationThreshold ( float val)

Location threshold. Default value: 0.5.

The threshold must be between 0.0 and 1.

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EasyDeepLearning::EDeepOCRToolResult::wrappedClass_