PointNeuronRule (Simbrain API)

java.lang.Object
- org.simbrain.network.core.NeuronUpdateRule
- - org.simbrain.network.neuron_update_rules.PointNeuronRule

All Implemented Interfaces:

SynapseListener, BiasedUpdateRule
```
public class PointNeuronRule
extends NeuronUpdateRule
implements SynapseListener, BiasedUpdateRule
```
PointNeuron from O'Reilley and Munakata, Computational Explorations in Cognitive Neuroscience, chapter 2. All page references below are are to this book.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PointNeuronRule.OutputFunction
Output functions.
- Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule
  NeuronUpdateRule.InputType

Nested Classes
Modifier and Type	Class and Description
`static class`	`PointNeuronRule.OutputFunction` Output functions.

Field Summary
- Fields inherited from class org.simbrain.network.core.NeuronUpdateRule
  DEFAULT_INCREMENT, increment, inputType

Constructor Summary

Constructors
Constructor and Description

PointNeuronRule()

Constructors
Constructor and Description
`PointNeuronRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear(Neuron neuron)` Set activation to 0; override for other "clearing" behavior (e.g.
`PointNeuronRule`	`deepCopy()` Returns a deep copy of the update rule.
`double`	`getBias()`
`java.lang.String`	`getDescription()` Returns a brief description of this update rule.
`int`	`getDuration()`
`double`	`getExcitatoryConductance()`
`double`	`getExcitatoryCurrent()`
`double`	`getExcitatoryMaxConductance()`
`double`	`getExcitatoryReversal()`
`double`	`getGain()`
`double`	`getInhibitoryConductance()`
`double`	`getInhibitoryMaxConductance()`
`double`	`getInhibitoryReversal()`
`double`	`getInhibitoryThresholdConductance()` Returns the inhibitory conductance that would set this point neuron's voltage at its threshold potential.
`double`	`getLeakConductance()`
`double`	`getLeakMaxConductance()`
`double`	`getLeakReversal()`
`double`	`getMembranePotential()`
`double`	`getNetTimeConstant()`
`PointNeuronRule.OutputFunction`	`getOutputFunction()`
`double`	`getPotentialTimeConstant()`
`double`	`getRandomValue()` Returns a random value between the upper and lower bounds of this neuron.
`double`	`getRefractoryPotential()`
`double`	`getThresholdPotential()`
`Network.TimeType`	`getTimeType()` Returns the type of time update (discrete or continuous) associated with this neuron.
`java.lang.String`	`getToolTipText(Neuron neuron)` Returns string for tool tip or short description.
`void`	`init(Neuron neuron)`
`void`	`setBias(double bias)`
`void`	`setDuration(int duration)`
`void`	`setExcitatoryConductance(double excitatoryConductance)`
`void`	`setExcitatoryCurrent(double excitatoryCurrent)`
`void`	`setExcitatoryInputs(java.util.ArrayList<Synapse> excitatoryInputs)`
`void`	`setExcitatoryMaxConductance(double excitatoryMaxConductance)`
`void`	`setExcitatoryReversal(double excitatoryReversal)`
`void`	`setGain(double gain)`
`void`	`setInhibitoryConductance(double inhibitoryConductance)`
`void`	`setInhibitoryMaxConductance(double inhibitoryMaxConductance)`
`void`	`setInhibitoryReversal(double inhibitoryReversal)`
`void`	`setLeakConductance(double leakConductance)`
`void`	`setLeakMaxConductance(double leakMaxConductance)`
`void`	`setLeakReversal(double leakReversal)`
`void`	`setMembranePotential(double membranePotential)`
`void`	`setNetTimeConstant(double netTimeConstant)`
`void`	`setOutputFunction(PointNeuronRule.OutputFunction currentOutputFunction)`
`void`	`setPotentialTimeConstant(double potentialTimeConstant)`
`void`	`setRefractoryPotential(double refractoryPotential)`
`void`	`setThresholdPotential(double threshold)`
`void`	`synapseAdded(NetworkEvent<Synapse> networkEvent)` Notify this listener of a synapse added event.
`void`	`synapseChanged(NetworkEvent<Synapse> networkEvent)` Notify this listener that synapse's state changed.
`void`	`synapseRemoved(NetworkEvent<Synapse> networkEvent)` Notify this listener of a synapse removed event.
`void`	`synapseTypeChanged(NetworkEvent<SynapseUpdateRule> networkEvent)` Invoked when a synapse's update rule changes.
`void`	`update(Neuron neuron)` Apply the update rule.

Methods inherited from class org.simbrain.network.core.NeuronUpdateRule
contextualDecrement, contextualIncrement, decrementActivation, getDefaultIncrement, getGraphicalLowerBound, getGraphicalUpperBound, getIncrement, getInputType, incrementActivation, isSkipsSynapticUpdates, isSpikingNeuron, setIncrement, setInputType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PointNeuronRule
```
public PointNeuronRule()
```
- Method Detail
  - init
```
public void init(Neuron neuron)
```
    Parameters:
    
    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
  - deepCopy
```
public PointNeuronRule deepCopy()
```
    Returns a deep copy of the update rule.
    
    Specified by:
    
    deepCopy in class NeuronUpdateRule
    
    Returns:
    
    Duplicated update rule
  - 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
  - update
```
public void update(Neuron neuron)
```
    Apply the update rule.
    
    Specified by:
    
    update in class NeuronUpdateRule
    
    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.
  - getInhibitoryThresholdConductance
```
public double getInhibitoryThresholdConductance()
```
    Returns the inhibitory conductance that would set this point neuron's voltage at its threshold potential. See M/R p. 101, equation 3.2
    
    Returns:
    
    the value of that equation
  - getToolTipText
```
public java.lang.String getToolTipText(Neuron neuron)
```
    Description copied from class: NeuronUpdateRule
    
    Returns string for tool tip or short description. Override to provide custom information.
    
    Overrides:
    
    getToolTipText in class NeuronUpdateRule
    
    Parameters:
    
    neuron - reference to parent neuron
    
    Returns:
    
    tool tip text
  - getNetTimeConstant
```
public double getNetTimeConstant()
```
    Returns:
    
    the netTimeConstant
  - setNetTimeConstant
```
public void setNetTimeConstant(double netTimeConstant)
```
    Parameters:
    
    netTimeConstant - the netTimeConstant to set
  - getExcitatoryMaxConductance
```
public double getExcitatoryMaxConductance()
```
    Returns:
    
    the excitatoryMaxConductance
  - setExcitatoryMaxConductance
```
public void setExcitatoryMaxConductance(double excitatoryMaxConductance)
```
    Parameters:
    
    excitatoryMaxConductance - the excitatoryMaxConductance to set
  - getExcitatoryConductance
```
public double getExcitatoryConductance()
```
    Returns:
    
    the excitatoryConductance
  - setExcitatoryConductance
```
public void setExcitatoryConductance(double excitatoryConductance)
```
    Parameters:
    
    excitatoryConductance - the excitatoryConductance to set
  - getMembranePotential
```
public double getMembranePotential()
```
    Returns:
    
    the membranePotential
  - setMembranePotential
```
public void setMembranePotential(double membranePotential)
```
    Parameters:
    
    membranePotential - the membranePotential to set
  - getExcitatoryReversal
```
public double getExcitatoryReversal()
```
    Returns:
    
    the excitatoryReversal
  - setExcitatoryReversal
```
public void setExcitatoryReversal(double excitatoryReversal)
```
    Parameters:
    
    excitatoryReversal - the excitatoryReversal to set
  - getLeakReversal
```
public double getLeakReversal()
```
    Returns:
    
    the leakReversal
  - setLeakReversal
```
public void setLeakReversal(double leakReversal)
```
    Parameters:
    
    leakReversal - the leakReversal to set
  - getLeakMaxConductance
```
public double getLeakMaxConductance()
```
    Returns:
    
    the leakMaxConductance
  - setLeakMaxConductance
```
public void setLeakMaxConductance(double leakMaxConductance)
```
    Parameters:
    
    leakMaxConductance - the leakMaxConductance to set
  - getLeakConductance
```
public double getLeakConductance()
```
    Returns:
    
    the leakConductance
  - setLeakConductance
```
public void setLeakConductance(double leakConductance)
```
    Parameters:
    
    leakConductance - the leakConductance to set
  - getPotentialTimeConstant
```
public double getPotentialTimeConstant()
```
    Returns:
    
    the potentialTimeConstant
  - setPotentialTimeConstant
```
public void setPotentialTimeConstant(double potentialTimeConstant)
```
    Parameters:
    
    potentialTimeConstant - the potentialTimeConstant to set
  - getOutputFunction
```
public PointNeuronRule.OutputFunction getOutputFunction()
```
    Returns:
    
    the currentOutputFunction
  - setOutputFunction
```
public void setOutputFunction(PointNeuronRule.OutputFunction currentOutputFunction)
```
    Parameters:
    
    currentOutputFunction - the currentOutputFunction to set
  - getGain
```
public double getGain()
```
    Returns:
    
    the gain
  - setGain
```
public void setGain(double gain)
```
    Parameters:
    
    gain - the gain to set
  - getThresholdPotential
```
public double getThresholdPotential()
```
    Returns:
    
    the threshold
  - setThresholdPotential
```
public void setThresholdPotential(double threshold)
```
    Parameters:
    
    threshold - the threshold to set
  - getRefractoryPotential
```
public double getRefractoryPotential()
```
    Returns:
    
    the refractoryPotential
  - setRefractoryPotential
```
public void setRefractoryPotential(double refractoryPotential)
```
    Parameters:
    
    refractoryPotential - the refractoryPotential to set
  - setExcitatoryInputs
```
public void setExcitatoryInputs(java.util.ArrayList<Synapse> excitatoryInputs)
```
    Parameters:
    
    excitatoryInputs - the excitatoryInputs to set
  - getInhibitoryReversal
```
public double getInhibitoryReversal()
```
    Returns:
    
    the inhibitoryReversal
  - setInhibitoryReversal
```
public void setInhibitoryReversal(double inhibitoryReversal)
```
    Parameters:
    
    inhibitoryReversal - the inhibitoryReversal to set
  - getExcitatoryCurrent
```
public double getExcitatoryCurrent()
```
    Returns:
    
    the excitatoryCurrent
  - setExcitatoryCurrent
```
public void setExcitatoryCurrent(double excitatoryCurrent)
```
    Parameters:
    
    excitatoryCurrent - the excitatoryCurrent to set
  - getDuration
```
public int getDuration()
```
    Returns:
    
    the duration
  - setDuration
```
public void setDuration(int duration)
```
    Parameters:
    
    duration - the duration to set
  - getInhibitoryConductance
```
public double getInhibitoryConductance()
```
    Returns:
    
    the inhibitoryConductance
  - setInhibitoryConductance
```
public void setInhibitoryConductance(double inhibitoryConductance)
```
    Parameters:
    
    inhibitoryConductance - the inhibitoryConductance to set
  - getInhibitoryMaxConductance
```
public double getInhibitoryMaxConductance()
```
    Returns:
    
    the inhibitoryMaxConductance
  - setInhibitoryMaxConductance
```
public void setInhibitoryMaxConductance(double inhibitoryMaxConductance)
```
    Parameters:
    
    inhibitoryMaxConductance - the inhibitoryMaxConductance to set
  - getBias
```
public double getBias()
```
    Specified by:
    
    getBias in interface BiasedUpdateRule
    
    Returns:
    
    the bias
  - setBias
```
public void setBias(double bias)
```
    Specified by:
    
    setBias in interface BiasedUpdateRule
    
    Parameters:
    
    bias - the bias to set
  - synapseAdded
```
public void synapseAdded(NetworkEvent<Synapse> networkEvent)
```
    Notify this listener of a synapse added event.
    
    Specified by:
    
    synapseAdded in interface SynapseListener
    
    Parameters:
    
    networkEvent - reference to new synapse
  - synapseChanged
```
public void synapseChanged(NetworkEvent<Synapse> networkEvent)
```
    Notify this listener that synapse's state changed.
    
    Specified by:
    
    synapseChanged in interface SynapseListener
    
    Parameters:
    
    networkEvent - reference to synapse whose state changed
  - synapseRemoved
```
public void synapseRemoved(NetworkEvent<Synapse> networkEvent)
```
    Notify this listener of a synapse removed event.
    
    Specified by:
    
    synapseRemoved in interface SynapseListener
    
    Parameters:
    
    networkEvent - event
  - synapseTypeChanged
```
public void synapseTypeChanged(NetworkEvent<SynapseUpdateRule> networkEvent)
```
    Invoked when a synapse's update rule changes.
    
    Specified by:
    
    synapseTypeChanged in interface SynapseListener
    
    Parameters:
    
    networkEvent - reference to to old and new synapse update rule
  - 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.

Class PointNeuronRule

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

PointNeuronRule

Method Detail

init

getTimeType

deepCopy

clear

update

getRandomValue

getInhibitoryThresholdConductance

getToolTipText

getNetTimeConstant

setNetTimeConstant

getExcitatoryMaxConductance

setExcitatoryMaxConductance

getExcitatoryConductance

setExcitatoryConductance

getMembranePotential

setMembranePotential

getExcitatoryReversal

setExcitatoryReversal

getLeakReversal

setLeakReversal

getLeakMaxConductance

setLeakMaxConductance

getLeakConductance

setLeakConductance

getPotentialTimeConstant

setPotentialTimeConstant

getOutputFunction

setOutputFunction

getGain

setGain

getThresholdPotential

setThresholdPotential

getRefractoryPotential

setRefractoryPotential

setExcitatoryInputs

getInhibitoryReversal

setInhibitoryReversal

getExcitatoryCurrent

setExcitatoryCurrent

getDuration

setDuration

getInhibitoryConductance

setInhibitoryConductance

getInhibitoryMaxConductance

setInhibitoryMaxConductance

getBias

setBias

synapseAdded

synapseChanged

synapseRemoved

synapseTypeChanged

getDescription