org.openimaj.tools.ocr

Class FontSimulator<Q,I extends Image<Q,I>>

java.lang.Object

org.openimaj.tools.ocr.FontSimulator<Q,I>

Type Parameters:

Q - The pixel type

I - The concrete image type

public class FontSimulator<Q,I extends Image<Q,I>>
extends Object

Class that will generate images containing a rendering of a String in a random font that has been randomly affected - the idea is to simulate real-world images in a controlled way for training or testing OCR.

Author:

David Dupplaw (dpd@ecs.soton.ac.uk)

Created:

19 Aug 2011

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FontSimulator.FontSimListener<I> This is an interface for objects that are interested in listening for when the FontSimulator creates an image during one of its runs.

Constructor Summary

Constructors

Constructor and Description
FontSimulator(String textString) Create a font simulator that will output the given text string.

Method Summary

Modifier and Type	Method and Description
void	addFontToAvoid(String f) Avoid the font with the given name.
I	generate(I imgExample) Generates a render of the text string in some random font with some random transform.
double	getAngleJitter() Get the amount of angle jitter in use.
int	getFontPointSize() Get the size of the font that is being drawn
List<String>	getFontsToAvoid() Get the list of fonts to avoid.
GeneralFont	getJitteredFont(GeneralFont font) Returns a font that is somewhat randomised from the initial font.
GeneralFontStyle<Q>	getJitteredFontStyle(GeneralFontStyle<Q> gfs) Get a jittered font style
Jama.Matrix	getJitterTransform(I img) Returns an affine transform matrix based on the jitter specifications.
int	getnChars() Get the number of characters being generated.
int	getPadding() Get the amount of padding around the image.
double	getPerspectiveJitter() Get the amount of perspective jitter being simulated
double	getShearJitter() Get the amount of shear jitter in use.
double	getSizeJitter() Get the amount of size jitter in use.
String	getTextString() Get the text string in use.
boolean	isTypeJitter() Get whether the font type is being randomised.
static void	main(String[] args) Simple main that runs a simulation of 5 runs with the text "ABC" or text supplied on the command line.
void	makeRuns(int nRuns, FontSimulator.FontSimListener<I> fsl, I imgExample) Make a number of runs of creating text renders
GeneralFont	pickRandomFont() Picks a random font from your system and returns it.
void	setAngleJitter(double angleJitter) Set the amount of angle jitter to use.
void	setFontPointSize(int fontPointSize) Set the point size of the font to draw
void	setFontsToAvoid(List<String> fontsToAvoid) Set the list of fonts to avoid.
void	setnChars(int nChars) Set the number of characters to randomly generate.
void	setPadding(int padding) Set the padding around the outside of the image.
void	setPerspectiveJitter(double perspectiveJitter) Set the amount of perspective jitter to use.
void	setShearJitter(double shearJitter) Set the amount of shear jitter
void	setSizeJitter(double sizeJitter) Set the amount of size jitter to use.
void	setTextString(String textString) Set the text string to use.
void	setTypeJitter(boolean typeJitter) Set whether to jitter the font type or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

FontSimulator

public FontSimulator(String textString)

Create a font simulator that will output the given text string.

Parameters:

textString - The text string to draw

Method Detail

makeRuns

public void makeRuns(int nRuns,
                     FontSimulator.FontSimListener<I> fsl,
                     I imgExample)

Make a number of runs of creating text renders

Parameters:

nRuns - The number of runs to make

fsl - The listener that will receive the images

imgExample - An example of the type of image

generate

public I generate(I imgExample)

Generates a render of the text string in some random font with some random transform. The input image is not affected or used - it is only used as a seed for generating new instances of that type of image. A new image of the same type is returned.

Parameters:

imgExample - An example of the image to which to draw the text.

Returns:

An image containing the rendered text

pickRandomFont

public GeneralFont pickRandomFont()

