Struct opencv::text::OCRTesseract

pub struct OCRTesseract { /* private fields */ }

OCRTesseract class provides an interface with the tesseract-ocr API (v3.02.02) in C++.

Notice that it is compiled only when tesseract-ocr is correctly installed.

Note:

• (C++) An example of OCRTesseract recognition combined with scene text detection can be found at the end_to_end_recognition demo: https://github.com/opencv/opencv_contrib/blob/master/modules/text/samples/end_to_end_recognition.cpp
• (C++) Another example of OCRTesseract recognition combined with scene text detection can be found at the webcam_demo: https://github.com/opencv/opencv_contrib/blob/master/modules/text/samples/webcam_demo.cpp

Implementations

impl OCRTesseract

pub fn create( datapath: &str, language: &str, char_whitelist: &str, oem: i32, psmode: i32 ) -> Result<Ptr<OCRTesseract>>

Creates an instance of the OCRTesseract class. Initializes Tesseract.

Parameters

• datapath: the name of the parent directory of tessdata ended with “/”, or NULL to use the system’s default directory.
• language: an ISO 639-3 code or NULL will default to “eng”.
• char_whitelist: specifies the list of characters used for recognition. NULL defaults to “” (All characters will be used for recognition).
• oem: tesseract-ocr offers different OCR Engine Modes (OEM), by default tesseract::OEM_DEFAULT is used. See the tesseract-ocr API documentation for other possible values.
• psmode: tesseract-ocr offers different Page Segmentation Modes (PSM) tesseract::PSM_AUTO (fully automatic layout analysis) is used. See the tesseract-ocr API documentation for other possible values.

Note: The char_whitelist default is changed after OpenCV 4.7.0/3.19.0 from “0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ” to “”.

C++ default parameters

• datapath: NULL
• language: NULL
• char_whitelist: NULL
• oem: OEM_DEFAULT
• psmode: PSM_AUTO

pub fn create_def() -> Result<Ptr<OCRTesseract>>

Creates an instance of the OCRTesseract class. Initializes Tesseract.

Parameters

• datapath: the name of the parent directory of tessdata ended with “/”, or NULL to use the system’s default directory.
• language: an ISO 639-3 code or NULL will default to “eng”.
• char_whitelist: specifies the list of characters used for recognition. NULL defaults to “” (All characters will be used for recognition).
• oem: tesseract-ocr offers different OCR Engine Modes (OEM), by default tesseract::OEM_DEFAULT is used. See the tesseract-ocr API documentation for other possible values.
• psmode: tesseract-ocr offers different Page Segmentation Modes (PSM) tesseract::PSM_AUTO (fully automatic layout analysis) is used. See the tesseract-ocr API documentation for other possible values.

Note: The char_whitelist default is changed after OpenCV 4.7.0/3.19.0 from “0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ” to “”.

Note

This alternative version of OCRTesseract::create function uses the following default values for its arguments:

• datapath: NULL
• language: NULL
• char_whitelist: NULL
• oem: OEM_DEFAULT
• psmode: PSM_AUTO

Trait Implementations

impl BaseOCRTrait for OCRTesseract

fn as_raw_mut_BaseOCR(&mut self) -> *mut c_void

fn run( &mut self, image: &mut impl MatTrait, output_text: &mut String, component_rects: &mut Vector<Rect>, component_texts: &mut Vector<String>, component_confidences: &mut Vector<f32>, component_level: i32 ) -> Result<()>

C++ default parameters

fn run_def( &mut self, image: &mut impl MatTrait, output_text: &mut String ) -> Result<()>

Note

fn run_mask( &mut self, image: &mut impl MatTrait, mask: &mut impl MatTrait, output_text: &mut String, component_rects: &mut Vector<Rect>, component_texts: &mut Vector<String>, component_confidences: &mut Vector<f32>, component_level: i32 ) -> Result<()>

C++ default parameters

fn run_mask_def( &mut self, image: &mut impl MatTrait, mask: &mut impl MatTrait, output_text: &mut String ) -> Result<()>

Note

impl BaseOCRTraitConst for OCRTesseract

fn as_raw_BaseOCR(&self) -> *const c_void

impl Boxed for OCRTesseract

unsafe fn from_raw( ptr: <OCRTesseract as OpenCVFromExtern>::ExternReceive ) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> <OCRTesseract as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> <OCRTesseract as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self ) -> <OCRTesseract as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for OCRTesseract

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for OCRTesseract

fn drop(&mut self)

Executes the destructor for this type.

impl From<OCRTesseract> for BaseOCR

fn from(s: OCRTesseract) -> Self

Converts to this type from the input type.

impl OCRTesseractTrait for OCRTesseract

fn as_raw_mut_OCRTesseract(&mut self) -> *mut c_void

fn run_multiple( &mut self, image: &mut impl MatTrait, output_text: &mut String, component_rects: &mut Vector<Rect>, component_texts: &mut Vector<String>, component_confidences: &mut Vector<f32>, component_level: i32 ) -> Result<()>

Recognize text using the tesseract-ocr API.

fn run_multiple_def( &mut self, image: &mut impl MatTrait, output_text: &mut String ) -> Result<()>

Recognize text using the tesseract-ocr API.

fn run_multiple_mask( &mut self, image: &mut impl MatTrait, mask: &mut impl MatTrait, output_text: &mut String, component_rects: &mut Vector<Rect>, component_texts: &mut Vector<String>, component_confidences: &mut Vector<f32>, component_level: i32 ) -> Result<()>

C++ default parameters

fn run_multiple_mask_def( &mut self, image: &mut impl MatTrait, mask: &mut impl MatTrait, output_text: &mut String ) -> Result<()>

Note

fn run( &mut self, image: &impl ToInputArray, min_confidence: i32, component_level: i32 ) -> Result<String>

C++ default parameters

fn run_def( &mut self, image: &impl ToInputArray, min_confidence: i32 ) -> Result<String>

Note

fn run_mask( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, min_confidence: i32, component_level: i32 ) -> Result<String>

C++ default parameters

fn run_mask_def( &mut self, image: &impl ToInputArray, mask: &impl ToInputArray, min_confidence: i32 ) -> Result<String>

Note

fn set_white_list(&mut self, char_whitelist: &str) -> Result<()>

impl OCRTesseractTraitConst for OCRTesseract

fn as_raw_OCRTesseract(&self) -> *const c_void

impl TryFrom<BaseOCR> for OCRTesseract

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: BaseOCR) -> Result<Self>

Performs the conversion.

impl Send for OCRTesseract