NearOCR

Class SymbolTable

java.lang.Object

NearOCR.SymbolTable

public class SymbolTable
extends java.lang.Object

Stores a table of all outputs correlating to their ideal output as a character and the filepath of the original image which was used to train the net, along with an average 'off' weighting.

Version:

0.1

Author:

Stephen Wattam

See Also:

Symbol

Constructor Summary

Constructors

Constructor and Description
SymbolTable() Creates a blank symbol table
SymbolTable(java.io.FileReader p_file) Creates a new symbol table from a saved symbol table file.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Symbol p_symbol) Adds a symbol to the end of the symbol table.
int	getLength() Returns the length of the table.
Symbol	getSymbol(int p_index) Returns a symbol by index.
Symbol[]	getSymbols() Returns an array with all symbols from this table in.
void	remove(int p_index) Removes a symbol from the table by index.
void	save(java.io.FileWriter fout) Saves the suymbol table to the file provided.
void	setLength(int p_length) Sets the number of weighted nodes every symbol in the table has.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymbolTable

public SymbolTable()

Creates a blank symbol table

SymbolTable

public SymbolTable(java.io.FileReader p_file)
            throws java.io.IOException

Creates a new symbol table from a saved symbol table file.

Parameters:

p_file - The file from which to load

Throws:

java.io.IOException - if any load aspect fails

Method Detail

add

public void add(Symbol p_symbol)

Adds a symbol to the end of the symbol table.

Parameters:

p_symbol - The symbol to append

remove

public void remove(int p_index)
            throws java.lang.IndexOutOfBoundsException

Removes a symbol from the table by index.

Parameters:

p_index - The index of the symbol one wishes to remove

Throws:

java.lang.IndexOutOfBoundsException - in the event that the index number is not pointing to a symbol

save

public void save(java.io.FileWriter fout)
          throws java.io.IOException

Saves the suymbol table to the file provided.

Parameters:

fout - The file to write to.

Throws:

java.io.IOException - in the event that any save aspect fails.

setLength

public void setLength(int p_length)

Sets the number of weighted nodes every symbol in the table has.

Parameters:

p_length - The number of weighted nodes. Ought to be equal to the number of total output neurons in the OCR manager

getSymbol

public Symbol getSymbol(int p_index)
                 throws java.lang.IndexOutOfBoundsException

Returns a symbol by index.

Parameters:

p_index - The index of the symbol to return

Returns:

The desired symbol, if possible

Throws:

java.lang.IndexOutOfBoundsException - in the event that no symbol is found at the index provided.

getSymbols

public Symbol[] getSymbols()

Returns an array with all symbols from this table in.

Returns:

All symbols currently stored in the table, in array form

getLength

public int getLength()

Returns the length of the table.

Returns:

The length of the table, ie how many symbols are in it.