AdExIFRule (Simbrain API)

java.lang.Object
- org.simbrain.network.core.NeuronUpdateRule
- - org.simbrain.network.core.SpikingNeuronUpdateRule
  - - org.simbrain.network.neuron_update_rules.AdExIFRule

All Implemented Interfaces:

NoisyUpdateRule
```
public class AdExIFRule
extends SpikingNeuronUpdateRule
implements NoisyUpdateRule
```
An implementation of adaptive exponential integrate and fire. This version of integrate and fire includes an exponential term as a part of the differential equation as well as an adaptation term which lowers the membrane potential in response to successive spikes. See Toboul & Brette 2005.

Author:

Zach Tosi

Nested Class Summary
- Nested classes/interfaces inherited from class org.simbrain.network.core.NeuronUpdateRule
  NeuronUpdateRule.InputType

Field Summary

Fields
Modifier and Type Field and Description

static double CURRENT_CONVERTER
A converter from pA to nA, since most other sims in Simbrain use nano Amps.
- Fields inherited from class org.simbrain.network.core.NeuronUpdateRule
  DEFAULT_INCREMENT, increment, inputType

Fields
Modifier and Type	Field and Description
`static double`	`CURRENT_CONVERTER` A converter from pA to nA, since most other sims in Simbrain use nano Amps.

Constructor Summary

Constructors
Constructor and Description

AdExIFRule()

