Module NewOCR

Package com.uddernetworks.newocr.recognition

Class OCRActions

java.lang.Object

com.uddernetworks.newocr.recognition.OCRActions

All Implemented Interfaces:

Actions

public class OCRActions
extends java.lang.Object
implements Actions

Provides general OCR actions.

Since:

April 25, 2019

Constructor Summary

Constructors

Constructor	Description
OCRActions(DatabaseManager databaseManager, OCROptions options)	Creates a new OCRActions with a DatabaseManager and OCROptions.
OCRActions(SimilarityManager similarityManager, DatabaseManager databaseManager, OCROptions options)	Creates a new OCRActions with a DatabaseManager and OCROptions.

Method Summary

Modifier and Type	Method	Description
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter)	Actually matches the SearchCharacter object to a real character from the database.
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter, IntPair lineBounds)	Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter, it.unimi.dsi.fastutil.objects.Object2DoubleMap<ImageLetter> diffs)	Actually matches the SearchCharacter object to a real character from the database.
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter, it.unimi.dsi.fastutil.objects.Object2DoubleMap<ImageLetter> diffs, IntPair lineBounds)	Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter, java.util.List<TrainedCharacterData> data)	Actually matches the SearchCharacter object to a real character from the database.
java.util.Optional<ImageLetter>	getCharacterFor(SearchCharacter searchCharacter, java.util.List<TrainedCharacterData> data, IntPair lineBounds)	Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.
java.util.OptionalDouble	getFontSize(ImageLetter imageLetter)	Gets the estimated font size for the given ImageLetter.
void	getLetters(SearchImage searchImage, java.util.List<SearchCharacter> searchCharacters)	Gets the SearchCharacter characters found in the given SearchImage.
java.util.List<CharacterLine>	getLettersDuringTraining(SearchImage searchImage)	Gets the SearchCharacters found in training.
java.util.List<IntPair>	getLineBoundsForTraining(SearchImage image)	Gets the top and bottom line bounds found from the value 2D array.
OCROptions	getOptions()	Gets the OCROptions the Actions is using.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OCRActions

public OCRActions(DatabaseManager databaseManager,
                  OCROptions options)

Creates a new OCRActions with a DatabaseManager and OCROptions. The OCRActions(SimilarityManager, DatabaseManager, OCROptions) constructor is preferred, as without the SimilarityManager there is less-accurate character fetching.

Parameters:

databaseManager - The DatabaseManager to use

options - The OCROptions to use

OCRActions

public OCRActions(SimilarityManager similarityManager,
                  DatabaseManager databaseManager,
                  OCROptions options)

Creates a new OCRActions with a DatabaseManager and OCROptions.

Parameters:

similarityManager - The SimilarityManager to use

databaseManager - The DatabaseManager to use

options - The OCROptions to use

Method Detail

getLetters

public void getLetters(SearchImage searchImage,
                       java.util.List<SearchCharacter> searchCharacters)

Description copied from interface: Actions

Gets the SearchCharacter characters found in the given SearchImage. This works by dividing it up into lines, then horizontally. Each individual section then has vertical padding removed. Any 'characters' that are 2x2 pixels or less are discarded. More information on this method can be found on page 55 of this paper.

Specified by:

getLetters in interface Actions

Parameters:

searchImage - The image to scan

searchCharacters - The list that will have all of the SearchCharacters added to

getLettersDuringTraining

public java.util.List<CharacterLine> getLettersDuringTraining(SearchImage searchImage)

Description copied from interface: Actions

Gets the SearchCharacters found in training. This is different because it assumes that there are whole lines to help group characters.

Specified by:

getLettersDuringTraining in interface Actions

Parameters:

searchImage - The training image to scan

Returns:

A collection of a list contianing the characters in a line

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter,
                                                       IntPair lineBounds)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

lineBounds - The line bounds (Key/value is top/bottom Y values respectively) for improved accuracy

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter,
                                                       java.util.List<TrainedCharacterData> data)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

data - The potential trained TrainedCharacterData to use

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter,
                                                       java.util.List<TrainedCharacterData> data,
                                                       IntPair lineBounds)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

data - The potential trained TrainedCharacterData to use

lineBounds - The line bounds (Key/value is top/bottom Y values respectively) for improved accuracy

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter,
                                                       it.unimi.dsi.fastutil.objects.Object2DoubleMap<ImageLetter> diffs)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

diffs - The potential ImageLetters

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getCharacterFor

public java.util.Optional<ImageLetter> getCharacterFor(SearchCharacter searchCharacter,
                                                       it.unimi.dsi.fastutil.objects.Object2DoubleMap<ImageLetter> diffs,
                                                       IntPair lineBounds)

Description copied from interface: Actions

Actually matches the SearchCharacter object to a real character from the database with line bounds for improved accuracy.

Specified by:

getCharacterFor in interface Actions

Parameters:

searchCharacter - The input SearchCharacter to match to

diffs - The potential ImageLetters

lineBounds - The line bounds (Key/value is top/bottom Y values respectively) for improved accuracy

Returns:

The ImageLetter object with the DatabaseCharacter inside it containing the found character

getFontSize

public java.util.OptionalDouble getFontSize(ImageLetter imageLetter)

Description copied from interface: Actions

Gets the estimated font size for the given ImageLetter.

Specified by:

getFontSize in interface Actions

Parameters:

imageLetter - The ImageLetter to get the font size of

Returns:

The font size in pixels

getLineBoundsForTraining

public java.util.List<IntPair> getLineBoundsForTraining(SearchImage image)

Description copied from interface: Actions

Gets the top and bottom line bounds found from the value 2D array. This is used for getting characters for training data.

Specified by:

getLineBoundsForTraining in interface Actions

Parameters:

image - The image to get the line bounds from

Returns:

A list of the absolute top and bottom line values

getOptions

public OCROptions getOptions()

Description copied from interface: Actions

Gets the OCROptions the Actions is using.

Specified by:

getOptions in interface Actions

Returns:

The OCROptions being used