org.simbrain.network.neuron_update_rules

Class SpikingThresholdRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.core.SpikingNeuronUpdateRule

org.simbrain.network.neuron_update_rules.SpikingThresholdRule

All Implemented Interfaces:

NoisyUpdateRule

Direct Known Subclasses:

TimedAccumulatorRule

public class SpikingThresholdRule
extends SpikingNeuronUpdateRule
implements NoisyUpdateRule

A simple spiking neuron that fires when weighted inputs exceed a threshold. TODO: Has no documentation.

Nested Class Summary

Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule

NeuronUpdateRule.InputType

Field Summary

Fields inherited from class org.simbrain.network.core.NeuronUpdateRule

DEFAULT_INCREMENT, increment, inputType

Constructor Summary

Constructors

Constructor and Description
SpikingThresholdRule()

Method Summary

Modifier and Type	Method and Description
SpikingThresholdRule	deepCopy() Returns a deep copy of the update rule.
boolean	getAddNoise() Return true if add noise is turned on.
java.lang.String	getDescription() Returns a brief description of this update rule.
Randomizer	getNoiseGenerator() Return the noise generator.
double	getRandomValue() Returns a random value between the upper and lower bounds of this neuron.
double	getThreshold()
void	setAddNoise(boolean noise) Set whether noise should be used.
void	setNoiseGenerator(Randomizer rand) Set the noise generator.
void	setThreshold(double threshold)
void	update(Neuron neuron) Apply the update rule.

Methods inherited from class org.simbrain.network.core.SpikingNeuronUpdateRule

clear, getLastSpikeTime, getTimeType, isSpikingNeuron, setHasSpiked, setLastSpikeTime

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule

contextualDecrement, contextualIncrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getToolTipText, incrementActivation, isSkipsSynapticUpdates, setIncrement, setInputType

Methods inherited from class java.lang.Object

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

Constructor Detail

SpikingThresholdRule

public SpikingThresholdRule()

Method Detail

deepCopy

public SpikingThresholdRule deepCopy()

Description copied from class: NeuronUpdateRule

Returns a deep copy of the update rule.

Specified by:

deepCopy in class NeuronUpdateRule

Returns:

Duplicated update rule

update

public void update(Neuron neuron)

Description copied from class: SpikingNeuronUpdateRule

Apply the update rule.

Specified by:

update in class SpikingNeuronUpdateRule

Parameters:

neuron - parent neuron

getRandomValue

public double getRandomValue()

Returns a random value between the upper and lower bounds of this neuron. Update rules that require special randomization should override this method.

Overrides:

getRandomValue in class NeuronUpdateRule

Returns:

the random value.

getThreshold

public double getThreshold()

Returns:

the threshold

setThreshold

public void setThreshold(double threshold)

Parameters:

threshold - the threshold to set

getDescription

public java.lang.String getDescription()

Description copied from class: NeuronUpdateRule

Returns a brief description of this update rule. Used in combo boxes in the GUI.

Specified by:

getDescription in class NeuronUpdateRule

Returns:

the description.

getNoiseGenerator

public Randomizer getNoiseGenerator()

Description copied from interface: NoisyUpdateRule

Return the noise generator.

Specified by:

getNoiseGenerator in interface NoisyUpdateRule

Returns:

the noise generator.

setNoiseGenerator

public void setNoiseGenerator(Randomizer rand)

Description copied from interface: NoisyUpdateRule

Set the noise generator.

Specified by:

setNoiseGenerator in interface NoisyUpdateRule

Parameters:

rand - the generator to set

getAddNoise

public boolean getAddNoise()

Description copied from interface: NoisyUpdateRule

Return true if add noise is turned on.

Specified by:

getAddNoise in interface NoisyUpdateRule

Returns:

true if add noise is on; false otherwise.

setAddNoise

public void setAddNoise(boolean noise)

Description copied from interface: NoisyUpdateRule

Set whether noise should be used.

Specified by:

setAddNoise in interface NoisyUpdateRule

Parameters:

noise - true if noise should be used; false otherwise.