Constructors
Constructor and Description
`AdExIFRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdExIFRule`	`deepCopy()` Returns a deep copy of the update rule.
`double`	`getA()`
`boolean`	`getAddNoise()` Return true if add noise is turned on.
`double`	`getB()`
`java.lang.String`	`getDescription()` Returns a brief description of this update rule.
`double`	`getExReversal()`
`double`	`getG_e_bar()`
`double`	`getG_i_bar()`
`double`	`getG_L()`
`double`	`getGraphicalLowerBound()` Returns a value for lower bound to be used in computing the saturation of neuron nodes.
`double`	`getGraphicalUpperBound()` Returns a value for upper bound to be used in computing the saturation of neuron nodes.
`double`	`getI_bg()`
`double`	`getInReversal()`
`double`	`getLeakReversal()`
`double`	`getMemCapacitance()`
`Randomizer`	`getNoiseGenerator()` Return the noise generator.
`double`	`getRefractoryPeriod()`
`double`	`getSlopeFactor()`
`double`	`getTauW()`
`double`	`getV_mem()`
`double`	`getV_Peak()`
`double`	`getV_Reset()`
`double`	`getV_Th()`
`double`	`getW()`
`void`	`setA(double a)`
`void`	`setAddNoise(boolean noise)` Set whether noise should be used.
`void`	`setB(double b)`
`void`	`setExReversal(double exReversal)`
`void`	`setG_e_bar(double g_e_bar)`
`void`	`setG_i_bar(double g_i_bar)`
`void`	`setG_L(double g_L)`
`void`	`setI_bg(double i_bg)`
`void`	`setInReversal(double inReversal)`
`void`	`setLeakReversal(double leakReversal)`
`void`	`setMemCapacitance(double memCapacitance)`
`void`	`setNoiseGenerator(Randomizer rand)` Set the noise generator.
`void`	`setRefractoryPeriod(double refractoryPeriod)`
`void`	`setSlopeFactor(double slopeFactor)`
`void`	`setTauW(double tauW)`
`void`	`setV_mem(double v_mem)`
`void`	`setV_Peak(double v_Peak)`
`void`	`setV_Reset(double v_Reset)`
`void`	`setV_Th(double v_Th)`
`void`	`setW(double w)`
`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, 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

- Field Detail
  - CURRENT_CONVERTER
```
public static final double CURRENT_CONVERTER
```
    A converter from pA to nA, since most other sims in Simbrain use nano Amps.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AdExIFRule
```
public AdExIFRule()
```
- Method Detail
  - 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
  - deepCopy
```
public AdExIFRule deepCopy()
```
    Description copied from class: NeuronUpdateRule
    
    Returns a deep copy of the update rule.
    
    Specified by:
    
    deepCopy in class NeuronUpdateRule
    
    Returns:
    
    Duplicated 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.
  - getNoiseGenerator
```
public Randomizer getNoiseGenerator()
```
    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.
  - getGraphicalLowerBound
```
public double getGraphicalLowerBound()
```
    Description copied from class: NeuronUpdateRule
    
    Returns a value for lower bound to be used in computing the saturation of neuron nodes. Override this to produce nicer graphics, and fine tune based on display of neurons in common use cases for a given neuron type.
    
    Overrides:
    
    getGraphicalLowerBound in class NeuronUpdateRule
    
    Returns:
    
    the graphical lower bound
  - getGraphicalUpperBound
```
public double getGraphicalUpperBound()
```
    Description copied from class: NeuronUpdateRule
    
    Returns a value for upper bound to be used in computing the saturation of neuron nodes. Override this to produce nicer graphics, and fine tune based on display of neurons in common use cases for a given neuron type.
    
    Overrides:
    
    getGraphicalUpperBound in class NeuronUpdateRule
    
    Returns:
    
    the graphical upper bound
  - getV_Reset
```
public double getV_Reset()
```
  - setV_Reset
```
public void setV_Reset(double v_Reset)
```
  - getV_Th
```
public double getV_Th()
```
  - setV_Th
```
public void setV_Th(double v_Th)
```
  - getG_L
```
public double getG_L()
```
  - setG_L
```
public void setG_L(double g_L)
```
  - getLeakReversal
```
public double getLeakReversal()
```
  - setLeakReversal
```
public void setLeakReversal(double leakReversal)
```
  - getV_mem
```
public double getV_mem()
```
  - setV_mem
```
public void setV_mem(double v_mem)
```
  - getW
```
public double getW()
```
  - setW
```
public void setW(double w)
```
  - getB
```
public double getB()
```
  - setB
```
public void setB(double b)
```
  - getTauW
```
public double getTauW()
```
  - setTauW
```
public void setTauW(double tauW)
```
  - getSlopeFactor
```
public double getSlopeFactor()
```
  - setSlopeFactor
```
public void setSlopeFactor(double slopeFactor)
```
  - getA
```
public double getA()
```
  - setA
```
public void setA(double a)
```
  - getMemCapacitance
```
public double getMemCapacitance()
```
  - setMemCapacitance
```
public void setMemCapacitance(double memCapacitance)
```
  - getI_bg
```
public double getI_bg()
```
  - setI_bg
```
public void setI_bg(double i_bg)
```
  - getV_Peak
```
public double getV_Peak()
```
  - setV_Peak
```
public void setV_Peak(double v_Peak)
```
  - getG_e_bar
```
public double getG_e_bar()
```
  - setG_e_bar
```
public void setG_e_bar(double g_e_bar)
```
  - getG_i_bar
```
public double getG_i_bar()
```
  - setG_i_bar
```
public void setG_i_bar(double g_i_bar)
```
  - getExReversal
```
public double getExReversal()
```
  - setExReversal
```
public void setExReversal(double exReversal)
```
  - getInReversal
```
public double getInReversal()
```
  - setInReversal
```
public void setInReversal(double inReversal)
```
  - getRefractoryPeriod
```
public double getRefractoryPeriod()
```
  - setRefractoryPeriod
```
public void setRefractoryPeriod(double refractoryPeriod)
```

Class AdExIFRule

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.SpikingNeuronUpdateRule

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

Methods inherited from class java.lang.Object

Field Detail

CURRENT_CONVERTER

Constructor Detail

AdExIFRule

Method Detail

update

deepCopy

getDescription

getNoiseGenerator

setNoiseGenerator

getAddNoise

setAddNoise

getGraphicalLowerBound

getGraphicalUpperBound

getV_Reset

setV_Reset

getV_Th

setV_Th

getG_L

setG_L

getLeakReversal

setLeakReversal

getV_mem

setV_mem

getW

setW

getB

setB

getTauW

setTauW

getSlopeFactor

setSlopeFactor

getA

setA

getMemCapacitance

setMemCapacitance

getI_bg

setI_bg

getV_Peak

setV_Peak

getG_e_bar

setG_e_bar

getG_i_bar

setG_i_bar

getExReversal

setExReversal

getInReversal

setInReversal

getRefractoryPeriod

setRefractoryPeriod