Module NewOCR

Package com.uddernetworks.newocr.recognition.similarity

Class DefaultSimilarityManager

java.lang.Object

com.uddernetworks.newocr.recognition.similarity.DefaultSimilarityManager

All Implemented Interfaces:

SimilarityManager

public class DefaultSimilarityManager
extends java.lang.Object
implements SimilarityManager

Uses methods from SimilarRules and checks if characters are similar.

Since:

April 25, 2019

Constructor Summary

Constructors

Constructor	Description
DefaultSimilarityManager()

Method Summary

Modifier and Type	Method	Description
SimilarityManager	addSimilarity(SimilarRule rule)	Adds a SimilarRule to the internal list.
java.util.Optional<SimilarRule>	getRule(java.lang.String similarityRuleName)	Gets the instance of SimilarRule with the given name.
void	getSafeRule(java.lang.String similarityRuleName, java.util.function.Consumer<SimilarRule> ruleConsumer)	Gets a rule from the given name, and if found, sends it through the consumer.
java.util.Optional<it.unimi.dsi.fastutil.objects.Object2DoubleMap.Entry<ImageLetter>>	getSecondHighest(java.util.List<it.unimi.dsi.fastutil.objects.Object2DoubleMap.Entry<ImageLetter>> data)	When given a list of the potential results of a character (Irrelevant what character it is), this will find the character lowest in the list that does not match the first character's letter and modifier to any of the added SimilarRules.
boolean	isSimilar(ImageLetter first, ImageLetter second)	Finds any matching SimilarRules for the first ImageLetter, and then checks if the second ImageLetter also matches any of them.
SimilarityManager	loadDefaults()	Load the default SimilarRules, otherwise all rules will need to be added manually via SimilarityManager.addSimilarity(SimilarRule).
SimilarityManager	removeSimilarity(java.lang.Class<? extends SimilarRule> ruleClass)	Removes a SimilarRule from the internal list if found.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSimilarityManager

public DefaultSimilarityManager()

Method Detail

loadDefaults

public SimilarityManager loadDefaults()

Load the default SimilarRules, otherwise all rules will need to be added manually via SimilarityManager.addSimilarity(SimilarRule).

Returns:

The current SimilarityManager

addSimilarity

public SimilarityManager addSimilarity(SimilarRule rule)

Description copied from interface: SimilarityManager

Adds a SimilarRule to the internal list.

Specified by:

addSimilarity in interface SimilarityManager

Parameters:

rule - The SimilarRule to add

Returns:

The current SimilarityManager

removeSimilarity

public SimilarityManager removeSimilarity(java.lang.Class<? extends SimilarRule> ruleClass)

Description copied from interface: SimilarityManager

Removes a SimilarRule from the internal list if found.

Specified by:

removeSimilarity in interface SimilarityManager

Parameters:

ruleClass - The SimilarRule to add if found

Returns:

The current SimilarityManager

isSimilar

public boolean isSimilar(ImageLetter first,
                         ImageLetter second)

Description copied from interface: SimilarityManager

Finds any matching SimilarRules for the first ImageLetter, and then checks if the second ImageLetter also matches any of them.

Specified by:

isSimilar in interface SimilarityManager

Parameters:

first - The first ImageLetter

second - The second ImageLetter

Returns:

If the two ImageLetters are similar

getRule

public java.util.Optional<SimilarRule> getRule(java.lang.String similarityRuleName)

Description copied from interface: SimilarityManager

Gets the instance of SimilarRule with the given name.

Specified by:

getRule in interface SimilarityManager

Parameters:

similarityRuleName - The name of the SimilarRule to get, if present

Returns:

A SimilarRule with the given name

getSafeRule

public void getSafeRule(java.lang.String similarityRuleName,
                        java.util.function.Consumer<SimilarRule> ruleConsumer)

Description copied from interface: SimilarityManager

Gets a rule from the given name, and if found, sends it through the consumer. A message is sent saying the SimilarRule is not found if one isn't found.

Specified by:

getSafeRule in interface SimilarityManager

Parameters:

similarityRuleName - The name of the SimilarRule to get

ruleConsumer - The consumer to be given the SimilarRule if found

getSecondHighest

public java.util.Optional<it.unimi.dsi.fastutil.objects.Object2DoubleMap.Entry<ImageLetter>> getSecondHighest(java.util.List<it.unimi.dsi.fastutil.objects.Object2DoubleMap.Entry<ImageLetter>> data)

Description copied from interface: SimilarityManager

When given a list of the potential results of a character (Irrelevant what character it is), this will find the character lowest in the list that does not match the first character's letter and modifier to any of the added SimilarRules.

Specified by:

getSecondHighest in interface SimilarityManager

Parameters:

data - The possible combination data

Returns:

If found, the second character