NearOCR

Class ReceptorManager

java.lang.Object

NearOCR.ReceptorManager

public class ReceptorManager
extends java.lang.Object

Manages the currently loaded receptor net and its various properties.

Version:

0.1

Author:

Stephen Wattam

Constructor Summary

Constructors

Constructor and Description
ReceptorManager() Creates an empty set of receptors.
ReceptorManager(java.io.FileReader p_file) Loads a set of receptors from a file.
ReceptorManager(ReceptorPattern p_pattern, int p_number) Creates a new ReceptorManager with a given receptor pattern and number of receptors.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(Receptor p_receptor) Adds a single receptor to the set.
int	count() Returns the number of receptors in the set.
Receptor[]	getReceptors() Returns an array with references to all receptors in the set, ordered by the order in which they were inserted.
void	remove(Receptor p_receptor) Removes a receptor from the set.
void	repopulate(ReceptorPattern p_pattern, int p_number) Regenerates receptors using a set pattern.
void	save(java.io.FileWriter fout) Saves the Receptor manager to the file provided.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceptorManager

public ReceptorManager(ReceptorPattern p_pattern,
               int p_number)
                throws ValueOutOfBoundsException

Creates a new ReceptorManager with a given receptor pattern and number of receptors. This merely calls repopulate(ReceptorPattern, int).

Parameters:

p_pattern - The pattern to generate new receptors using.

p_number - The number of receptors to generate, should generally be identical to the number of input neurons provided by the net stack

Throws:

ValueOutOfBoundsException - in the event that number is not valid

ReceptorManager

public ReceptorManager()

Creates an empty set of receptors.

ReceptorManager

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

Loads a set of receptors from a file.

Parameters:

p_file - The FileReader to read the data from

Throws:

java.io.IOException - in the event that any error prevents loading the file.

Method Detail

repopulate

public void repopulate(ReceptorPattern p_pattern,
              int p_number)
                throws ValueOutOfBoundsException

Regenerates receptors using a set pattern.

Parameters:

p_pattern - The pattern to generate new receptors using.

p_number - The number of receptors to generate, should generally be identical to the number of input neurons provided by the net stack

Throws:

ValueOutOfBoundsException - in the event that number is not valid

save

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

Saves the Receptor manager to the file provided.

Parameters:

fout - The file to write to.

Throws:

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

add

public void add(Receptor p_receptor)

Adds a single receptor to the set.

Parameters:

p_receptor - The receptor to add.

remove

public void remove(Receptor p_receptor)
            throws ItemNotFoundException

Removes a receptor from the set.

Parameters:

p_receptor - The receptor to attempt removal of

Throws:

ItemNotFoundException - in the event that the given receptor is not present

count

public int count()

Returns the number of receptors in the set.

Returns:

The number of receptors

getReceptors

public Receptor[] getReceptors()

Returns an array with references to all receptors in the set, ordered by the order in which they were inserted.

Returns:

An array of all receptors in the set.