Struct OCRBeamSearchDecoder

pub struct OCRBeamSearchDecoder { /* private fields */ }

OCRBeamSearchDecoder class provides an interface for OCR using Beam Search algorithm.

Note:

• (C++) An example on using OCRBeamSearchDecoder recognition combined with scene text detection can be found at the demo sample: https://github.com/opencv/opencv_contrib/blob/master/modules/text/samples/word_recognition.cpp

Implementations

impl OCRBeamSearchDecoder

pub fn default() -> OCRBeamSearchDecoder

Creates a default instance of the class by calling the default constructor

pub fn create( classifier: Ptr<OCRBeamSearchDecoder_ClassifierCallback>, vocabulary: &str, transition_probabilities_table: &impl ToInputArray, emission_probabilities_table: &impl ToInputArray, mode: decoder_mode, beam_size: i32, ) -> Result<Ptr<OCRBeamSearchDecoder>>

Creates an instance of the OCRBeamSearchDecoder class. Initializes HMMDecoder.

Parameters

• classifier: The character classifier with built in feature extractor.

• vocabulary: The language vocabulary (chars when ASCII English text). vocabulary.size() must be equal to the number of classes of the classifier.

• transition_probabilities_table: Table with transition probabilities between character pairs. cols == rows == vocabulary.size().

• emission_probabilities_table: Table with observation emission probabilities. cols == rows == vocabulary.size().

• mode: HMM Decoding algorithm. Only OCR_DECODER_VITERBI is available for the moment (http://en.wikipedia.org/wiki/Viterbi_algorithm).

• beam_size: Size of the beam in Beam Search algorithm.

C++ default parameters

• mode: OCR_DECODER_VITERBI
• beam_size: 500

pub fn create_from_file( filename: &str, vocabulary: &str, transition_probabilities_table: &impl ToInputArray, emission_probabilities_table: &impl ToInputArray, mode: decoder_mode, beam_size: i32, ) -> Result<Ptr<OCRBeamSearchDecoder>>

Creates an instance of the OCRBeamSearchDecoder class. Initializes HMMDecoder from the specified path.

Creates an instance of the OCRBeamSearchDecoder class. Initializes HMMDecoder.

Parameters

• classifier: The character classifier with built in feature extractor.

• vocabulary: The language vocabulary (chars when ASCII English text). vocabulary.size() must be equal to the number of classes of the classifier.

• transition_probabilities_table: Table with transition probabilities between character pairs. cols == rows == vocabulary.size().

• emission_probabilities_table: Table with observation emission probabilities. cols == rows == vocabulary.size().

• mode: HMM Decoding algorithm. Only OCR_DECODER_VITERBI is available for the moment (http://en.wikipedia.org/wiki/Viterbi_algorithm).

• beam_size: Size of the beam in Beam Search algorithm.

Overloaded parameters

C++ default parameters

• mode: OCR_DECODER_VITERBI
• beam_size: 500

pub fn create_from_file_def( filename: &str, vocabulary: &str, transition_probabilities_table: &impl ToInputArray, emission_probabilities_table: &impl ToInputArray, ) -> Result<Ptr<OCRBeamSearchDecoder>>

Creates an instance of the OCRBeamSearchDecoder class. Initializes HMMDecoder from the specified path.

@overload

Note

This alternative version of OCRBeamSearchDecoder::create_from_file function uses the following default values for its arguments:

• mode: OCR_DECODER_VITERBI
• beam_size: 500

Trait Implementations

impl BaseOCRTrait for OCRBeamSearchDecoder

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 OCRBeamSearchDecoder

fn as_raw_BaseOCR(&self) -> *const c_void

impl Boxed for OCRBeamSearchDecoder

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for OCRBeamSearchDecoder

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

Formats the value using the given formatter.

impl Default for OCRBeamSearchDecoder

fn default() -> Self

Forwards to infallible Self::default()

impl Drop for OCRBeamSearchDecoder

fn drop(&mut self)

Executes the destructor for this type.

impl From<OCRBeamSearchDecoder> for BaseOCR

fn from(s: OCRBeamSearchDecoder) -> Self

Converts to this type from the input type.

impl OCRBeamSearchDecoderTrait for OCRBeamSearchDecoder

fn as_raw_mut_OCRBeamSearchDecoder(&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 Beam Search.

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

Recognize text using Beam Search.

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

impl OCRBeamSearchDecoderTraitConst for OCRBeamSearchDecoder

fn as_raw_OCRBeamSearchDecoder(&self) -> *const c_void

impl TryFrom<BaseOCR> for OCRBeamSearchDecoder

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 OCRBeamSearchDecoder