eVision Python API
Loading...
Searching...
No Matches
eVision.EasyDeepOCR.ETextReader Class Reference

A eVision.EasyDeepOCR.ETextReader aims to find and read texts inside a given ROI, through eVision.EasyDeepOCR.ETextReader.Read. More...

Public Member Functions

None __init__ (self)
 Creates a eVision.EasyDeepOCR.ETextReader.
None __init__ (self, eVision.EasyDeepOCR.ETextReader other)
 Creates a eVision.EasyDeepOCR.ETextReader.
bool IsEqual (self, eVision.EasyDeepOCR.ETextReader other)
 Checks if this eVision.EasyDeepOCR.ETextReader instance is strictly equal to another eVision.EasyDeepOCR.ETextReader instance.
None Load (self, str path)
 Loads the eVision.EasyDeepOCR.ETextReader.
None Load (self, eVision.ESerializer|None serializer)
 Loads the eVision.EasyDeepOCR.ETextReader.
None Save (self, str path)
 Saves the eVision.EasyDeepOCR.ETextReader.
None Save (self, eVision.ESerializer|None serializer)
 Saves the eVision.EasyDeepOCR.ETextReader.
None Initialize (self)
 Initializes the eVision.EasyDeepOCR.ETextReader.
bool IsInitialized (self)
 Returns true if the eVision.EasyDeepOCR.ETextReader is initialized.
None ResetTopology (self)
 Forgets the eVision.ETopology previously set.
None SetTextLineHeight (self, int minHeight, int maxHeight)
 Sets the range for the text line height.
None UnsetTextAngle (self)
 Unsets the text angle hint.
eVision.EasyDeepOCR.EOptimizationReport Optimize (self, eVision.EasyDeepOCR.ESampleList samples)
 Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.
eVision.EasyDeepOCR.EOptimizationReport Optimize (self, eVision.EasyDeepOCR.ESampleList samples, eVision.EImageType imageType)
 Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.
eVision.EasyDeepOCR.EOptimizationReport Optimize (self, eVision.EasyDeepOCR.EOptimizationReport optimizationReport)
 Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.
bool IsOptimized (self)
 Returns true if the eVision.EasyDeepOCR.ETextReader has been optimized with a call to eVision.EasyDeepOCR.ETextReader.Optimize, and false otherwise.
None ResetOptimization (self)
 Forgets the optimal parameters previously set by eVision.EasyDeepOCR.ETextReader.Optimize.
None ResetLocationCustomModel (self)
 Removes any location custom model that was previously set and use the default location model.
None ResetRecognitionCustomModel (self)
 Removes any recognition custom model that was previously set and use the default recognition model.
None ResetOrientationCustomModel (self)
 Removes any orientation custom model that was previously set and use the default orientation model.
list[eVision._eVision.EasyDeepOCR.EText] Read (self, eVision.EBaseROI roi)
 Reads texts inside an eVision.EBaseROI.
list[eVision._eVision.EasyDeepOCR.EText] Read (self, eVision.EBaseROI roi, eVision.ERegion region)
 Reads texts inside an eVision.EBaseROI.
list[eVision._eVision.EasyDeepOCR.EText] Read (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame)
 Reads texts inside an eVision.EBaseROI.
list[eVision._eVision.EasyDeepOCR.EText] Read (self, eVision.EBaseROI roi, eVision.EFrame frame)
 Reads texts inside an eVision.EBaseROI.
list[eVision._eVision.ERectangle] Localize (self, eVision.EBaseROI roi)
 Localizes the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Localize (self, eVision.EBaseROI roi, eVision.ERegion region)
 Localizes the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Localize (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame)
 Localizes the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Localize (self, eVision.EBaseROI roi, eVision.EFrame frame)
 Localizes the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Locate (self, eVision.EBaseROI roi)
 Locates the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Locate (self, eVision.EBaseROI roi, eVision.ERegion region)
 Locates the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Locate (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame)
 Locates the texts within a specified region of interest (ROI).