Picks a random font from your system and returns it. Checks it against the fontsToAvoid list and will not return a font that is on that list. If a font cannot be returned, the method will return null. The returned font will have plain type and a size of 18 point.

Returns:

A random Font from the system.

getJitteredFont

public GeneralFont getJitteredFont(GeneralFont font)

Returns a font that is somewhat randomised from the initial font. Side-affects the incoming font and returns it.

Parameters:

font - The font to jitter

Returns:

The incoming font altered by jitter specification

getJitterTransform

public Jama.Matrix getJitterTransform(I img)

Returns an affine transform matrix based on the jitter specifications.

Parameters:

img - image to get bounds from

Returns:

An affine transform matrix

getJitteredFontStyle

public GeneralFontStyle<Q> getJitteredFontStyle(GeneralFontStyle<Q> gfs)

Get a jittered font style

Parameters:

gfs - The input font style

Returns:

The jittered font style

setTextString

public void setTextString(String textString)

Set the text string to use. Can be set to null for random characters.

Parameters:

textString - the text string to use

getTextString

public String getTextString()

Get the text string in use.

Returns:

the text string in use

setSizeJitter

public void setSizeJitter(double sizeJitter)

Set the amount of size jitter to use.

Parameters:

sizeJitter - the amount of size jitter to use

getSizeJitter

public double getSizeJitter()

Get the amount of size jitter in use.

Returns:

the amount of size jitter in use.

setAngleJitter

public void setAngleJitter(double angleJitter)

Set the amount of angle jitter to use.

Parameters:

angleJitter - the amount of angle jitter to use

getAngleJitter

public double getAngleJitter()

Get the amount of angle jitter in use.

Returns:

the amount of angle jitter in use.

setShearJitter

public void setShearJitter(double shearJitter)

Set the amount of shear jitter

Parameters:

shearJitter - the amount of shear jitter to use

getShearJitter

public double getShearJitter()

Get the amount of shear jitter in use.

Returns:

the amount of shear jitter in use

setPerspectiveJitter

public void setPerspectiveJitter(double perspectiveJitter)

Set the amount of perspective jitter to use.

Parameters:

perspectiveJitter - the amount of perspective jitter to use

getPerspectiveJitter

public double getPerspectiveJitter()

Get the amount of perspective jitter being simulated

Returns:

the amount of perspective jitter

setFontsToAvoid

public void setFontsToAvoid(List<String> fontsToAvoid)

Set the list of fonts to avoid.

Parameters:

fontsToAvoid - the list of fonts to avoid

getFontsToAvoid

public List<String> getFontsToAvoid()

Get the list of fonts to avoid.

Returns:

the fonts to avoid

addFontToAvoid

public void addFontToAvoid(String f)

Avoid the font with the given name.

Parameters:

f - The font to avoid

setnChars

public void setnChars(int nChars)

Set the number of characters to randomly generate.

Parameters:

nChars - the number of chars to generate

getnChars

public int getnChars()

Get the number of characters being generated.

Returns:

the number of characters to generate

setTypeJitter

public void setTypeJitter(boolean typeJitter)

Set whether to jitter the font type or not.

Parameters:

typeJitter - Whether to jitter the font type

isTypeJitter

public boolean isTypeJitter()

Get whether the font type is being randomised.

Returns:

Whether the font type is being randomised.

setFontPointSize

public void setFontPointSize(int fontPointSize)

Set the point size of the font to draw

Parameters:

fontPointSize - the font point size to use

getFontPointSize

public int getFontPointSize()

Get the size of the font that is being drawn

Returns:

the size of the font being drawn

setPadding

public void setPadding(int padding)

Set the padding around the outside of the image.

Parameters:

padding - the padding amount

getPadding

public int getPadding()

Get the amount of padding around the image.

Returns:

the padding amount

main

public static void main(String[] args)

Simple main that runs a simulation of 5 runs with the text "ABC" or text supplied on the command line.

Parameters:

args -