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

Manages a complete context for the font-dependent printed character reader implemented in EasyOCR2. More...

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

Collaboration diagram for eVision::EOCR2:

Public Member Functions

 EOCR2 ()
 Constructs an EOCR2 context.
 EOCR2 (const eVision::EOCR2 &other)
 Constructs an EOCR2 context.
virtual ~EOCR2 () throw ()
eVision::EOCR2 & operator= (const eVision::EOCR2 &other)
 Assignment operator, copies another EOCR2 instance to this one.
std::string Read (const eVision::EROIBW8 &srcRoi)
 Performs all steps required for reading text from an image:
std::string Read (const eVision::EROIBW8 &srcRoi, const eVision::ERegion &region)
 Performs all steps required for reading text from an image:
eVision::EOCR2Text Read2 (const eVision::EROIBW8 &srcRoi)
 Performs all steps required for reading text from an image:
eVision::EOCR2Text Read2 (const eVision::EROIBW8 &srcRoi, const eVision::ERegion &region)
 Performs all steps required for reading text from an image:
eVision::EOCR2Text Read2 (const eVision::EROIBW8 &srcRoi, const eVision::ERegion &region, const eVision::EFrame &frame)
 Performs all steps required for reading text from an image:
eVision::EOCR2Text Read2 (const eVision::EROIBW8 &srcRoi, const eVision::EFrame &frame)
 Performs all steps required for reading text from an image:
eVision::EOCR2Text Detect (const eVision::EROIBW8 &srcRoi)
 Finds the text in an image as follows:
eVision::EOCR2Text Detect (const eVision::EROIBW8 &srcRoi, const eVision::ERegion &region)
 Finds the text in an image as follows:
eVision::EOCR2Text Detect (const eVision::EROIBW8 &srcRoi, const eVision::ERegion &region, const eVision::EFrame &frame)
 Finds the text in an image as follows:
eVision::EOCR2Text Detect (const eVision::EROIBW8 &srcRoi, const eVision::EFrame &frame)
 Finds the text in an image as follows:
void RecognizeText (eVision::EOCR2Text &text)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font.
void RecognizeText (eVision::EOCR2Text &text, const eVision::EFrame &frame)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font.
std::string Recognize (const eVision::EOCR2Text &text)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.
std::string Recognize (const eVision::EOCR2Text &text, const eVision::EFrame &frame)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.
std::string Recognize (const eVision::EOCR2Text &text, const eVision::EROIBW8 &srcRoi)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.
std::string Recognize (const eVision::EOCR2Text &text, const eVision::EROIBW8 &srcRoi, const eVision::EFrame &frame)
 Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.
void AddCharactersToDatabase (const std::string &file)
 Reads reference characters from disk and adds them to the database used for text recognition. The characters can be read from a trueType (.ttf/.ttc) file or from an EasyOCR2 database file.
void AddCharactersToDatabase (const std::string &file, eVision::EasyOCR2CharacterFilter filter)
 Reads reference characters from disk and adds them to the database used for text recognition. The characters can be read from a trueType (.ttf/.ttc) file or from an EasyOCR2 database file.
void SaveCharacterDatabase (const std::string &file)
 Saves the current reference character database to disk.
void ClearCharacterDatabase ()
 Clears the reference character database from this EOCR2 instance.
void Learn (const eVision::EOCR2Char &character)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Word &word)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Line &line)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Text &text)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Char &character, const eVision::EFrame &frame)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Word &word, const eVision::EFrame &frame)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Line &line, const eVision::EFrame &frame)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Learn (const eVision::EOCR2Text &text, const eVision::EFrame &frame)
 Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.
void Save (const std::string &modelPath)
 Saves the model to disk, containing the current parameter setting used for all operations in EOCR2.
void Save (eVision::ESerializer *serializer)
 Saves the model to disk, containing the current parameter setting used for all operations in EOCR2.
void Load (const std::string &modelPath)
 Loads a model, containing parameter settings used for all operations in EOCR2::EOCR2, from disk.
void Load (eVision::ESerializer *serializer)
 Loads a model, containing parameter settings used for all operations in EOCR2::EOCR2, from disk.
void SetTopology (const std::string &topology)
 Sets the topology of the text that should be found in the image. A modified version of Regex expressions are used, where:
std::string GetTopology () const
 Sets the topology of the text that should be found in the image. A modified version of Regex expressions are used, where:
void SetEnabledTopology (bool enableTopology)
 Sets whether the topology is required or not. If it is, EOCR2 will try to detect the topology accordingly with the EOCR2DetectionMethod parameter. The default setting for this parameter is true and topology has to be given with EOCR2::SetTopology.
bool GetEnabledTopology () const
 Sets whether the topology is required or not. If it is, EOCR2 will try to detect the topology accordingly with the EOCR2DetectionMethod parameter. The default setting for this parameter is true and topology has to be given with EOCR2::SetTopology.
void SetRepasteObjects (bool repasteObjects)
 Sets whether EOCR2 groups or does not group the blobs believed to belong to the same character. The default setting for this parameter is true, and it is only applicable when the topology is not required.
bool GetRepasteObjects () const
 Sets whether EOCR2 groups or does not group the blobs believed to belong to the same character. The default setting for this parameter is true, and it is only applicable when the topology is not required.
void SetEnableOffSizeCharacter (bool enableOffSizeCharacter)
 Sets whether EOCR2 allows or not the detection of characters whose size (width and height) is out of the size parameters if they are in the vicinity of characters in valid size range. The default setting for this parameter is true, and it is only applicable when the topology is not required.
bool GetEnableOffSizeCharacter () const
 Sets whether EOCR2 allows or not the detection of characters whose size (width and height) is out of the size parameters if they are in the vicinity of characters in valid size range. The default setting for this parameter is true, and it is only applicable when the topology is not required.
void SetEnableCutLargeCharacter (bool enableCutLargeCharacter)
 Sets whether EOCR2 detection should split or not segmented blobs into multiple characters if they are wider than the given character width range parameter. The default setting for this parameter is false, and it is only applicable when the topology is not required or when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_Proportional.
bool GetEnableCutLargeCharacter () const
 Sets whether EOCR2 detection should split or not segmented blobs into multiple characters if they are wider than the given character width range parameter. The default setting for this parameter is false, and it is only applicable when the topology is not required or when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_Proportional.
void SetEnableSecondPassGlobalSegmentation (bool secondPassGlobalSegmentation)
 Sets whether EOCR2 segmentation should do or not do an extra pass to determine the best threshold using the EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global segmentation method. The default setting for this parameter is false, and it is only applicable when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global.
bool GetEnableSecondPassGlobalSegmentation () const
 Sets whether EOCR2 segmentation should do or not do an extra pass to determine the best threshold using the EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global segmentation method. The default setting for this parameter is false, and it is only applicable when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global.
void SetGlobalSegmentationThresholdMode (eVision::EThresholdMode thresholdMode)
 Sets/Gets the EThresholdMode used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. From the EThresholdMode, a threshold will be computed during the segmentation. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack, pixels above or equal to the threshold will be segmented. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_BlackOnWhite, pixels under the threshold will be segmented.
eVision::EThresholdMode GetGlobalSegmentationThresholdMode () const
 Sets/Gets the EThresholdMode used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. From the EThresholdMode, a threshold will be computed during the segmentation. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack, pixels above or equal to the threshold will be segmented. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_BlackOnWhite, pixels under the threshold will be segmented.
void SetGlobalSegmentationRelativeThreshold (float relativeThreshold)
 Sets/Gets the fraction of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Relative .
float GetGlobalSegmentationRelativeThreshold () const
 Sets/Gets the fraction of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Relative .
void SetGlobalSegmentationAbsoluteThreshold (int absoluteThreshold)
 Sets the value of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Absolute .
int GetGlobalSegmentationAbsoluteThreshold () const
 Gets the value of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Absolute .
void SetCharsWidthRange (const eVision::EIntegerRange &range)
 Sets the range of expected character widths in pixels.
eVision::EIntegerRange GetCharsWidthRange () const
 Sets the range of expected character widths in pixels.
void SetCharsWidth (int32_t width)
 Sets the expected character width in pixels.
int32_t GetCharsWidth () const
 Sets the expected character width in pixels.
void SetCharsWidthTolerance (float charWidthTolerance)
 Sets the CharsWidthTolerance parameter for the topology fitting algorithm, which will attempt to optimize the width of the bounding boxes to optimally fit the detected blobs.
float GetCharsWidthTolerance () const
 Sets the CharsWidthTolerance parameter for the topology fitting algorithm, which will attempt to optimize the width of the bounding boxes to optimally fit the detected blobs.