list[eVision._eVision.ERectangle] Locate (self, eVision.EBaseROI roi, eVision.EFrame frame)
 Locates the texts within a specified region of interest (ROI).
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI miniature, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI miniature)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI miniature, int topologyLineIndex, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI miniature, int topologyLineIndex)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, int topologyLineIndex, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, int topologyLineIndex)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, eVision.EFrame frame, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, eVision.EFrame frame)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, eVision.EFrame frame, int topologyLineIndex, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERectangle rectangle, eVision.EFrame frame, int topologyLineIndex)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, int topologyLineIndex, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, int topologyLineIndex)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame, int topologyLineIndex, bool automaticReadingDirection)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
eVision.EasyDeepOCR.ETextLine Recognize (self, eVision.EBaseROI roi, eVision.ERegion region, eVision.EFrame frame, int topologyLineIndex)
 Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.
list[eVision._eVision.EasyDeepOCR.EText] Merge (self, list[eVision._eVision.EasyDeepOCR.ETextLine] textlines)
 Merges geometrically consistent eVision.EasyDeepOCR.ETextLines into structured eVision.EasyDeepOCR.ETexts satisfying the specified eVision.EasyDeepOCR.ETextReader.Topology.
eVision.ETopology Topology (self)
 eVision.ETopology of the eVision.EasyDeepOCR.ETextReader.
 Topology (self, eVision.ETopology value)
 eVision.ETopology of the eVision.EasyDeepOCR.ETextReader.
bool HasTopology (self)
 Returns true if the eVision.ETopology is set.
eVision.EasyDeepLearning.EDeepLearningExecutionSettings ExecutionSettings (self)
 eVision.EasyDeepLearning.EDeepLearningExecutionSettings used by the eVision.EasyDeepOCR.ETextReader.
 ExecutionSettings (self, eVision.EasyDeepLearning.EDeepLearningExecutionSettings value)
 eVision.EasyDeepLearning.EDeepLearningExecutionSettings used by the eVision.EasyDeepOCR.ETextReader.
eVision.EFloatRange TextLineHeight (self)
 Gets the range for the text line height.
float TextAngle (self)
 Angle hint for the text to be found.
 TextAngle (self, float value)
 Angle hint for the text to be found.
bool HasTextAngle (self)
 Returns true if the text angle hint is defined.
bool HasLocationCustomModel (self)
 Whether the reader has a location custom model.
bool HasRecognitionCustomModel (self)
 Whether the reader has a recognition custom model.
bool HasOrientationCustomModel (self)
 Whether the reader has a orientation custom model.

Protected Member Functions

 _LocationCustomModelPath__setter (self, str value)
 Sets a location custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).
 _LocationCustomModel__setter (self, eVision.EasyDeepLearning.EDeepOCRTool value)
 Sets a location custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).
 _RecognitionCustomModelPath__setter (self, str value)
 Sets a recognition custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).
 _RecognitionCustomModel__setter (self, eVision.EasyDeepLearning.EDeepOCRTool value)
 Sets a recognition custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).
 _OrientationCustomModelPath__setter (self, str value)
 Sets an orientation custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).
 _OrientationCustomModel__setter (self, eVision.EasyDeepLearning.EDeepOCRTool value)
 Sets an orientation custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).

Properties

 LocationCustomModelPath
 LocationCustomModel
 RecognitionCustomModelPath
 RecognitionCustomModel
 OrientationCustomModelPath
 OrientationCustomModel

Detailed Description

A eVision.EasyDeepOCR.ETextReader aims to find and read texts inside a given ROI, through eVision.EasyDeepOCR.ETextReader.Read.

The returned texts can be filtered by providing a eVision.ETopology. An optimization phase can be performed before starting to read, to increase the processing speed of eVision.EasyDeepOCR.ETextReader. This optimization phase can be launched with eVision.EasyDeepOCR.ETextReader.Optimize.

Remarks:

License(s): EasyDeepOCR

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EasyDeepOCR.ETextReader.__init__ ( self)

◆ __init__() [2/2]

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

Creates a eVision.EasyDeepOCR.ETextReader.

Parameters
otherAnother eVision.EasyDeepOCR.ETextReader to be copied in the new eVision.EasyDeepOCR.ETextReader.

Member Function Documentation

◆ _LocationCustomModel__setter()

eVision.EasyDeepOCR.ETextReader._LocationCustomModel__setter ( self,
eVision.EasyDeepLearning.EDeepOCRTool value )
protected

