org.bytedeco.opencv.opencv_text

Class OCRBeamSearchDecoder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.opencv.opencv_text.BaseOCR

org.bytedeco.opencv.opencv_text.OCRBeamSearchDecoder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="cv::text")
 @NoOffset
 @Properties(inherit=opencv_text.class)
public class OCRBeamSearchDecoder
extends BaseOCR

\brief 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:

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OCRBeamSearchDecoder.ClassifierCallback \brief Callback with the character classifier is made a class.

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OCRBeamSearchDecoder() Default native constructor.
OCRBeamSearchDecoder(long size) Native array allocator.
OCRBeamSearchDecoder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
static OCRBeamSearchDecoder	create(BytePointer filename, BytePointer vocabulary, GpuMat transition_probabilities_table, GpuMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(BytePointer filename, BytePointer vocabulary, Mat transition_probabilities_table, Mat emission_probabilities_table, int mode, int beam_size) \brief Creates an instance of the OCRBeamSearchDecoder class.
static OCRBeamSearchDecoder	create(BytePointer filename, BytePointer vocabulary, UMat transition_probabilities_table, UMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, BytePointer vocabulary, GpuMat transition_probabilities_table, GpuMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, BytePointer vocabulary, Mat transition_probabilities_table, Mat emission_probabilities_table, int mode, int beam_size) \brief Creates an instance of the OCRBeamSearchDecoder class.
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, BytePointer vocabulary, UMat transition_probabilities_table, UMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, String vocabulary, GpuMat transition_probabilities_table, GpuMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, String vocabulary, Mat transition_probabilities_table, Mat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(OCRBeamSearchDecoder.ClassifierCallback classifier, String vocabulary, UMat transition_probabilities_table, UMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(String filename, String vocabulary, GpuMat transition_probabilities_table, GpuMat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(String filename, String vocabulary, Mat transition_probabilities_table, Mat emission_probabilities_table, int mode, int beam_size)
static OCRBeamSearchDecoder	create(String filename, String vocabulary, UMat transition_probabilities_table, UMat emission_probabilities_table, int mode, int beam_size)
OCRBeamSearchDecoder	position(long position)
BytePointer	run(GpuMat image, GpuMat mask, int min_confidence)
BytePointer	run(GpuMat image, GpuMat mask, int min_confidence, int component_level)
BytePointer	run(GpuMat image, int min_confidence)
BytePointer	run(GpuMat image, int min_confidence, int component_level)
void	run(Mat image, BytePointer output_text)
void	run(Mat image, BytePointer output_text, RectVector component_rects, StringVector component_texts, FloatVector component_confidences, int component_level) \brief Recognize text using Beam Search.
BytePointer	run(Mat image, int min_confidence)
BytePointer	run(Mat image, int min_confidence, int component_level)
void	run(Mat image, Mat mask, BytePointer output_text)
void	run(Mat image, Mat mask, BytePointer output_text, RectVector component_rects, StringVector component_texts, FloatVector component_confidences, int component_level)
BytePointer	run(Mat image, Mat mask, int min_confidence)
BytePointer	run(Mat image, Mat mask, int min_confidence, int component_level)
String	run(UMat image, int min_confidence)
String	run(UMat image, int min_confidence, int component_level)
String	run(UMat image, UMat mask, int min_confidence)
String	run(UMat image, UMat mask, int min_confidence, int component_level)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OCRBeamSearchDecoder

public OCRBeamSearchDecoder()

Default native constructor.

OCRBeamSearchDecoder

public OCRBeamSearchDecoder(long size)

Native array allocator. Access with Pointer.position(long).

OCRBeamSearchDecoder

public OCRBeamSearchDecoder(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Method Detail

position

public OCRBeamSearchDecoder position(long position)

Overrides:

position in class Pointer

run

public void run(@ByRef
                Mat image,
                @StdString @ByRef
                BytePointer output_text,
                RectVector component_rects,
                StringVector component_texts,
                FloatVector component_confidences,
                int component_level)

\brief Recognize text using Beam Search.

Takes image on input and returns recognized text in the output_text parameter. Optionally provides also the Rects for individual text elements found (e.g. words), and the list of those text elements with their confidence values.

Overrides:

run in class BaseOCR

Parameters:

image - Input binary image CV_8UC1 with a single text line (or word).

output_text - Output text. Most likely character sequence found by the HMM decoder.

component_rects - If provided the method will output a list of Rects for the individual text elements found (e.g. words).

component_texts - If provided the method will output a list of text strings for the recognition of individual text elements found (e.g. words).

component_confidences - If provided the method will output a list of confidence values for the recognition of individual text elements found (e.g. words).

component_level - Only OCR_LEVEL_WORD is supported.

run

public void run(@ByRef
                Mat image,
                @StdString @ByRef
                BytePointer output_text)

Overrides:

run in class BaseOCR

run

public void run(@ByRef
                Mat image,
                @ByRef
                Mat mask,
                @StdString @ByRef
                BytePointer output_text,
                RectVector component_rects,
                StringVector component_texts,
                FloatVector component_confidences,
                int component_level)

Overrides:

run in class BaseOCR

run

public void run(@ByRef
                Mat image,
                @ByRef
                Mat mask,
                @StdString @ByRef
                BytePointer output_text)

Overrides:

run in class BaseOCR

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        Mat image,
                                        int min_confidence,
                                        int component_level)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        Mat image,
                                        int min_confidence)

run

@opencv_core.Str
public String run(@ByVal
                                   UMat image,
                                   int min_confidence,
                                   int component_level)

run

@opencv_core.Str
public String run(@ByVal
                                   UMat image,
                                   int min_confidence)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        GpuMat image,
                                        int min_confidence,
                                        int component_level)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        GpuMat image,
                                        int min_confidence)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        Mat image,
                                        @ByVal
                                        Mat mask,
                                        int min_confidence,
                                        int component_level)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        Mat image,
                                        @ByVal
                                        Mat mask,
                                        int min_confidence)

