org.simnet.neurons
Class NakaRushtonNeuron

java.lang.Object
  org.simnet.interfaces.Neuron
      org.simnet.neurons.NakaRushtonNeuron

All Implemented Interfaces:

GaugeSource

public class NakaRushtonNeuron
extends Neuron

NakaRushtonNeuron is a firing-rate based neuron which is intended to model spike rates of real neurons. It is used extensively in Hugh Wilson's Spikes, Decisions, and Action.

Field Summary

Fields inherited from class org.simnet.interfaces.Neuron

activation, fanIn, fanOut, lowerBound, upperBound

Constructor Summary

NakaRushtonNeuron()
Default constructor.

NakaRushtonNeuron(Neuron n)
This constructor is used when creating a neuron of one type from another neuron of another type Only values common to different types of neuron are copied.

Method Summary

void	clear() Set activation to 0; override for other "clearing" behavior.
Neuron	duplicate()
double	getAdaptationParameter() Return the adaptation parameter.
double	getAdaptationTimeConstant()
boolean	getAddNoise()
static String	getName()
RandomSource	getNoiseGenerator()
double	getSemiSaturationConstant()
double	getSteepness()
double	getTimeConstant()
int	getTimeType()
String	getToolTipText() Returns string for tool tip or short description.
boolean	getUseAdaptation()
void	init() Initializes values for Naka Rushton neuron type.
void	setAdaptationParameter(double adaptationParameter) Sets the adaptation parameter.
void	setAdaptationTimeConstant(double adaptationTimeConstant) Sets the adaptation time constant.
void	setAddNoise(boolean addNoise)
void	setNoiseGenerator(RandomSource noiseGenerator)
void	setSemiSaturationConstant(double semiSaturationConstant)
void	setSteepness(double steepness)
void	setTimeConstant(double timeConstant)
void	setUseAdaptation(boolean useAdaptation) Sets the boolean use adaptation value.
void	update() See Spikes (Hugh Wilson), pp.

Methods inherited from class org.simnet.interfaces.Neuron

addActivation, addSource, addTarget, checkBounds, clip, connectedToWeight, containsString, debug, decrementActivation, deleteConnectedSynapses, deleteFanIn, deleteFanOut, duplicate, getActivation, getAverageInput, getBuffer, getFanIn, getFanOut, getGaugeValue, getHelp, getId, getIncrement, getInputValue, getLowerBound, getMotorCoupling, getNeuronTypeIndex, getNumberOfActiveInputs, getParentNetwork, getSensoryCoupling, getSummedIncomingWeights, getTotalInput, getType, getTypeList, getUpperBound, getWeightedInputs, getX, getY, incrementActivation, initCastor, isInput, isOutput, randomize, randomizeBuffer, round, setActivation, setBuffer, setFanIn, setFanOut, setId, setIncrement, setInputValue, setLowerBound, setMotorCoupling, setParentNetwork, setSensoryCoupling, setTypeList, setUpperBound, setX, setY, toString, updateConnectedOutward

Methods inherited from class java.lang.Object

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

Constructor Detail

NakaRushtonNeuron

public NakaRushtonNeuron()

Default constructor.

NakaRushtonNeuron

public NakaRushtonNeuron(Neuron n)

This constructor is used when creating a neuron of one type from another neuron of another type Only values common to different types of neuron are copied.

Parameters:

n - Neuron to be created

Method Detail

getTimeType

public int getTimeType()

Specified by:

getTimeType in class Neuron

Returns:

Time type.

init

public void init()

Initializes values for Naka Rushton neuron type.

duplicate

public Neuron duplicate()

Specified by:

duplicate in class Neuron

Returns:

duplicate NakaRushtonNeuron (used, e.g., in copy/paste).

update

public void update()

See Spikes (Hugh Wilson), pp. 20-21

Specified by:

update in class Neuron

getSemiSaturationConstant

public double getSemiSaturationConstant()

Returns:

Returns the semiSaturationConstant.

setSemiSaturationConstant

public void setSemiSaturationConstant(double semiSaturationConstant)

Parameters:

semiSaturationConstant - The semiSaturationConstant to set.

getSteepness

public double getSteepness()

Returns:

Returns the steepness.

setSteepness

public void setSteepness(double steepness)

Parameters:

steepness - The steepness to set.

getTimeConstant

public double getTimeConstant()

Returns:

Returns the timeConstant.

setTimeConstant

public void setTimeConstant(double timeConstant)

Parameters:

timeConstant - The timeConstant to set.

getName

public static String getName()

Returns:

Name of neuron type.

getAddNoise

public boolean getAddNoise()

Returns:

Returns the addNoise.

setAddNoise

public void setAddNoise(boolean addNoise)

Parameters:

addNoise - The addNoise to set.

getNoiseGenerator

public RandomSource getNoiseGenerator()

Returns:

Returns the noiseGenerator.

setNoiseGenerator

public void setNoiseGenerator(RandomSource noiseGenerator)

Parameters:

noiseGenerator - The noiseGenerator to set.

getUseAdaptation

public boolean getUseAdaptation()

Returns:

the boolean value.

setUseAdaptation

public void setUseAdaptation(boolean useAdaptation)

Sets the boolean use adaptation value.

Parameters:

useAdaptation - Value to set use adaptation to

getAdaptationTimeConstant

public double getAdaptationTimeConstant()

Returns:

the adaptation time constant.

setAdaptationTimeConstant

public void setAdaptationTimeConstant(double adaptationTimeConstant)

Sets the adaptation time constant.

Parameters:

adaptationTimeConstant - Value to set adaptation time constant

clear

public void clear()

Description copied from class: Neuron

Set activation to 0; override for other "clearing" behavior.

Overrides:

clear in class Neuron

See Also:

Neuron

getToolTipText

public String getToolTipText()

Description copied from class: Neuron

Returns string for tool tip or short description.

Overrides:

getToolTipText in class Neuron

Returns:

tool tip text

See Also:

Neuron

getAdaptationParameter

public double getAdaptationParameter()

Return the adaptation parameter.

Returns:

the adaptation parameter

setAdaptationParameter

public void setAdaptationParameter(double adaptationParameter)

Sets the adaptation parameter.

Parameters:

adaptationParameter - value to set