Sets a location custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).

Remarks:

Note that the location custom model will be serialized as part of the text reader.

◆ _LocationCustomModelPath__setter()

eVision.EasyDeepOCR.ETextReader._LocationCustomModelPath__setter ( self,
str value )
protected

Sets a location custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).

Remarks:

Note that the location custom model will be serialized as part of the text reader.

◆ _OrientationCustomModel__setter()

eVision.EasyDeepOCR.ETextReader._OrientationCustomModel__setter ( self,
eVision.EasyDeepLearning.EDeepOCRTool value )
protected

Sets an orientation custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).

Remarks:

Note that the orientation custom model will be serialized as part of the text reader.

◆ _OrientationCustomModelPath__setter()

eVision.EasyDeepOCR.ETextReader._OrientationCustomModelPath__setter ( self,
str value )
protected

Sets an orientation custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).

Remarks:

Note that the orientation custom model will be serialized as part of the text reader.

◆ _RecognitionCustomModel__setter()

eVision.EasyDeepOCR.ETextReader._RecognitionCustomModel__setter ( self,
eVision.EasyDeepLearning.EDeepOCRTool value )
protected

Sets a recognition custom model from a eVision.EasyDeepLearning.EDeepOCRTool object (user trained model).

Remarks:

Note that the recognition custom model will be serialized as part of the text reader.

◆ _RecognitionCustomModelPath__setter()

eVision.EasyDeepOCR.ETextReader._RecognitionCustomModelPath__setter ( self,
str value )
protected

Sets a recognition custom model using the path to a saved eVision.EasyDeepLearning.EDeepOCRTool (user trained model).

Remarks:

Note that the recognition custom model will be serialized as part of the text reader.

◆ ExecutionSettings() [1/2]

◆ ExecutionSettings() [2/2]

◆ HasLocationCustomModel()

bool eVision.EasyDeepOCR.ETextReader.HasLocationCustomModel ( self)

Whether the reader has a location custom model.

◆ HasOrientationCustomModel()

bool eVision.EasyDeepOCR.ETextReader.HasOrientationCustomModel ( self)

Whether the reader has a orientation custom model.

◆ HasRecognitionCustomModel()

bool eVision.EasyDeepOCR.ETextReader.HasRecognitionCustomModel ( self)

Whether the reader has a recognition custom model.

◆ HasTextAngle()

bool eVision.EasyDeepOCR.ETextReader.HasTextAngle ( self)

Returns true if the text angle hint is defined.

◆ HasTopology()

bool eVision.EasyDeepOCR.ETextReader.HasTopology ( self)

Returns true if the eVision.ETopology is set.

◆ Initialize()

None eVision.EasyDeepOCR.ETextReader.Initialize ( self)

◆ IsEqual()

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

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

Parameters
otherReference to the eVision.EasyDeepOCR.ETextReader instance to compare with

◆ IsInitialized()

bool eVision.EasyDeepOCR.ETextReader.IsInitialized ( self)

Returns true if the eVision.EasyDeepOCR.ETextReader is initialized.

◆ IsOptimized()

bool eVision.EasyDeepOCR.ETextReader.IsOptimized ( self)

Returns true if the eVision.EasyDeepOCR.ETextReader has been optimized with a call to eVision.EasyDeepOCR.ETextReader.Optimize, and false otherwise.

◆ Load() [1/2]

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

Loads the eVision.EasyDeepOCR.ETextReader.

Parameters
serializer-

◆ Load() [2/2]

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

Loads the eVision.EasyDeepOCR.ETextReader.

Parameters
pathPath where to save the eVision.EasyDeepOCR.ETextReader.