void SetCharsHeight (int32_t height)
 Sets the expected character height in pixels.
int32_t GetCharsHeight () const
 Sets the expected character height in pixels.
void SetRelativeSpacesWidthRange (const eVision::EFloatRange &range)
 Sets the range of expected spaces between words as a fraction of the character width.
eVision::EFloatRange GetRelativeSpacesWidthRange () const
 Sets the range of expected spaces between words as a fraction of the character width.
void SetMaxVariation (float maxVariation)
 Sets the maxVariation parameter for the segmentation algorithm. This parameter determines how stable a blob in the image should be in order to be considered a potential character, a region with clearly defined edges is generally considered stable while a blurry region is not. A high setting allows more unstable blobs, a low setting allows only very stable blobs.
float GetMaxVariation () const
 Sets the maxVariation parameter for the segmentation algorithm. This parameter determines how stable a blob in the image should be in order to be considered a potential character, a region with clearly defined edges is generally considered stable while a blurry region is not. A high setting allows more unstable blobs, a low setting allows only very stable blobs.
void SetCharsMaxFragmentation (float charMaxFragmentation)
 Sets the CharsMaxFragmentation parameter for the segmentation algorithm. This will determine the minimum size a blob should be in order to be considered a potential character. A high setting will allow only larger blobs, a low setting will also allow smaller blobs.
float GetCharsMaxFragmentation () const
 Sets the CharsMaxFragmentation parameter for the segmentation algorithm. This will determine the minimum size a blob should be in order to be considered a potential character. A high setting will allow only larger blobs, a low setting will also allow smaller blobs.
void SetDetectionDelta (int32_t delta)
 Sets the DetectionDelta parameter for the segmentation algorithm. This will determine the range of grayscale-values used to determine the stability of a blob. A low setting will make the algorithm more sensitive to noise, a high setting will make the algorithm insensitive to blobs with low contrast to the background.
int32_t GetDetectionDelta () const
 Sets the DetectionDelta parameter for the segmentation algorithm. This will determine the range of grayscale-values used to determine the stability of a blob. A low setting will make the algorithm more sensitive to noise, a high setting will make the algorithm insensitive to blobs with low contrast to the background.
void SetTextPolarity (eVision::EasyOCR2TextPolarity polarity)
 Sets the TextPolarity parameter for the segmentation algorithm. This will determine whether the algorithm searches for light blobs in a dark background or for dark blobs in a light background.
eVision::EasyOCR2TextPolarity GetTextPolarity () const
 Sets the TextPolarity parameter for the segmentation algorithm. This will determine whether the algorithm searches for light blobs in a dark background or for dark blobs in a light background.
void SetCharsWidthBias (eVision::EasyOCR2CharWidthBias charWidthBias)
 Sets the CharsWidthBias parameter for the topology fitting algorithm, which optimizes the width of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow boxes, wide boxes or is neutral.
eVision::EasyOCR2CharWidthBias GetCharsWidthBias () const
 Sets the CharsWidthBias parameter for the topology fitting algorithm, which optimizes the width of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow boxes, wide boxes or is neutral.
void SetCharsSpacingBias (eVision::EasyOCR2CharSpacingBias charSpacingBias)
 Sets the CharSpacingBias parameter for the topology fitting algorithm, which optimizes the spacing of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow spacing, wide spacing or is neutral.
eVision::EasyOCR2CharSpacingBias GetCharsSpacingBias () const
 Sets the CharSpacingBias parameter for the topology fitting algorithm, which optimizes the spacing of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow spacing, wide spacing or is neutral.
void SetTextAngleRange (const eVision::EFloatRange &range)
 Sets the TextAngleRange parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.
eVision::EFloatRange GetTextAngleRange () const
 Sets the TextAngleRange parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.
void SetTextBaseAngle (float textBaseAngle)
 Sets the TextBaseAngle parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.
float GetTextBaseAngle () const
 Sets the TextBaseAngle parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.
void SetTextAngleTolerance (float textAngleTolerance)
 Sets the TextAngleTolerance parameter for the topology fitting algorithm, which finds the angle of the text in the image with respect to the horizontal.
float GetTextAngleTolerance () const
 Sets the TextAngleTolerance parameter for the topology fitting algorithm, which finds the angle of the text in the image with respect to the horizontal.
void SetDetectionMethod (eVision::EOCR2DetectionMethod method)
 Sets the EOCR2DetectionMethod parameter for the topology fitting algorithm, which will place text boxes on the segmentation results, matching the given topology.
eVision::EOCR2DetectionMethod GetDetectionMethod () const
 Sets the EOCR2DetectionMethod parameter for the topology fitting algorithm, which will place text boxes on the segmentation results, matching the given topology.
void SetAllowedCharacterTypes (eVision::EasyOCR2CharacterFilter allowedCharacterTypes)
 Sets which character types are expected when EOCR2::SetEnabledTopology is false. The set of expected character types is represented by a bitwise combination of different EasyOCR2CharacterFilter.
eVision::EasyOCR2CharacterFilter GetAllowedCharacterTypes () const
 Sets which character types are expected when EOCR2::SetEnabledTopology is false. The set of expected character types is represented by a bitwise combination of different EasyOCR2CharacterFilter.
void SetNumDetectionPasses (int32_t nDetectionPasses)
 Sets the NumDetectionPasses parameter for the topology fitting algorithm, which will place text boxes on the segmentation results (blobs). The first pass will consider all blobs, subsequent passes will only consider those blobs that are inside the text boxes from the previous pass, sometimes resulting in a more optimal fit.
int32_t GetNumDetectionPasses () const
 Sets the NumDetectionPasses parameter for the topology fitting algorithm, which will place text boxes on the segmentation results (blobs). The first pass will consider all blobs, subsequent passes will only consider those blobs that are inside the text boxes from the previous pass, sometimes resulting in a more optimal fit.
void SetSegmentationMethod (eVision::EOCR2SegmentationMethod method)
 Sets the EOCR2SegmentationMethod parameter for the segmentation algorithm, which will detect blobs in the image.
eVision::EOCR2SegmentationMethod GetSegmentationMethod () const
 Sets the EOCR2SegmentationMethod parameter for the segmentation algorithm, which will detect blobs in the image.
void SetCharacterDatabase (const eVision::EOCR2CharacterDatabase &database)
 Sets the EOCR2CharacterDatabase used for recognizing text.
eVision::EOCR2CharacterDatabase GetCharacterDatabase ()
 Sets the EOCR2CharacterDatabase used for recognizing text.
eVision::EOCR2Text GetReadText () const
 Outputs an EOCR2Text structure containing the detailed detection and recognition results.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawSegmentationStyle style) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, const eVision::ERGBColor &color, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, const eVision::ERGBColor &color, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, const eVision::ERGBColor &color, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, const eVision::ERGBColor &color, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentation (HDC hdc, const eVision::ERGBColor &color, eVision::EasyOCR2DrawSegmentationStyle style) const
 Draws the blobs found by the segmentation algorithm.
void DrawSegmentationWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the blobs found by the segmentation algorithm with the current pen.
void DrawSegmentationWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY, float panX) const
 Draws the blobs found by the segmentation algorithm with the current pen.
void DrawSegmentationWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX, float zoomY) const
 Draws the blobs found by the segmentation algorithm with the current pen.
void DrawSegmentationWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style, float zoomX) const
 Draws the blobs found by the segmentation algorithm with the current pen.
void DrawSegmentationWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawSegmentationStyle style) const
 Draws the blobs found by the segmentation algorithm with the current pen.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style, float zoomX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawDetectionStyle style) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::ERGBColor color, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::ERGBColor color, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::ERGBColor color, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::ERGBColor color, eVision::EasyOCR2DrawDetectionStyle style, float zoomX) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetection (HDC hdc, eVision::ERGBColor color, eVision::EasyOCR2DrawDetectionStyle style) const
 Draws the bounding boxes found by the topology detection algorithm.
void DrawDetectionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX, float panY) const
 Draws the bounding boxes found by the topology detection algorithm with the current pen.
void DrawDetectionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY, float panX) const
 Draws the bounding boxes found by the topology detection algorithm with the current pen.
void DrawDetectionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX, float zoomY) const
 Draws the bounding boxes found by the topology detection algorithm with the current pen.
void DrawDetectionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style, float zoomX) const
 Draws the bounding boxes found by the topology detection algorithm with the current pen.
void DrawDetectionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawDetectionStyle style) const
 Draws the bounding boxes found by the topology detection algorithm with the current pen.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX, float panY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (eVision::EDrawAdapter *drawAdapter, eVision::EasyOCR2DrawRecognitionStyle style) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX, float panY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX, float panY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognition (HDC hdc, eVision::ERGBColor textColor, eVision::ERGBColor backgroundColor, eVision::EasyOCR2DrawRecognitionStyle style) const
 Draws the recognized text next to the character bounding box in the image.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX, float panY) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY, float panX) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX, float zoomY) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight, float zoomX) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style, uint32_t cHeight) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
void DrawRecognitionWithCurrentPen (HDC hdc, eVision::EasyOCR2DrawRecognitionStyle style) const
 Draws the recognized text next to the character bounding box in the image with the current pen.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y, float zoomX, float zoomY, float panX)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y, float zoomX, float zoomY)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y, float zoomX)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t x, int32_t y)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t &lineN, int32_t &wordN, int32_t &charN, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t &lineN, int32_t &wordN, int32_t &charN, int32_t x, int32_t y, float zoomX, float zoomY, float panX)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t &lineN, int32_t &wordN, int32_t &charN, int32_t x, int32_t y, float zoomX, float zoomY)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t &lineN, int32_t &wordN, int32_t &charN, int32_t x, int32_t y, float zoomX)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestChar (eVision::EOCR2Char &character, int32_t &lineN, int32_t &wordN, int32_t &charN, int32_t x, int32_t y)
 Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y, float zoomX, float zoomY, float panX)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y, float zoomX, float zoomY)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y, float zoomX)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestWord (eVision::EOCR2Word &word, int32_t x, int32_t y)
 Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y, float zoomX, float zoomY, float panX)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y, float zoomX, float zoomY)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y, float zoomX)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestLine (eVision::EOCR2Line &line, int32_t x, int32_t y)
 Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY, const eVision::EFrame &frame) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y, float zoomX, float zoomY, float panX, float panY) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y, float zoomX, float zoomY, float panX) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y, float zoomX, float zoomY) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y, float zoomX) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
bool HitTestText (eVision::EOCR2Text &text, int32_t x, int32_t y) const
 Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.
void SetTimeOut (uint64_t value)
 Time-out for the EOCR2::Read, EOCR2::Detect and EOCR2::Recognize methods.
uint64_t GetTimeOut () const
 Time-out for the EOCR2::Read, EOCR2::Detect and EOCR2::Recognize methods.
void ClearResult ()
 Clear the current detected text if it exists.
eVision::EOCR2Classifier GetClassifier () const
 Sets the EOCR2Classifier parameter for the recognition algorithm. This will determine which classifier will be used for the recognition.
void SetClassifier (eVision::EOCR2Classifier classifier)
 Sets the EOCR2Classifier parameter for the recognition algorithm. This will determine which classifier will be used for the recognition.
void SetEnableGPU (bool enable)
 Sets/Gets whether EOCR2 uses a GPU to accelerate its processing.
bool GetEnableGPU () const
 Sets/Gets whether EOCR2 uses a GPU to accelerate its processing.
void SetGPUIndexes (const std::vector< uint32_t > &index)
 Sets/gets the GPUs to use when computing.
std::vector< uint32_t > GetGPUIndexes () const
 Sets/gets the GPUs to use when computing.
void AddClassifierForSymbol (const std::string &symbol, eVision::EOCR2Classifier classifier)
 Adds the EOCR2Classifier for the given specific symbol combination during the recognition instead of the one set by EOCR2::GetClassifier.
eVision::EOCR2Classifier GetClassifierForSymbol (const std::string &symbol) const
 Gets the EOCR2Classifier for the given specific symbol combination during the recognition instead of the one set by EOCR2::GetClassifier.
void RemoveClassifierForSymbol (const std::string &symbol)
 Removes the EOCR2Classifier for the given specific symbol combination during the recognition so the one set by EOCR2::GetClassifier will be used.
bool HasDatabaseClassifier () const
 Returns whether this reader has a database classifier set and ready to use.
 EOCR2 (CppWrapperInternal::InternalConstructor)

Public Attributes

CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Manages a complete context for the font-dependent printed character reader implemented in EasyOCR2.

License(s): EasyOCR2

Constructor & Destructor Documentation

◆ EOCR2() [1/3]

eVision::EOCR2::EOCR2 ( )

Constructs an EOCR2 context.

◆ EOCR2() [2/3]

eVision::EOCR2::EOCR2 ( const eVision::EOCR2 & other)

Constructs an EOCR2 context.

Parameters
otherThe other EOCR2 that we will copy into this one.

◆ ~EOCR2()

eVision::EOCR2::~EOCR2 ( )
throw ( )
virtual

◆ EOCR2() [3/3]

eVision::EOCR2::EOCR2 ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddCharactersToDatabase() [1/2]

void eVision::EOCR2::AddCharactersToDatabase ( const std::string & file)

Reads reference characters from disk and adds them to the database used for text recognition. The characters can be read from a trueType (.ttf/.ttc) file or from an EasyOCR2 database file.

Parameters
fileA string containing the path of the file.

◆ AddCharactersToDatabase() [2/2]

void eVision::EOCR2::AddCharactersToDatabase ( const std::string & file,
eVision::EasyOCR2CharacterFilter filter )

Reads reference characters from disk and adds them to the database used for text recognition. The characters can be read from a trueType (.ttf/.ttc) file or from an EasyOCR2 database file.

Parameters
fileA string containing the path of the file.
filterOptional parameter; an EasyOCR2CharacterFilter that tells the method which subset of the character-set should be loaded.

◆ AddClassifierForSymbol()

void eVision::EOCR2::AddClassifierForSymbol ( const std::string & symbol,
eVision::EOCR2Classifier classifier )

Adds the EOCR2Classifier for the given specific symbol combination during the recognition instead of the one set by EOCR2::GetClassifier.

Parameters
symbolsymbol combination to add classifier for
classifierclassifier to add to symbol

The only accepted EOCR2Classifier is currently EOCR2Classifier::EOCR2Classifier_DatabaseClassifier. Symbol combinations are the same as used in the topology, ex : Lu, P or [LlNS]. See EOCR2::SetTopology for more details.

◆ ClearCharacterDatabase()

void eVision::EOCR2::ClearCharacterDatabase ( )

Clears the reference character database from this EOCR2 instance.

◆ ClearResult()

void eVision::EOCR2::ClearResult ( )

Clear the current detected text if it exists.

Deprecated

Use the returned EOCR2Text instead.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ Detect() [1/4]

eVision::EOCR2Text eVision::EOCR2::Detect ( const eVision::EROIBW8 & srcRoi)

Finds the text in an image as follows:

  1. Detects potential characters in the image following the given text polarity.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Extracts the detected characters from the image.

The detected characters are output as an EOCR2Text structure.

Parameters
srcRoiThe source image/ROI.

The variables Topology, CharHeight, CharWidth should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Detect() [2/4]

eVision::EOCR2Text eVision::EOCR2::Detect ( const eVision::EROIBW8 & srcRoi,
const eVision::EFrame & frame )

Finds the text in an image as follows:

  1. Detects potential characters in the image following the given text polarity.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Extracts the detected characters from the image.

The detected characters are output as an EOCR2Text structure.

Parameters
srcRoiThe source image/ROI.
frameReference frame of the input region.

The variables Topology, CharHeight, CharWidth should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Detect() [3/4]

eVision::EOCR2Text eVision::EOCR2::Detect ( const eVision::EROIBW8 & srcRoi,
const eVision::ERegion & region )

Finds the text in an image as follows:

  1. Detects potential characters in the image following the given text polarity.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Extracts the detected characters from the image.

The detected characters are output as an EOCR2Text structure.

Parameters
srcRoiThe source image/ROI.
regionThe region of interest where the detection is performed.

The variables Topology, CharHeight, CharWidth should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Detect() [4/4]

eVision::EOCR2Text eVision::EOCR2::Detect ( const eVision::EROIBW8 & srcRoi,
const eVision::ERegion & region,
const eVision::EFrame & frame )

Finds the text in an image as follows:

  1. Detects potential characters in the image following the given text polarity.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Extracts the detected characters from the image.

The detected characters are output as an EOCR2Text structure.

Parameters
srcRoiThe source image/ROI.
regionThe region of interest where the detection is performed.
frameReference frame of the input region.