run

@opencv_core.Str
public String run(@ByVal
                                   UMat image,
                                   @ByVal
                                   UMat mask,
                                   int min_confidence,
                                   int component_level)

run

@opencv_core.Str
public String run(@ByVal
                                   UMat image,
                                   @ByVal
                                   UMat mask,
                                   int min_confidence)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        GpuMat image,
                                        @ByVal
                                        GpuMat mask,
                                        int min_confidence,
                                        int component_level)

run

@opencv_core.Str
public BytePointer run(@ByVal
                                        GpuMat image,
                                        @ByVal
                                        GpuMat mask,
                                        int min_confidence)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           Mat transition_probabilities_table,
                                                           @ByVal
                                                           Mat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

\brief 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 ().

beam_size - Size of the beam in Beam Search algorithm.

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           String vocabulary,
                                                           @ByVal
                                                           Mat transition_probabilities_table,
                                                           @ByVal
                                                           Mat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           String vocabulary,
                                                           @ByVal
                                                           UMat transition_probabilities_table,
                                                           @ByVal
                                                           UMat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           UMat transition_probabilities_table,
                                                           @ByVal
                                                           UMat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           GpuMat transition_probabilities_table,
                                                           @ByVal
                                                           GpuMat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Ptr
                                                           OCRBeamSearchDecoder.ClassifierCallback classifier,
                                                           @StdString
                                                           String vocabulary,
                                                           @ByVal
                                                           GpuMat transition_probabilities_table,
                                                           @ByVal
                                                           GpuMat emission_probabilities_table,
                                                           @Cast(value="cv::text::decoder_mode")
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           BytePointer filename,
                                                           @opencv_core.Str
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           Mat transition_probabilities_table,
                                                           @ByVal
                                                           Mat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)

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

\overload

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           String filename,
                                                           @opencv_core.Str
                                                           String vocabulary,
                                                           @ByVal
                                                           Mat transition_probabilities_table,
                                                           @ByVal
                                                           Mat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           String filename,
                                                           @opencv_core.Str
                                                           String vocabulary,
                                                           @ByVal
                                                           UMat transition_probabilities_table,
                                                           @ByVal
                                                           UMat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           BytePointer filename,
                                                           @opencv_core.Str
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           UMat transition_probabilities_table,
                                                           @ByVal
                                                           UMat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           BytePointer filename,
                                                           @opencv_core.Str
                                                           BytePointer vocabulary,
                                                           @ByVal
                                                           GpuMat transition_probabilities_table,
                                                           @ByVal
                                                           GpuMat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)

create

@opencv_core.Ptr
public static OCRBeamSearchDecoder create(@opencv_core.Str
                                                           String filename,
                                                           @opencv_core.Str
                                                           String vocabulary,
                                                           @ByVal
                                                           GpuMat transition_probabilities_table,
                                                           @ByVal
                                                           GpuMat emission_probabilities_table,
                                                           int mode,
                                                           int beam_size)