◆ Localize() [1/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Localize ( self,
eVision.EBaseROI roi )

Localizes the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Deprecated

Use eVision.EasyDeepOCR.ETextReader.Locate instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.

◆ Localize() [2/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Localize ( self,
eVision.EBaseROI roi,
eVision.EFrame frame )

Localizes the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Deprecated

Use eVision.EasyDeepOCR.ETextReader.Locate instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
frameReference frame of the input region.

◆ Localize() [3/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Localize ( self,
eVision.EBaseROI roi,
eVision.ERegion region )

Localizes the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Deprecated

Use eVision.EasyDeepOCR.ETextReader.Locate instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionOptional parameter that specifies a sub-region within the ROI to limit the text search area.

◆ Localize() [4/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Localize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame )

Localizes the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Deprecated

Use eVision.EasyDeepOCR.ETextReader.Locate instead.

Deprecated in version 26.6. Scheduled to be removed in version 27.6.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionOptional parameter that specifies a sub-region within the ROI to limit the text search area.
frameReference frame of the input region.

◆ Locate() [1/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Locate ( self,
eVision.EBaseROI roi )

Locates the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.

◆ Locate() [2/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Locate ( self,
eVision.EBaseROI roi,
eVision.EFrame frame )

Locates the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
frameReference frame of the input region.

◆ Locate() [3/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Locate ( self,
eVision.EBaseROI roi,
eVision.ERegion region )

Locates the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionOptional parameter that specifies a sub-region within the ROI to limit the text search area.

◆ Locate() [4/4]

list[eVision._eVision.ERectangle] eVision.EasyDeepOCR.ETextReader.Locate ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame )

Locates the texts within a specified region of interest (ROI).

Returns the detected text areas as eVision.ERectangles.

Parameters
roiThe region of interest (ROI) in which to search for text. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionOptional parameter that specifies a sub-region within the ROI to limit the text search area.
frameReference frame of the input region.

◆ Merge()

list[eVision._eVision.EasyDeepOCR.EText] eVision.EasyDeepOCR.ETextReader.Merge ( self,
list[eVision._eVision.EasyDeepOCR.ETextLine] textlines )

Merges geometrically consistent eVision.EasyDeepOCR.ETextLines into structured eVision.EasyDeepOCR.ETexts satisfying the specified eVision.EasyDeepOCR.ETextReader.Topology.

Throws if no eVision.EasyDeepOCR.ETextReader.Topology has been specified.

Parameters
textlinesA collection of eVision.EasyDeepOCR.ETextLine candidates to be merged.

◆ Optimize() [1/3]

eVision.EasyDeepOCR.EOptimizationReport eVision.EasyDeepOCR.ETextReader.Optimize ( self,
eVision.EasyDeepOCR.EOptimizationReport optimizationReport )

Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.

Remarks:

Once an optimization is performed, the eVision.EasyDeepOCR.ETextReader is specialized and only returns texts sharing geometrical properties with the ones it has learned from.

Parameters
optimizationReportOptimization report to be restored.

◆ Optimize() [2/3]

eVision.EasyDeepOCR.EOptimizationReport eVision.EasyDeepOCR.ETextReader.Optimize ( self,
eVision.EasyDeepOCR.ESampleList samples )

Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.

Remarks:

Once an optimization is performed, the eVision.EasyDeepOCR.ETextReader is specialized and only returns texts sharing geometrical properties with the ones it has learned from.

Parameters
samplesSamples to be optimized from.

◆ Optimize() [3/3]

eVision.EasyDeepOCR.EOptimizationReport eVision.EasyDeepOCR.ETextReader.Optimize ( self,
eVision.EasyDeepOCR.ESampleList samples,
eVision.EImageType imageType )

Sets the optimal internal parameters by finding the text in the corresponding input image, for each eVision.EasyDeepOCR.ESample.

Remarks:

Once an optimization is performed, the eVision.EasyDeepOCR.ETextReader is specialized and only returns texts sharing geometrical properties with the ones it has learned from.

Parameters
samplesSamples to be optimized from.
imageTypeSpecifies the image type for loading the sample images. If not provided, the image type will be automatically determined based on the sample image files.

◆ Read() [1/4]

list[eVision._eVision.EasyDeepOCR.EText] eVision.EasyDeepOCR.ETextReader.Read ( self,
eVision.EBaseROI roi )

Reads texts inside an eVision.EBaseROI.

Texts are returned as eVision.EasyDeepOCR.EText. Texts comply with the eVision.ETopology previously specified with eVision.EasyDeepOCR.ETextReader.Topology, if any. The processing speed can be increased with eVision.EasyDeepOCR.ETextReader.Optimize.

Parameters
roiROI in which the texts have to be found. Only eVision.EROIBW8 and eVision.EROIC24 are supported.

◆ Read() [2/4]

list[eVision._eVision.EasyDeepOCR.EText] eVision.EasyDeepOCR.ETextReader.Read ( self,
eVision.EBaseROI roi,
eVision.EFrame frame )

Reads texts inside an eVision.EBaseROI.

Texts are returned as eVision.EasyDeepOCR.EText. Texts comply with the eVision.ETopology previously specified with eVision.EasyDeepOCR.ETextReader.Topology, if any. The processing speed can be increased with eVision.EasyDeepOCR.ETextReader.Optimize.

Parameters
roiROI in which the texts have to be found. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
frameReference frame of the input region.

◆ Read() [3/4]

list[eVision._eVision.EasyDeepOCR.EText] eVision.EasyDeepOCR.ETextReader.Read ( self,
eVision.EBaseROI roi,
eVision.ERegion region )

Reads texts inside an eVision.EBaseROI.

Texts are returned as eVision.EasyDeepOCR.EText. Texts comply with the eVision.ETopology previously specified with eVision.EasyDeepOCR.ETextReader.Topology, if any. The processing speed can be increased with eVision.EasyDeepOCR.ETextReader.Optimize.

Parameters
roiROI in which the texts have to be found. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionRegion in which the texts have to be found.

◆ Read() [4/4]

list[eVision._eVision.EasyDeepOCR.EText] eVision.EasyDeepOCR.ETextReader.Read ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame )

Reads texts inside an eVision.EBaseROI.

Texts are returned as eVision.EasyDeepOCR.EText. Texts comply with the eVision.ETopology previously specified with eVision.EasyDeepOCR.ETextReader.Topology, if any. The processing speed can be increased with eVision.EasyDeepOCR.ETextReader.Optimize.

Parameters
roiROI in which the texts have to be found. Only eVision.EROIBW8 and eVision.EROIC24 are supported.
regionRegion in which the texts have to be found.
frameReference frame of the input region.

◆ Recognize() [1/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI miniature )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
miniatureThe ROI containing the miniature image with text to recognize.

◆ Recognize() [2/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI miniature,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
miniatureThe ROI containing the miniature image with text to recognize.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [3/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI miniature,
int topologyLineIndex )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
miniatureThe ROI containing the miniature image with text to recognize.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.

◆ Recognize() [4/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI miniature,
int topologyLineIndex,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
miniatureThe ROI containing the miniature image with text to recognize.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [5/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.

◆ Recognize() [6/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [7/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
eVision.EFrame frame )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.

◆ Recognize() [8/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
eVision.EFrame frame,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [9/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
eVision.EFrame frame,
int topologyLineIndex )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.

◆ Recognize() [10/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
eVision.EFrame frame,
int topologyLineIndex,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [11/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
int topologyLineIndex )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.

◆ Recognize() [12/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERectangle rectangle,
int topologyLineIndex,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
rectangleDefines the area within the source ROI to extract as the miniature image.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [13/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.

◆ Recognize() [14/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [15/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.

◆ Recognize() [16/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [17/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame,
int topologyLineIndex )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.

◆ Recognize() [18/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
eVision.EFrame frame,
int topologyLineIndex,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
frameReference frame of the input region.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ Recognize() [19/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
int topologyLineIndex )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.

◆ Recognize() [20/20]

eVision.EasyDeepOCR.ETextLine eVision.EasyDeepOCR.ETextReader.Recognize ( self,
eVision.EBaseROI roi,
eVision.ERegion region,
int topologyLineIndex,
bool automaticReadingDirection )

Recognizes a text within a miniature image and returns it as an eVision.EasyDeepOCR.ETextLine.

The returned text will conform to the eVision.ETopologyLine if one is provided via the topologyLineIndex parameter. The miniature image can be provided directly or extracted from a larger ROI using an eVision.ERectangle or an eVision.ERegion. If the text in the miniature image is not oriented along the standard reading direction, setting automaticReadingDirection to true will attempt to detect and adjust for the correct reading orientation. When eVision.EasyDeepOCR.ETextReader.HasTextAngle is true, automaticReadingDirection is ignored and the reading orientation is chosen as the closest to eVision.EasyDeepOCR.ETextReader.TextAngle. Otherewise, To ensure the oriented rectangle obtained from the region is deterministic, the reader will always snap the orientation to the horizontal axis (changing the width and height accordingly).

Parameters
roiThe source ROI from which to extract the miniature image.
regionDefines the area within the source ROI to extract as the miniature image.
topologyLineIndexThe index of the eVision.ETopologyLine to use for text recognition constraints.
automaticReadingDirectionWhen true, automatically detects the reading direction of the text. Default is false.

◆ ResetLocationCustomModel()

None eVision.EasyDeepOCR.ETextReader.ResetLocationCustomModel ( self)

Removes any location custom model that was previously set and use the default location model.

◆ ResetOptimization()

None eVision.EasyDeepOCR.ETextReader.ResetOptimization ( self)

Forgets the optimal parameters previously set by eVision.EasyDeepOCR.ETextReader.Optimize.

◆ ResetOrientationCustomModel()

None eVision.EasyDeepOCR.ETextReader.ResetOrientationCustomModel ( self)

Removes any orientation custom model that was previously set and use the default orientation model.

◆ ResetRecognitionCustomModel()

None eVision.EasyDeepOCR.ETextReader.ResetRecognitionCustomModel ( self)

Removes any recognition custom model that was previously set and use the default recognition model.

◆ ResetTopology()

None eVision.EasyDeepOCR.ETextReader.ResetTopology ( self)

Forgets the eVision.ETopology previously set.

◆ Save() [1/2]

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

Saves the eVision.EasyDeepOCR.ETextReader.

Parameters
serializer-

◆ Save() [2/2]

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

Saves the eVision.EasyDeepOCR.ETextReader.

Parameters
pathPath where to save the eVision.EasyDeepOCR.ETextReader.

◆ SetTextLineHeight()

None eVision.EasyDeepOCR.ETextReader.SetTextLineHeight ( self,
int minHeight,
int maxHeight )

Sets the range for the text line height.

All returned text lines will have a height in the range [minHeight, maxHeight]. Any text line that does not fit this constraint, will be discarded. By default, it is not set, so no filtering is applied.

Parameters
minHeightLower bound for the line height range.
maxHeightUpper bound for the line height range.

◆ TextAngle() [1/2]

float eVision.EasyDeepOCR.ETextReader.TextAngle ( self)

Angle hint for the text to be found.

◆ TextAngle() [2/2]

eVision.EasyDeepOCR.ETextReader.TextAngle ( self,
float value )

Angle hint for the text to be found.

◆ TextLineHeight()

eVision.EFloatRange eVision.EasyDeepOCR.ETextReader.TextLineHeight ( self)

Gets the range for the text line height.

Throws if not previously set. By default, it is not set, so no filtering is applied.

◆ Topology() [1/2]

eVision.ETopology eVision.EasyDeepOCR.ETextReader.Topology ( self)

◆ Topology() [2/2]

eVision.EasyDeepOCR.ETextReader.Topology ( self,
eVision.ETopology value )

◆ UnsetTextAngle()

None eVision.EasyDeepOCR.ETextReader.UnsetTextAngle ( self)

Unsets the text angle hint.

Property Documentation

◆ LocationCustomModel

eVision.EasyDeepOCR.ETextReader.LocationCustomModel
static
Initial value:
= property(None, _LocationCustomModel__setter, None,
)

◆ LocationCustomModelPath

eVision.EasyDeepOCR.ETextReader.LocationCustomModelPath
static
Initial value:
= property(None, _LocationCustomModelPath__setter, None,
)

◆ OrientationCustomModel

eVision.EasyDeepOCR.ETextReader.OrientationCustomModel
static
Initial value:
= property(None, _OrientationCustomModel__setter, None,
)

◆ OrientationCustomModelPath

eVision.EasyDeepOCR.ETextReader.OrientationCustomModelPath
static
Initial value:
= property(None, _OrientationCustomModelPath__setter, None,
)

◆ RecognitionCustomModel

eVision.EasyDeepOCR.ETextReader.RecognitionCustomModel
static
Initial value:
= property(None, _RecognitionCustomModel__setter, None,
)

◆ RecognitionCustomModelPath

eVision.EasyDeepOCR.ETextReader.RecognitionCustomModelPath
static
Initial value:
= property(None, _RecognitionCustomModelPath__setter, None,
)