The variables Topology, CharHeight, CharWidth should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ DrawDetection() [1/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [2/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [3/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [4/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [5/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [6/16]

void eVision::EOCR2::DrawDetection ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the last read.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawDetection() [7/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [8/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [9/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [10/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [11/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [12/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::ERGBColor color,
eVision::EasyOCR2DrawDetectionStyle style ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the detection.
styleThe style in which each detection box should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [13/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::ERGBColor color,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the detection.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [14/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::ERGBColor color,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the detection.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [15/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::ERGBColor color,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the detection.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetection() [16/16]

void eVision::EOCR2::DrawDetection ( HDC hdc,
eVision::ERGBColor color,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the bounding boxes found by the topology detection algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the detection.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetectionWithCurrentPen() [1/5]

void eVision::EOCR2::DrawDetectionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style ) const

Draws the bounding boxes found by the topology detection algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
Deprecated

Use the overload of EOCR2::DrawDetection taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetectionWithCurrentPen() [2/5]

void eVision::EOCR2::DrawDetectionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX ) const

Draws the bounding boxes found by the topology detection algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload of EOCR2::DrawDetection taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetectionWithCurrentPen() [3/5]

void eVision::EOCR2::DrawDetectionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY ) const

Draws the bounding boxes found by the topology detection algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload of EOCR2::DrawDetection taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetectionWithCurrentPen() [4/5]

void eVision::EOCR2::DrawDetectionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the bounding boxes found by the topology detection algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawDetection taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawDetectionWithCurrentPen() [5/5]

void eVision::EOCR2::DrawDetectionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawDetectionStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the bounding boxes found by the topology detection algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each detection box should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawDetection taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [1/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [2/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [3/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [4/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [5/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [6/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [7/19]

void eVision::EOCR2::DrawRecognition ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the last read.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawRecognition() [8/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [9/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [10/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [11/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [12/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [13/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [14/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [15/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [16/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [17/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [18/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognition() [19/19]

void eVision::EOCR2::DrawRecognition ( HDC hdc,
eVision::ERGBColor textColor,
eVision::ERGBColor backgroundColor,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the recognized text next to the character bounding box in the image.

Parameters
hdcHandle of the device context on which to draw.
textColorThe color in which to draw the recognized text.
backgroundColorThe color of the box in which the text is displayed.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [1/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [2/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [3/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [4/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [5/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawRecognitionWithCurrentPen() [6/6]

void eVision::EOCR2::DrawRecognitionWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawRecognitionStyle style,
uint32_t cHeight,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the recognized text next to the character bounding box in the image with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each recognition result should be drawn.
cHeightThe character-height with which the recognized text should be displayed.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawRecognition taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [1/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [2/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [3/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [4/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [5/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [6/16]

void eVision::EOCR2::DrawSegmentation ( eVision::EDrawAdapter * drawAdapter,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame ) const

Draws the blobs found by the segmentation algorithm.

Parameters
drawAdapterEDrawAdapter that will be used to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the last read.
Deprecated

Use the draw methods attached to EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ DrawSegmentation() [7/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
const eVision::ERGBColor & color,
eVision::EasyOCR2DrawSegmentationStyle style ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the segmentation.
styleThe style in which each blob should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [8/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
const eVision::ERGBColor & color,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the segmentation.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [9/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
const eVision::ERGBColor & color,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the segmentation.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [10/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
const eVision::ERGBColor & color,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the segmentation.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [11/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
const eVision::ERGBColor & color,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
colorThe color in which to draw the segmentation.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [12/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [13/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [14/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [15/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentation() [16/16]

void eVision::EOCR2::DrawSegmentation ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the blobs found by the segmentation algorithm.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentationWithCurrentPen() [1/5]

void eVision::EOCR2::DrawSegmentationWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style ) const

Draws the blobs found by the segmentation algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
Deprecated

Use the overload of EOCR2::DrawSegmentation taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentationWithCurrentPen() [2/5]

void eVision::EOCR2::DrawSegmentationWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX ) const

Draws the blobs found by the segmentation algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the overload of EOCR2::DrawSegmentation taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentationWithCurrentPen() [3/5]

void eVision::EOCR2::DrawSegmentationWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY ) const

Draws the blobs found by the segmentation algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the overload of EOCR2::DrawSegmentation taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentationWithCurrentPen() [4/5]

void eVision::EOCR2::DrawSegmentationWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX ) const

Draws the blobs found by the segmentation algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawSegmentation taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawSegmentationWithCurrentPen() [5/5]

void eVision::EOCR2::DrawSegmentationWithCurrentPen ( HDC hdc,
eVision::EasyOCR2DrawSegmentationStyle style,
float zoomX,
float zoomY,
float panX,
float panY ) const

Draws the blobs found by the segmentation algorithm with the current pen.

Parameters
hdcHandle of the device context on which to draw.
styleThe style in which each blob should be drawn.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the overload of EOCR2::DrawSegmentation taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ GetAllowedCharacterTypes()

eVision::EasyOCR2CharacterFilter eVision::EOCR2::GetAllowedCharacterTypes ( ) const

Sets which character types are expected when EOCR2::SetEnabledTopology is false. The set of expected character types is represented by a bitwise combination of different EasyOCR2CharacterFilter.

For example, digits and uppercase letters can be expressed by EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_UpperCaseLetters | EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_Digits. The default setting for this parameter is EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_ASCII.

◆ GetCharacterDatabase()

eVision::EOCR2CharacterDatabase eVision::EOCR2::GetCharacterDatabase ( )

Sets the EOCR2CharacterDatabase used for recognizing text.

Setting a new characterDatabase will overwrite the current one.

◆ GetCharsHeight()

int32_t eVision::EOCR2::GetCharsHeight ( ) const

Sets the expected character height in pixels.

◆ GetCharsMaxFragmentation()

float eVision::EOCR2::GetCharsMaxFragmentation ( ) const

Sets the CharsMaxFragmentation parameter for the segmentation algorithm. This will determine the minimum size a blob should be in order to be considered a potential character. A high setting will allow only larger blobs, a low setting will also allow smaller blobs.

The minimum blob size to be considered a potential character is defined as: CharsMaxFragmentation * CharsHeight * CharsWidth

This parameter should be set between 0.0 and 1.0, the default setting is 0.1.

◆ GetCharsSpacingBias()

eVision::EasyOCR2CharSpacingBias eVision::EOCR2::GetCharsSpacingBias ( ) const

Sets the CharSpacingBias parameter for the topology fitting algorithm, which optimizes the spacing of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow spacing, wide spacing or is neutral.

The default setting for this parameter is EasyOCR2CharSpacingBias::EasyOCR2CharSpacingBias_Neutral

◆ GetCharsWidth()

int32_t eVision::EOCR2::GetCharsWidth ( ) const

Sets the expected character width in pixels.

Deprecated

Use EOCR2::SetCharsWidthRange instead.

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

◆ GetCharsWidthBias()

eVision::EasyOCR2CharWidthBias eVision::EOCR2::GetCharsWidthBias ( ) const

Sets the CharsWidthBias parameter for the topology fitting algorithm, which optimizes the width of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow boxes, wide boxes or is neutral.

The default setting for this parameter is EasyOCR2CharWidthBias::EasyOCR2CharWidthBias_Neutral

◆ GetCharsWidthRange()

eVision::EIntegerRange eVision::EOCR2::GetCharsWidthRange ( ) const

Sets the range of expected character widths in pixels.

◆ GetCharsWidthTolerance()

float eVision::EOCR2::GetCharsWidthTolerance ( ) const

Sets the CharsWidthTolerance parameter for the topology fitting algorithm, which will attempt to optimize the width of the bounding boxes to optimally fit the detected blobs.

This will determine the range of bounding box sizes that will be accepted, defined as: (1 - CharsWidthTolerance) * CharsWidth <= BBoxWidth <= (1 + CharsWidthTolerance) * CharsWidth

The CharsWidthTolerance parameter should be between 0.0 and 1.0, the default setting is 0.25.

Deprecated

Use EOCR2::SetCharsWidthRange instead.

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

◆ GetClassifier()

eVision::EOCR2Classifier eVision::EOCR2::GetClassifier ( ) const

Sets the EOCR2Classifier parameter for the recognition algorithm. This will determine which classifier will be used for the recognition.

The default setting for this parameter is EOCR2Classifier::EOCR2Classifier_DatabaseClassifier.

◆ GetClassifierForSymbol()

eVision::EOCR2Classifier eVision::EOCR2::GetClassifierForSymbol ( const std::string & symbol) const

Gets the EOCR2Classifier for the given specific symbol combination during the recognition instead of the one set by EOCR2::GetClassifier.

Parameters
symbolsymbol combination for which to get classifier

Symbol combinations are the same as used in the topology, ex : Lu, P or [LlNS]. See EOCR2::SetTopology for more details.

◆ GetDetectionDelta()

int32_t eVision::EOCR2::GetDetectionDelta ( ) const

Sets the DetectionDelta parameter for the segmentation algorithm. This will determine the range of grayscale-values used to determine the stability of a blob. A low setting will make the algorithm more sensitive to noise, a high setting will make the algorithm insensitive to blobs with low contrast to the background.

This parameter should be set between 0 and 127, the default setting is 12.

◆ GetDetectionMethod()

eVision::EOCR2DetectionMethod eVision::EOCR2::GetDetectionMethod ( ) const

Sets the EOCR2DetectionMethod parameter for the topology fitting algorithm, which will place text boxes on the segmentation results, matching the given topology.

The default setting for this parameter is EOCR2DetectionMethod::EOCR2DetectionMethod_FixedWidth. This parameter is ignored when the topology is not required.

◆ GetEnableCutLargeCharacter()

bool eVision::EOCR2::GetEnableCutLargeCharacter ( ) const

Sets whether EOCR2 detection should split or not segmented blobs into multiple characters if they are wider than the given character width range parameter. The default setting for this parameter is false, and it is only applicable when the topology is not required or when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_Proportional.

◆ GetEnabledTopology()

bool eVision::EOCR2::GetEnabledTopology ( ) const

Sets whether the topology is required or not. If it is, EOCR2 will try to detect the topology accordingly with the EOCR2DetectionMethod parameter. The default setting for this parameter is true and topology has to be given with EOCR2::SetTopology.

◆ GetEnableGPU()

bool eVision::EOCR2::GetEnableGPU ( ) const

Sets/Gets whether EOCR2 uses a GPU to accelerate its processing.

Currently only the recognition with a deep-learning classifier can be accelerated with GPU.

◆ GetEnableOffSizeCharacter()

bool eVision::EOCR2::GetEnableOffSizeCharacter ( ) const

Sets whether EOCR2 allows or not the detection of characters whose size (width and height) is out of the size parameters if they are in the vicinity of characters in valid size range. The default setting for this parameter is true, and it is only applicable when the topology is not required.

◆ GetEnableSecondPassGlobalSegmentation()

bool eVision::EOCR2::GetEnableSecondPassGlobalSegmentation ( ) const

Sets whether EOCR2 segmentation should do or not do an extra pass to determine the best threshold using the EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global segmentation method. The default setting for this parameter is false, and it is only applicable when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global.

The extra pass adds computation.

◆ GetGlobalSegmentationAbsoluteThreshold()

int eVision::EOCR2::GetGlobalSegmentationAbsoluteThreshold ( ) const

Gets the value of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Absolute .

◆ GetGlobalSegmentationRelativeThreshold()

float eVision::EOCR2::GetGlobalSegmentationRelativeThreshold ( ) const

Sets/Gets the fraction of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Relative .

◆ GetGlobalSegmentationThresholdMode()

eVision::EThresholdMode eVision::EOCR2::GetGlobalSegmentationThresholdMode ( ) const

Sets/Gets the EThresholdMode used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. From the EThresholdMode, a threshold will be computed during the segmentation. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack, pixels above or equal to the threshold will be segmented. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_BlackOnWhite, pixels under the threshold will be segmented.

The default setting for this parameter is EThresholdMode::EThresholdMode_MinResidue.

◆ GetGPUIndexes()

std::vector< uint32_t > eVision::EOCR2::GetGPUIndexes ( ) const

Sets/gets the GPUs to use when computing.

◆ GetMaxVariation()

float eVision::EOCR2::GetMaxVariation ( ) const

Sets the maxVariation parameter for the segmentation algorithm. This parameter determines how stable a blob in the image should be in order to be considered a potential character, a region with clearly defined edges is generally considered stable while a blurry region is not. A high setting allows more unstable blobs, a low setting allows only very stable blobs.

This parameter should be set between 0.0 and 1.0, the default setting is 0.25.

◆ GetNumDetectionPasses()

int32_t eVision::EOCR2::GetNumDetectionPasses ( ) const

Sets the NumDetectionPasses parameter for the topology fitting algorithm, which will place text boxes on the segmentation results (blobs). The first pass will consider all blobs, subsequent passes will only consider those blobs that are inside the text boxes from the previous pass, sometimes resulting in a more optimal fit.

This parameter is used whether the topology is required or not. The default setting for this parameter is 1, the setting can be either 1 or 2.

◆ GetReadText()

eVision::EOCR2Text eVision::EOCR2::GetReadText ( ) const

Outputs an EOCR2Text structure containing the detailed detection and recognition results.

Deprecated

Use the returned EOCR2Text instead.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ GetRelativeSpacesWidthRange()

eVision::EFloatRange eVision::EOCR2::GetRelativeSpacesWidthRange ( ) const

Sets the range of expected spaces between words as a fraction of the character width.

This parameter only affects the detection when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_FixedWidth or when the topology is not required. The RelativeSpacesWidthRange is returned by reference, changing it will affect the internal state of the EOCR2 object.

◆ GetRepasteObjects()

bool eVision::EOCR2::GetRepasteObjects ( ) const

Sets whether EOCR2 groups or does not group the blobs believed to belong to the same character. The default setting for this parameter is true, and it is only applicable when the topology is not required.

◆ GetSegmentationMethod()

eVision::EOCR2SegmentationMethod eVision::EOCR2::GetSegmentationMethod ( ) const

Sets the EOCR2SegmentationMethod parameter for the segmentation algorithm, which will detect blobs in the image.

The default setting for this parameter is EOCR2SegmentationMethod::EOCR2SegmentationMethod_Local.

◆ GetTextAngleRange()

eVision::EFloatRange eVision::EOCR2::GetTextAngleRange ( ) const

Sets the TextAngleRange parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.

This will determine the range of angles that will be tested, defined as: TextAngleRange.min() <= angle <= TextAngleRange.max()

This parameter is used whether the topology is required or not. The default setting for this parameter is -20 degrees to +20 degrees.

◆ GetTextAngleTolerance()

float eVision::EOCR2::GetTextAngleTolerance ( ) const

Sets the TextAngleTolerance parameter for the topology fitting algorithm, which finds the angle of the text in the image with respect to the horizontal.

This will limit the range of angles that will be tested, defined as: BaseAngle - AngleTolerance <= angle <= BaseAngle + AngleTolerance

This function follows the angle unit convention defined by Easy::SetAngleUnit. The default setting for this parameter is 20 degrees.

Deprecated

Use EOCR2::SetTextAngleRange instead

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

◆ GetTextBaseAngle()

float eVision::EOCR2::GetTextBaseAngle ( ) const

Sets the TextBaseAngle parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.

This will determine the center of the range of angles that will be tested, defined as: BaseAngle - AngleTolerance <= angle <= BaseAngle + AngleTolerance

This function follows the angle unit convention defined by Easy::SetAngleUnit. The default setting for this parameter is 0 degrees.

Deprecated

Use EOCR2::SetTextAngleRange instead

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

◆ GetTextPolarity()

eVision::EasyOCR2TextPolarity eVision::EOCR2::GetTextPolarity ( ) const

Sets the TextPolarity parameter for the segmentation algorithm. This will determine whether the algorithm searches for light blobs in a dark background or for dark blobs in a light background.

Default setting is EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack.

◆ GetTimeOut()

uint64_t eVision::EOCR2::GetTimeOut ( ) const

Time-out for the EOCR2::Read, EOCR2::Detect and EOCR2::Recognize methods.

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is EError::EError_TimeoutReached. The time-out is set in microseconds. This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out in itself.

◆ GetTopology()

std::string eVision::EOCR2::GetTopology ( ) const

Sets the topology of the text that should be found in the image. A modified version of Regex expressions are used, where:

  • .(dot) represents any character (not including a space).
  • L represents a letter.
  • Lu represents an uppercase letter.
  • Ll represents a lowercase letter.
  • N represents a digit.
  • P represents a punctuation character !"#&'()*,-./:;<>?[\]_{|}~
  • S represents the symbols $;+-<=>|~

  • represents a line break.
  • ' ' (space) represents a space between two words.

Combinations can be made, for example: [LN] represents an alphanumeric character. To specify multiple characters, simply add {n} at the end for n characters. If the amount of characters is uncertain, specify {n,m} for a minimum of n characters and a maximum of m characters.

The topology "`[LuN]{3,5}PN{4} \n .{5} LL`" represents a text comprised of 2 lines: The first line has 1 word composed of 3 to 5 uppercase alphanumeric characters, followed by a punctuation character and 4 numbers. The second line has 2 words. The first word consists of 5 wildcard characters, the second word has 2 alphabetic characters (upper- or lowercase).

◆ HasDatabaseClassifier()

bool eVision::EOCR2::HasDatabaseClassifier ( ) const

Returns whether this reader has a database classifier set and ready to use.

Returns true if at least one character has been added to the database classifier.

Even if the returned value is true, the database classifier will only be used if the EOCR2::GetClassifier has been set to EOCR2Classifier::EOCR2Classifier_DatabaseClassifier.

◆ HitTestChar() [1/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t & lineN,
int32_t & wordN,
int32_t & charN,
int32_t x,
int32_t y )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
lineNReturns the line-number of the character if one was detected under the cursor.
wordNReturns the word-number of the character if one was detected under the cursor.
charNReturns the character-number of the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
Deprecated
Deprecated in version 24.2. Scheduled to be removed in version 27.6.

◆ HitTestChar() [2/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t & lineN,
int32_t & wordN,
int32_t & charN,
int32_t x,
int32_t y,
float zoomX )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
lineNReturns the line-number of the character if one was detected under the cursor.
wordNReturns the word-number of the character if one was detected under the cursor.
charNReturns the character-number of the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated
Deprecated in version 24.2. Scheduled to be removed in version 27.6.

◆ HitTestChar() [3/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t & lineN,
int32_t & wordN,
int32_t & charN,
int32_t x,
int32_t y,
float zoomX,
float zoomY )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
lineNReturns the line-number of the character if one was detected under the cursor.
wordNReturns the word-number of the character if one was detected under the cursor.
charNReturns the character-number of the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated
Deprecated in version 24.2. Scheduled to be removed in version 27.6.

◆ HitTestChar() [4/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t & lineN,
int32_t & wordN,
int32_t & charN,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
lineNReturns the line-number of the character if one was detected under the cursor.
wordNReturns the word-number of the character if one was detected under the cursor.
charNReturns the character-number of the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated
Deprecated in version 24.2. Scheduled to be removed in version 27.6.

◆ HitTestChar() [5/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t & lineN,
int32_t & wordN,
int32_t & charN,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
lineNReturns the line-number of the character if one was detected under the cursor.
wordNReturns the word-number of the character if one was detected under the cursor.
charNReturns the character-number of the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated
Deprecated in version 24.2. Scheduled to be removed in version 27.6.

◆ HitTestChar() [6/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestChar() [7/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y,
float zoomX )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestChar() [8/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y,
float zoomX,
float zoomY )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestChar() [9/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestChar() [10/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestChar() [11/11]

bool eVision::EOCR2::HitTestChar ( eVision::EOCR2Char & character,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame )

Tests the cursor position for the presence of a character. If one is present under the cursor, it returns true and fills the EOCR2Char object passed as parameter.

Parameters
characterReturns the character if one was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the read of the specified character.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [1/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [2/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y,
float zoomX )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [3/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y,
float zoomX,
float zoomY )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [4/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [5/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestLine() [6/6]

bool eVision::EOCR2::HitTestLine ( eVision::EOCR2Line & line,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame )

Tests the cursor position for the presence of a line. If one is present under the cursor, it returns true and fills the EOCR2Line object passed as parameter.

Parameters
lineObject to fill if a line was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the read of the specified line.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [1/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [2/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y,
float zoomX ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [3/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y,
float zoomX,
float zoomY ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [4/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [5/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestText() [6/6]

bool eVision::EOCR2::HitTestText ( eVision::EOCR2Text & text,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame ) const

Tests the cursor position for the presence of a text. If one is present under the cursor, it returns true and fills the EOCR2Text object passed as parameter.

Parameters
textObject to fill if a text was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the read of the specified text.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [1/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [2/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y,
float zoomX )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [3/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y,
float zoomX,
float zoomY )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [4/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [5/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ HitTestWord() [6/6]

bool eVision::EOCR2::HitTestWord ( eVision::EOCR2Word & word,
int32_t x,
int32_t y,
float zoomX,
float zoomY,
float panX,
float panY,
const eVision::EFrame & frame )

Tests the cursor position for the presence of a word. If one is present under the cursor, it returns true and fills the EOCR2Word object passed as parameter.

Parameters
wordObject to fill if a word was detected under the cursor.
xHorizontal position of the cursor.
yVertical position of the cursor.
zoomXHorizontal zooming factor. By default, true scale is used.
zoomYVertical zooming factor. If set to 0 (default), the horizontal zooming factor is used instead, so as to provide isotropic zooming.
panXHorizontal panning value expressed in pixels. By default, no panning occurs.
panYVertical panning value expressed in pixels. By default, no panning occurs.
frameFrame used in the read of the specified word.
Deprecated

Use the Hit methods attached to the returned EOCR2Text

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ Learn() [1/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Char & character)

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
characterA single EOCR2Char character, containing the detected character from the reference image as well as the corresponding character code.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [2/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Char & character,
const eVision::EFrame & frame )

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
characterA single EOCR2Char character, containing the detected character from the reference image as well as the corresponding character code.
frameFrame used in the read of the specified character, word, line or text.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [3/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Line & line)

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
lineA single EOCR2Line line, containing the detected characters in a single line from the reference image as well as the corresponding character codes.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [4/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Line & line,
const eVision::EFrame & frame )

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
lineA single EOCR2Line line, containing the detected characters in a single line from the reference image as well as the corresponding character codes.
frameFrame used in the read of the specified character, word, line or text.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [5/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Text & text)

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
textA complete EOCR2Text text, containing all detected characters from the reference image as well as the corresponding character codes.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [6/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Text & text,
const eVision::EFrame & frame )

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
textA complete EOCR2Text text, containing all detected characters from the reference image as well as the corresponding character codes.
frameFrame used in the read of the specified character, word, line or text.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [7/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Word & word)

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
wordA single EOCR2Word word, containing the detected characters in a single word from the reference image as well as the corresponding character codes.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Learn() [8/8]

void eVision::EOCR2::Learn ( const eVision::EOCR2Word & word,
const eVision::EFrame & frame )

Learns reference characters from a given EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance, containing user-specified character codes.

Parameters
wordA single EOCR2Word word, containing the detected characters in a single word from the reference image as well as the corresponding character codes.
frameFrame used in the read of the specified character, word, line or text.

The EOCR2Text/EOCR2Line/EOCR2Word/EOCR2Char instance should contain detected characters from a reference image as well as their corresponding character codes.

◆ Load() [1/2]

void eVision::EOCR2::Load ( const std::string & modelPath)

Loads a model, containing parameter settings used for all operations in EOCR2::EOCR2, from disk.

Parameters
modelPathA string containing the full path to the model file.

◆ Load() [2/2]

void eVision::EOCR2::Load ( eVision::ESerializer * serializer)

Loads a model, containing parameter settings used for all operations in EOCR2::EOCR2, from disk.

Parameters
serializerThe serializer.

◆ operator=()

eVision::EOCR2 & eVision::EOCR2::operator= ( const eVision::EOCR2 & other)

Assignment operator, copies another EOCR2 instance to this one.

Parameters
otherThe EOCR2 instance to copy from.

◆ Read() [1/2]

std::string eVision::EOCR2::Read ( const eVision::EROIBW8 & srcRoi)

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a string.

Parameters
srcRoiThe source image/ROI.

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

Deprecated

Use the EOCR2::Read2.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ Read() [2/2]

std::string eVision::EOCR2::Read ( const eVision::EROIBW8 & srcRoi,
const eVision::ERegion & region )

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a string.

Parameters
srcRoiThe source image/ROI.
regionThe region of interest where the reading is performed

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Read2() [1/4]

eVision::EOCR2Text eVision::EOCR2::Read2 ( const eVision::EROIBW8 & srcRoi)

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a EOCR2Text.

Parameters
srcRoiThe source image/ROI.

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Read2() [2/4]

eVision::EOCR2Text eVision::EOCR2::Read2 ( const eVision::EROIBW8 & srcRoi,
const eVision::EFrame & frame )

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a EOCR2Text.

Parameters
srcRoiThe source image/ROI.
frameReference frame of the input region.

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Read2() [3/4]

eVision::EOCR2Text eVision::EOCR2::Read2 ( const eVision::EROIBW8 & srcRoi,
const eVision::ERegion & region )

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a EOCR2Text.

Parameters
srcRoiThe source image/ROI.
regionThe region of interest where the reading is performed

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Read2() [4/4]

eVision::EOCR2Text eVision::EOCR2::Read2 ( const eVision::EROIBW8 & srcRoi,
const eVision::ERegion & region,
const eVision::EFrame & frame )

Performs all steps required for reading text from an image:

  1. Detects potential characters in the image following the given text polarity and character width/height.
  2. Fits bounding boxes to the detected characters, following the given topology and character width/height.
  3. Recognizes the detected characters using the given reference character database.

The read text is output as a EOCR2Text.

Parameters
srcRoiThe source image/ROI.
regionThe region of interest where the reading is performed
frameReference frame of the input region.

The variables TextPolarity, Topology, CharHeight, CharWidth should be set and a reference character database should be set before performing this operation. If the srcRoi is smaller than 3X3, an exception will be thrown.

◆ Recognize() [1/4]

std::string eVision::EOCR2::Recognize ( const eVision::EOCR2Text & text)

Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.

Parameters
textEOCR2Text structure containing the detected characters from the image.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

Deprecated

Use the Recognize method that modifies the input EOCR2Text.

Deprecated in version 26.10. Scheduled to be removed in version 27.10.

◆ Recognize() [2/4]

std::string eVision::EOCR2::Recognize ( const eVision::EOCR2Text & text,
const eVision::EFrame & frame )

Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.

Parameters
textEOCR2Text structure containing the detected characters from the image.
frameReference frame used during detection.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

◆ Recognize() [3/4]

std::string eVision::EOCR2::Recognize ( const eVision::EOCR2Text & text,
const eVision::EROIBW8 & srcRoi )

Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.

Parameters
textEOCR2Text structure containing the detected characters from the image.
srcRoiThe source image/ROI.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

◆ Recognize() [4/4]

std::string eVision::EOCR2::Recognize ( const eVision::EOCR2Text & text,
const eVision::EROIBW8 & srcRoi,
const eVision::EFrame & frame )

Recognizes the characters in a given EOCR2Text instance, based on a given reference font. This overload does not update the input text.

Parameters
textEOCR2Text structure containing the detected characters from the image.
srcRoiThe source image/ROI.
frameReference frame used during detection.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

◆ RecognizeText() [1/2]

void eVision::EOCR2::RecognizeText ( eVision::EOCR2Text & text)

Recognizes the characters in a given EOCR2Text instance, based on a given reference font.

Parameters
textEOCR2Text structure containing the detected characters from the image.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

◆ RecognizeText() [2/2]

void eVision::EOCR2::RecognizeText ( eVision::EOCR2Text & text,
const eVision::EFrame & frame )

Recognizes the characters in a given EOCR2Text instance, based on a given reference font.

Parameters
textEOCR2Text structure containing the detected characters from the image.
frameReference frame used during detection.

A reference character database should be provided before performing this operation. The overloaded function that uses an ROI is not yet implemented.

◆ RemoveClassifierForSymbol()

void eVision::EOCR2::RemoveClassifierForSymbol ( const std::string & symbol)

Removes the EOCR2Classifier for the given specific symbol combination during the recognition so the one set by EOCR2::GetClassifier will be used.

Parameters
symbolsymbol combination for which to remove classifier

Symbol combinations are the same as used in the topology, ex : Lu, P or [LlNS]. See EOCR2::SetTopology for more details.

◆ Save() [1/2]

void eVision::EOCR2::Save ( const std::string & modelPath)

Saves the model to disk, containing the current parameter setting used for all operations in EOCR2.

Parameters
modelPathA string containing the full path to the model file.

It is advised to use a file extension that is non-standard (for instance *.ocr2)

◆ Save() [2/2]

void eVision::EOCR2::Save ( eVision::ESerializer * serializer)

Saves the model to disk, containing the current parameter setting used for all operations in EOCR2.

Parameters
serializerThe serializer.

It is advised to use a file extension that is non-standard (for instance *.ocr2)

◆ SaveCharacterDatabase()

void eVision::EOCR2::SaveCharacterDatabase ( const std::string & file)

Saves the current reference character database to disk.

Parameters
fileA string containing the path of the file.

◆ SetAllowedCharacterTypes()

void eVision::EOCR2::SetAllowedCharacterTypes ( eVision::EasyOCR2CharacterFilter allowedCharacterTypes)

Sets which character types are expected when EOCR2::SetEnabledTopology is false. The set of expected character types is represented by a bitwise combination of different EasyOCR2CharacterFilter.

For example, digits and uppercase letters can be expressed by EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_UpperCaseLetters | EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_Digits. The default setting for this parameter is EasyOCR2CharacterFilter::EasyOCR2CharacterFilter_ASCII.

◆ SetCharacterDatabase()

void eVision::EOCR2::SetCharacterDatabase ( const eVision::EOCR2CharacterDatabase & database)

Sets the EOCR2CharacterDatabase used for recognizing text.

Setting a new characterDatabase will overwrite the current one.

◆ SetCharsHeight()

void eVision::EOCR2::SetCharsHeight ( int32_t height)

Sets the expected character height in pixels.

◆ SetCharsMaxFragmentation()

void eVision::EOCR2::SetCharsMaxFragmentation ( float charMaxFragmentation)

Sets the CharsMaxFragmentation parameter for the segmentation algorithm. This will determine the minimum size a blob should be in order to be considered a potential character. A high setting will allow only larger blobs, a low setting will also allow smaller blobs.

The minimum blob size to be considered a potential character is defined as: CharsMaxFragmentation * CharsHeight * CharsWidth

This parameter should be set between 0.0 and 1.0, the default setting is 0.1.

◆ SetCharsSpacingBias()

void eVision::EOCR2::SetCharsSpacingBias ( eVision::EasyOCR2CharSpacingBias charSpacingBias)

Sets the CharSpacingBias parameter for the topology fitting algorithm, which optimizes the spacing of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow spacing, wide spacing or is neutral.

The default setting for this parameter is EasyOCR2CharSpacingBias::EasyOCR2CharSpacingBias_Neutral

◆ SetCharsWidth()

void eVision::EOCR2::SetCharsWidth ( int32_t width)

Sets the expected character width in pixels.

Deprecated

Use EOCR2::SetCharsWidthRange instead.

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

◆ SetCharsWidthBias()

void eVision::EOCR2::SetCharsWidthBias ( eVision::EasyOCR2CharWidthBias charWidthBias)

Sets the CharsWidthBias parameter for the topology fitting algorithm, which optimizes the width of the bounding boxes to optimally fit the detected blobs. This will determine whether the method is biased toward finding narrow boxes, wide boxes or is neutral.

The default setting for this parameter is EasyOCR2CharWidthBias::EasyOCR2CharWidthBias_Neutral

◆ SetCharsWidthRange()

void eVision::EOCR2::SetCharsWidthRange ( const eVision::EIntegerRange & range)

Sets the range of expected character widths in pixels.

◆ SetCharsWidthTolerance()

void eVision::EOCR2::SetCharsWidthTolerance ( float charWidthTolerance)

Sets the CharsWidthTolerance parameter for the topology fitting algorithm, which will attempt to optimize the width of the bounding boxes to optimally fit the detected blobs.

This will determine the range of bounding box sizes that will be accepted, defined as: (1 - CharsWidthTolerance) * CharsWidth <= BBoxWidth <= (1 + CharsWidthTolerance) * CharsWidth

The CharsWidthTolerance parameter should be between 0.0 and 1.0, the default setting is 0.25.

Deprecated

Use EOCR2::SetCharsWidthRange instead.

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

◆ SetClassifier()

void eVision::EOCR2::SetClassifier ( eVision::EOCR2Classifier classifier)

Sets the EOCR2Classifier parameter for the recognition algorithm. This will determine which classifier will be used for the recognition.

The default setting for this parameter is EOCR2Classifier::EOCR2Classifier_DatabaseClassifier.

◆ SetDetectionDelta()

void eVision::EOCR2::SetDetectionDelta ( int32_t delta)

Sets the DetectionDelta parameter for the segmentation algorithm. This will determine the range of grayscale-values used to determine the stability of a blob. A low setting will make the algorithm more sensitive to noise, a high setting will make the algorithm insensitive to blobs with low contrast to the background.

This parameter should be set between 0 and 127, the default setting is 12.

◆ SetDetectionMethod()

void eVision::EOCR2::SetDetectionMethod ( eVision::EOCR2DetectionMethod method)

Sets the EOCR2DetectionMethod parameter for the topology fitting algorithm, which will place text boxes on the segmentation results, matching the given topology.

The default setting for this parameter is EOCR2DetectionMethod::EOCR2DetectionMethod_FixedWidth. This parameter is ignored when the topology is not required.

◆ SetEnableCutLargeCharacter()

void eVision::EOCR2::SetEnableCutLargeCharacter ( bool enableCutLargeCharacter)

Sets whether EOCR2 detection should split or not segmented blobs into multiple characters if they are wider than the given character width range parameter. The default setting for this parameter is false, and it is only applicable when the topology is not required or when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_Proportional.

◆ SetEnabledTopology()

void eVision::EOCR2::SetEnabledTopology ( bool enableTopology)

Sets whether the topology is required or not. If it is, EOCR2 will try to detect the topology accordingly with the EOCR2DetectionMethod parameter. The default setting for this parameter is true and topology has to be given with EOCR2::SetTopology.

◆ SetEnableGPU()

void eVision::EOCR2::SetEnableGPU ( bool enable)

Sets/Gets whether EOCR2 uses a GPU to accelerate its processing.

Currently only the recognition with a deep-learning classifier can be accelerated with GPU.

◆ SetEnableOffSizeCharacter()

void eVision::EOCR2::SetEnableOffSizeCharacter ( bool enableOffSizeCharacter)

Sets whether EOCR2 allows or not the detection of characters whose size (width and height) is out of the size parameters if they are in the vicinity of characters in valid size range. The default setting for this parameter is true, and it is only applicable when the topology is not required.

◆ SetEnableSecondPassGlobalSegmentation()

void eVision::EOCR2::SetEnableSecondPassGlobalSegmentation ( bool secondPassGlobalSegmentation)

Sets whether EOCR2 segmentation should do or not do an extra pass to determine the best threshold using the EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global segmentation method. The default setting for this parameter is false, and it is only applicable when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global.

The extra pass adds computation.

◆ SetGlobalSegmentationAbsoluteThreshold()

void eVision::EOCR2::SetGlobalSegmentationAbsoluteThreshold ( int absoluteThreshold)

Sets the value of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Absolute .

Parameters
absoluteThresholdValue of the image pixels that will be set below the threshold.

◆ SetGlobalSegmentationRelativeThreshold()

void eVision::EOCR2::SetGlobalSegmentationRelativeThreshold ( float relativeThreshold)

Sets/Gets the fraction of the image pixels that will be set below the threshold used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. It is only used when the GlobalSegmentationThresholdMode value is EThresholdMode::EThresholdMode_Relative .

Parameters
relativeThresholdFraction of the image pixels that will be set below the threshold (by default, relativeThreshold = 0.5).

◆ SetGlobalSegmentationThresholdMode()

void eVision::EOCR2::SetGlobalSegmentationThresholdMode ( eVision::EThresholdMode thresholdMode)

Sets/Gets the EThresholdMode used when the segmentation method is set to EOCR2SegmentationMethod::EOCR2SegmentationMethod_Global. From the EThresholdMode, a threshold will be computed during the segmentation. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack, pixels above or equal to the threshold will be segmented. While using EasyOCR2TextPolarity::EasyOCR2TextPolarity_BlackOnWhite, pixels under the threshold will be segmented.

Parameters
thresholdModeThe thresholding mode, as defined by the enumeration EThresholdMode. To use absolute thresholding, use directly the threshold value instead.

The default setting for this parameter is EThresholdMode::EThresholdMode_MinResidue.

◆ SetGPUIndexes()

void eVision::EOCR2::SetGPUIndexes ( const std::vector< uint32_t > & index)

Sets/gets the GPUs to use when computing.

Parameters
indexGPU Index.

◆ SetMaxVariation()

void eVision::EOCR2::SetMaxVariation ( float maxVariation)

Sets the maxVariation parameter for the segmentation algorithm. This parameter determines how stable a blob in the image should be in order to be considered a potential character, a region with clearly defined edges is generally considered stable while a blurry region is not. A high setting allows more unstable blobs, a low setting allows only very stable blobs.

This parameter should be set between 0.0 and 1.0, the default setting is 0.25.

◆ SetNumDetectionPasses()

void eVision::EOCR2::SetNumDetectionPasses ( int32_t nDetectionPasses)

Sets the NumDetectionPasses parameter for the topology fitting algorithm, which will place text boxes on the segmentation results (blobs). The first pass will consider all blobs, subsequent passes will only consider those blobs that are inside the text boxes from the previous pass, sometimes resulting in a more optimal fit.

This parameter is used whether the topology is required or not. The default setting for this parameter is 1, the setting can be either 1 or 2.

◆ SetRelativeSpacesWidthRange()

void eVision::EOCR2::SetRelativeSpacesWidthRange ( const eVision::EFloatRange & range)

Sets the range of expected spaces between words as a fraction of the character width.

This parameter only affects the detection when the detectionMethod is set to EOCR2DetectionMethod::EOCR2DetectionMethod_FixedWidth or when the topology is not required. The RelativeSpacesWidthRange is returned by reference, changing it will affect the internal state of the EOCR2 object.

◆ SetRepasteObjects()

void eVision::EOCR2::SetRepasteObjects ( bool repasteObjects)

Sets whether EOCR2 groups or does not group the blobs believed to belong to the same character. The default setting for this parameter is true, and it is only applicable when the topology is not required.

◆ SetSegmentationMethod()

void eVision::EOCR2::SetSegmentationMethod ( eVision::EOCR2SegmentationMethod method)

Sets the EOCR2SegmentationMethod parameter for the segmentation algorithm, which will detect blobs in the image.

The default setting for this parameter is EOCR2SegmentationMethod::EOCR2SegmentationMethod_Local.

◆ SetTextAngleRange()

void eVision::EOCR2::SetTextAngleRange ( const eVision::EFloatRange & range)

Sets the TextAngleRange parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.

This will determine the range of angles that will be tested, defined as: TextAngleRange.min() <= angle <= TextAngleRange.max()

This parameter is used whether the topology is required or not. The default setting for this parameter is -20 degrees to +20 degrees.

◆ SetTextAngleTolerance()

void eVision::EOCR2::SetTextAngleTolerance ( float textAngleTolerance)

Sets the TextAngleTolerance parameter for the topology fitting algorithm, which finds the angle of the text in the image with respect to the horizontal.

This will limit the range of angles that will be tested, defined as: BaseAngle - AngleTolerance <= angle <= BaseAngle + AngleTolerance

This function follows the angle unit convention defined by Easy::SetAngleUnit. The default setting for this parameter is 20 degrees.

Deprecated

Use EOCR2::SetTextAngleRange instead

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

◆ SetTextBaseAngle()

void eVision::EOCR2::SetTextBaseAngle ( float textBaseAngle)

Sets the TextBaseAngle parameter for the topology fitting algorithm, which will attempt to find the angle of the text in the image with respect to the horizontal.

This will determine the center of the range of angles that will be tested, defined as: BaseAngle - AngleTolerance <= angle <= BaseAngle + AngleTolerance

This function follows the angle unit convention defined by Easy::SetAngleUnit. The default setting for this parameter is 0 degrees.

Deprecated

Use EOCR2::SetTextAngleRange instead

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

◆ SetTextPolarity()

void eVision::EOCR2::SetTextPolarity ( eVision::EasyOCR2TextPolarity polarity)

Sets the TextPolarity parameter for the segmentation algorithm. This will determine whether the algorithm searches for light blobs in a dark background or for dark blobs in a light background.

Default setting is EasyOCR2TextPolarity::EasyOCR2TextPolarity_WhiteOnBlack.

◆ SetTimeOut()

void eVision::EOCR2::SetTimeOut ( uint64_t value)

Time-out for the EOCR2::Read, EOCR2::Detect and EOCR2::Recognize methods.

If the processing time of one of these functions becomes longer than the set time-out, the processing is stopped and an exception is thrown. In that case, the error code of the exception is EError::EError_TimeoutReached. The time-out is set in microseconds. This time-out is not a real time-out. The processing is stopped as soon as possible after the time-out has been reached. This means that the time elapsed effectively in the method can be greater than the time-out in itself.

◆ SetTopology()

void eVision::EOCR2::SetTopology ( const std::string & topology)

Sets the topology of the text that should be found in the image. A modified version of Regex expressions are used, where:

  • .(dot) represents any character (not including a space).
  • L represents a letter.
  • Lu represents an uppercase letter.
  • Ll represents a lowercase letter.
  • N represents a digit.
  • P represents a punctuation character !"#&'()*,-./:;<>?[\]_{|}~
  • S represents the symbols $;+-<=>|~

  • represents a line break.
  • ' ' (space) represents a space between two words.

Combinations can be made, for example: [LN] represents an alphanumeric character. To specify multiple characters, simply add {n} at the end for n characters. If the amount of characters is uncertain, specify {n,m} for a minimum of n characters and a maximum of m characters.

The topology "`[LuN]{3,5}PN{4} \n .{5} LL`" represents a text comprised of 2 lines: The first line has 1 word composed of 3 to 5 uppercase alphanumeric characters, followed by a punctuation character and 4 numbers. The second line has 2 words. The first word consists of 5 wildcard characters, the second word has 2 alphabetic characters (upper- or lowercase).

Member Data Documentation

◆ wrappedClass_

CppWrapperInternal::WrappedClass eVision::EOCR2::wrappedClass_