Module NewOCR

Package com.uddernetworks.newocr.recognition

Class OCRTrain

java.lang.Object

com.uddernetworks.newocr.recognition.OCRTrain

All Implemented Interfaces:

Train

public class OCRTrain
extends java.lang.Object
implements Train

The base class for actually training an image/font.

Since:

April 25, 2019

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	TRAIN_STRING

Constructor Summary

Constructors

Constructor	Description
OCRTrain(DatabaseManager databaseManager, SimilarityManager similarityManager, OCROptions options)	Creates a new OCRTrain.
OCRTrain(DatabaseManager databaseManager, OCROptions options)	Creates a new OCRTrain.
OCRTrain(DatabaseManager databaseManager, OCROptions options, Actions actions)	Creates a new OCRTrain.
OCRTrain(DatabaseManager databaseManager, OCROptions options, Actions actions, TrainGeneratorOptions generatorOptions)	Creates a new OCRTrain.

Method Summary

Modifier and Type	Method	Description
TrainedCharacterData	getTrainedCharacter(java.util.List<TrainedCharacterData> trainedCharacterDataList, char current, int finalModifier)	Gets the TrainedCharacterData with the known letter value of the given character, with the same modifier.
void	trainImage(java.io.File file)	Scans the input image and creates training data based off of it.
void	trainImage(java.io.File file, TrainGeneratorOptions generatorOptions)	Scans the input image and creates training data based off of it.

Methods inherited from class java.lang.Object

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

Field Detail

TRAIN_STRING

public static final java.lang.String TRAIN_STRING

See Also:

Constant Field Values

Constructor Detail

OCRTrain

public OCRTrain(DatabaseManager databaseManager,
                OCROptions options)

Creates a new OCRTrain.

Parameters:

databaseManager - The DatabaseManager to use

options - The OCROptions to use

OCRTrain

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

Creates a new OCRTrain.

Parameters:

databaseManager - The DatabaseManager to use

similarityManager - The SimilarityManager to use

options - The OCROptions to use

OCRTrain

public OCRTrain(DatabaseManager databaseManager,
                OCROptions options,
                Actions actions)

Creates a new OCRTrain.

Parameters:

databaseManager - The DatabaseManager to use

options - The OCROptions to use

actions - The Actions to use

OCRTrain

public OCRTrain(DatabaseManager databaseManager,
                OCROptions options,
                Actions actions,
                TrainGeneratorOptions generatorOptions)

Creates a new OCRTrain.

Parameters:

databaseManager - The DatabaseManager to use

options - The OCROptions to use

actions - The Actions to use

generatorOptions - The TrainGeneratorOptions to use during training

Method Detail

trainImage

public void trainImage(java.io.File file)

Description copied from interface: Train

Scans the input image and creates training data based off of it. It must be an input image created from ComputerTrainGenerator or something of a similar format.

Specified by:

trainImage in interface Train

Parameters:

file - The input image to be trained from

trainImage

public void trainImage(java.io.File file,
                       TrainGeneratorOptions generatorOptions)

Description copied from interface: Train

Scans the input image and creates training data based off of it. It must be an input image created from ComputerTrainGenerator or something of a similar format.

Specified by:

trainImage in interface Train

Parameters:

file - The input image to be trained from

generatorOptions - The options to use, in order to detect font sizes

getTrainedCharacter

public TrainedCharacterData getTrainedCharacter(java.util.List<TrainedCharacterData> trainedCharacterDataList,
                                                char current,
                                                int finalModifier)

Description copied from interface: Train

Gets the TrainedCharacterData with the known letter value of the given character, with the same modifier. If a character is not found, it will be created and added to the given list.

Specified by:

getTrainedCharacter in interface Train

Parameters:

trainedCharacterDataList - The list of TrainedCharacterDatas to search though

current - The character to find

finalModifier - The modifier for the character to find

Returns:

The TrainedCharacterData with the same character and modifier