org.simbrain.network.core

Class SpikingNeuronUpdateRule

java.lang.Object

org.simbrain.network.core.NeuronUpdateRule

org.simbrain.network.core.SpikingNeuronUpdateRule

Direct Known Subclasses:

AdExIFRule, FitzhughNagumo, HodgkinHuxleyRule, IntegrateAndFireRule, IzhikevichRule, MorrisLecarRule, SpikingThresholdRule, StochasticRule

public abstract class SpikingNeuronUpdateRule
extends NeuronUpdateRule

SpikingNeuron is the superclass for spiking neuron types (e.g. integrate and fire) with functions common to spiking neurons. For example a boolean hasSpiked field is used in the gui to indicate that this neuron has spiked.

Author:

Jeff Yoshimi, Zach Tosi

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
SpikingNeuronUpdateRule()

Method Summary

Modifier and Type	Method and Description
void	clear(Neuron neuron) Set activation to 0; override for other "clearing" behavior (e.g.
double	getLastSpikeTime()
Network.TimeType	getTimeType() Returns the type of time update (discrete or continuous) associated with this neuron.
boolean	isSpikingNeuron() A helper method which identifies this and all subclasses as variations of spiking neurons.
void	setHasSpiked(boolean hasSpiked, Neuron neuron)
void	setLastSpikeTime(double lastSpikeTime)
abstract void	update(Neuron neuron) Apply the update rule.

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

contextualDecrement, contextualIncrement, decrementActivation, deepCopy, getDefaultIncrement, getDescription, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, getRandomValue, 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

SpikingNeuronUpdateRule

public SpikingNeuronUpdateRule()

Method Detail

clear

public void clear(Neuron neuron)

Description copied from class: NeuronUpdateRule

Set activation to 0; override for other "clearing" behavior (e.g. setting other variables to 0. Called in Gui when "clear" button pressed.

Overrides:

clear in class NeuronUpdateRule

Parameters:

neuron - reference to parent neuron

getTimeType

public Network.TimeType getTimeType()

Returns the type of time update (discrete or continuous) associated with this neuron.

Specified by:

getTimeType in class NeuronUpdateRule

Returns:

the time type

update

public abstract void update(Neuron neuron)

Apply the update rule.

Specified by:

update in class NeuronUpdateRule

Parameters:

neuron - parent neuron

setHasSpiked

public void setHasSpiked(boolean hasSpiked,
                         Neuron neuron)

Parameters:

hasSpiked - the hasSpiked to set

neuron - the neuron which has (or has not) spiked.

getLastSpikeTime

public double getLastSpikeTime()

Returns:

the lastSpikeTime

setLastSpikeTime

public void setLastSpikeTime(double lastSpikeTime)

Parameters:

lastSpikeTime - the lastSpikeTime to set

isSpikingNeuron

public final boolean isSpikingNeuron()

A helper method which identifies this and all subclasses as variations of spiking neurons. While instanceof is often bad practice this is a faster way of determining if a neuron is spiking without using instanceof. While normally this would still be bad practice, this is often used by GUI components which are separate from the logical code.

Overrides:

isSpikingNeuron in class NeuronUpdateRule

Returns:

TRUE: Any subclass of SpikingNeuronUpdate rule, must by definition be a spiking neuron.