VSICLIFNeuronV2 (ERNST API)

java.lang.Object
- cnslab.cnsnetwork.VSICLIFNeuronV2

All Implemented Interfaces:

Neuron
```
public final class VSICLIFNeuronV2
extends Object
implements Neuron
```
MN model with STDP implemented. See Mihalas and Niebur 2009 paper.

Version:

$Date: 2012-08-04 13:43:22 -0500 (Sat, 04 Aug 2012) $ $Rev: 104 $ $Author: croft $

Author:

Yi Dong, David Wallace Croft, Jeremy Cohen

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class VSICLIFNeuronV2.State

Nested Classes
Modifier and Type	Class and Description
`class`	`VSICLIFNeuronV2.State`

Field Summary

Fields
Modifier and Type	Field and Description
`double`	`clamp_t` clamp the threshold during absolute refractory period
`double`	`clamp_v` clamp the membrane voltage during absolute refractory period
`static double`	`cost` total cost, the costs associated to putting an temporary spike time in
`static double`	`cost_Schedule` the cost associated with queue schedule. see D'hane's paper
`static double`	`cost_Update` the cost associated with neuron update,see D'hane's paper
`boolean`	`fire` judge whether the neuron fires or not
`double`	`lastFireTime` last time the neuron fired, negative means no last spike
`double`	`lastInputTime` last time the neuron received a spike
`static double`	`maxWeight` initialization of the maxWeight which was used in a previous method in doesfire
`static double`	`MINRISETIME` Deprecated.
`VSICLIFNeuronParaV2`	`para` Neuron parameters
`static double`	`rEPS` the criteria for removing synapses, if a synaptic channel does not get an input for a long time such that its current decays below rEPS, it is removed from computations of the voltage and future updates up until it gets an input
`VSICLIFNeuronV2.State[]`	`sta_p` pointer to the state variables; the first two states correspond to the g and b terms respectively, followed by the spike-induced current terms
`TreeSet<VSICLIFNeuronV2.State>`	`state` linked list for state variables
`double`	`tAvg` average time interval a neuron received spikes
`static double`	`tEPS` time accuracy
`long`	`tHost` long imposes a constraint on the maximum number of hosts to be 64

Constructor Summary

Constructors
Constructor and Description

VSICLIFNeuronV2(VSICLIFNeuronParaV2 para)

Constructors
Constructor and Description
`VSICLIFNeuronV2(VSICLIFNeuronParaV2 para)`

Method Summary

Methods
Modifier and Type	Method and Description
`double[]`	`getCurr()` get the current which is the last updated current
`double[]`	`getCurr(double currTime)`
`double`	`getCurr(int a, double[] curr)` Nj terms:
`double`	`getMemV(double currTime)`
`double`	`getNB(double instantaneousThreshold, double memV, double[] curr)` return nb term;
`double`	`getNG(double memV, double[] curr)` Get ng term ( membrane voltage - ABGLCAP*membranevoltageNg )
`boolean`	`getRecord()` record the neuron
`double`	`getSensoryWeight()`
`long`	`getTHost()`
`double`	`getTimeOfLastUpdate()`
`double`	`getTimeOfNextFire()` get the value of timeOfNextFire
`void`	`init(int expid, int trialid, Seed idum, Network net, int id)` initialize the neuron
`boolean`	`isSensory()` sensory report
`double`	`memStheta(double t)` Membrane voltage computate mem = S+\theta
`double`	`memVoltage(double t)` get the membrane voltage
`boolean`	`realFire()`
`double`	`safeD(double t)` Safe derivative, good for Newton method, see D'hane paper
`void`	`setMemV(double memV)` set the membrane voltage
`void`	`setRecord(boolean record)` set the neuron record or not.
`void`	`setTHost(long id)` set the target host id, 0 means none, 1 means yes
`void`	`setTimeOfLastUpdate(double timeOfLastUpdate)`
`void`	`setTimeOfNextFire(double timeOfNextFire)` set a new value to timeOfNextFire
`String`	`toString()`
`double`	`updateFire()` update of the neuron after firing the current time is TimeOfNextFire
`double`	`updateInput(double time, Synapse input)` update of the neuron after receiving a spike the current time is time

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

- Field Detail
  - MINRISETIME
```
@Deprecated
public static double MINRISETIME
```
    Deprecated.
    
    minimum rising time for neuron to fire
  - tEPS
```
public static double tEPS
```
    time accuracy
  - rEPS
```
public static double rEPS
```
    the criteria for removing synapses, if a synaptic channel does not get an input for a long time such that its current decays below rEPS, it is removed from computations of the voltage and future updates up until it gets an input
  - maxWeight
```
public static double maxWeight
```
    initialization of the maxWeight which was used in a previous method in doesfire
  - cost_Update
```
public static double cost_Update
```
    the cost associated with neuron update,see D'hane's paper
  - cost_Schedule
```
public static double cost_Schedule
```
    the cost associated with queue schedule. see D'hane's paper
  - cost
```
public static double cost
```
    total cost, the costs associated to putting an temporary spike time in
  - tAvg
```
public double tAvg
```
    average time interval a neuron received spikes
  - lastInputTime
```
public double lastInputTime
```
    last time the neuron received a spike
  - lastFireTime
```
public double lastFireTime
```
    last time the neuron fired, negative means no last spike
  - clamp_v
```
public double clamp_v
```
    clamp the membrane voltage during absolute refractory period
  - clamp_t
```
public double clamp_t
```
    clamp the threshold during absolute refractory period
  - fire
```
public boolean fire
```
    judge whether the neuron fires or not
  - tHost
```
public long tHost
```
    long imposes a constraint on the maximum number of hosts to be 64
  - para
```
public VSICLIFNeuronParaV2 para
```
    Neuron parameters
  - state
```
public TreeSet<VSICLIFNeuronV2.State> state
```
    linked list for state variables
  - sta_p
```
public VSICLIFNeuronV2.State[] sta_p
```
    pointer to the state variables; the first two states correspond to the g and b terms respectively, followed by the spike-induced current terms
- Constructor Detail
  - VSICLIFNeuronV2
```
public VSICLIFNeuronV2(VSICLIFNeuronParaV2 para)
```
- Method Detail
  - getCurr
```
public double[] getCurr(double currTime)
```
    Specified by:
    
    getCurr in interface Neuron
    
    Returns:
    neuron's current currents of all the channels
  - getMemV
```
public double getMemV(double currTime)
```
    Specified by:
    
    getMemV in interface Neuron
    
    Returns:
    neuron's current membrane voltage
  - getRecord
```
public boolean getRecord()
```
    Description copied from interface: Neuron
    
    record the neuron
    
    Specified by:
    
    getRecord in interface Neuron
    
    Returns:
    boolean whether it should be recorded
  - getTHost
```
public long getTHost()
```
    Specified by:
    
    getTHost in interface Neuron
    
    Returns:
    the target host, maximum NetHost 64
  - getTimeOfNextFire
```
public double getTimeOfNextFire()
```
    Description copied from interface: Neuron
    
    get the value of timeOfNextFire
    
    Specified by:
    
    getTimeOfNextFire in interface Neuron
    
    Returns:
    the value of timeOfNextFire
  - isSensory
```
public boolean isSensory()
```
    Description copied from interface: Neuron
    
    sensory report
    
    Specified by:
    
    isSensory in interface Neuron
    
    Returns:
    true if the neuron is a sensory neuron
  - realFire
```
public boolean realFire()
```
    Specified by:
    
    realFire in interface Neuron
    
    Returns:
    whether the scheduled neuron fire means the neuron really fires
  - setRecord
```
public void setRecord(boolean record)
```
    Description copied from interface: Neuron
    
    set the neuron record or not.
    
    Specified by:
    
    setRecord in interface Neuron
  - setTHost
```
public void setTHost(long id)
```
    Description copied from interface: Neuron
    
    set the target host id, 0 means none, 1 means yes
    
    Specified by:
    
    setTHost in interface Neuron
  - setTimeOfNextFire
```
public void setTimeOfNextFire(double timeOfNextFire)
```
    Description copied from interface: Neuron
    
    set a new value to timeOfNextFire
    
    Specified by:
    
    setTimeOfNextFire in interface Neuron
    
    Parameters:
    timeOfNextFire - the new value to be used
  - init
```
public void init(int expid,
        int trialid,
        Seed idum,
        Network net,
        int id)
```
    Description copied from interface: Neuron
    
    initialize the neuron
    
    Specified by:
    
    init in interface Neuron
  - updateFire
```
public double updateFire()
```
    Description copied from interface: Neuron
    
    update of the neuron after firing the current time is TimeOfNextFire
    
    Specified by:
    
    updateFire in interface Neuron
    
    Returns:
    the time interval until the next fire event, or negative if no spike is generated
  - updateInput
```
public double updateInput(double time,
                 Synapse input)
```
    Description copied from interface: Neuron
    
    update of the neuron after receiving a spike the current time is time
    
    Specified by:
    
    updateInput in interface Neuron
    
    input - it is a InputEvent event in the input queue
    
    Returns:
    the time interval until next fire event, or negative if no spike is generated
  - getCurr
```
public double[] getCurr()
```
    get the current which is the last updated current
  - getCurr
```
public double getCurr(int a,
             double[] curr)
```
    Nj terms:
  - getNB
```
public double getNB(double instantaneousThreshold,
           double memV,
           double[] curr)
```
    return nb term;
  - getNG
```
public double getNG(double memV,
           double[] curr)
```
    Get ng term ( membrane voltage - ABGLCAP*membranevoltageNg )
  - getSensoryWeight
```
public double getSensoryWeight()
```
  - getTimeOfLastUpdate
```
public double getTimeOfLastUpdate()
```
  - memVoltage
```
public double memVoltage(double t)
```
    get the membrane voltage
    
    Parameters:
    t - absolute time t
  - setMemV
```
public void setMemV(double memV)
```
    set the membrane voltage
  - setTimeOfLastUpdate
```
public void setTimeOfLastUpdate(double timeOfLastUpdate)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - memStheta
```
public double memStheta(double t)
```
    Membrane voltage computate mem = S+\theta
    
    Parameters:
    t - absolute time t
  - safeD
```
public double safeD(double t)
```
    Safe derivative, good for Newton method, see D'hane paper
    
    Parameters:
    t - absolute time t

Class VSICLIFNeuronV2

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MINRISETIME

tEPS

rEPS

maxWeight

cost_Update

cost_Schedule

cost

tAvg

lastInputTime

lastFireTime

clamp_v

clamp_t

fire

tHost

para

state

sta_p

Constructor Detail

VSICLIFNeuronV2

Method Detail

getCurr

getMemV

getRecord

getTHost

getTimeOfNextFire

isSensory

realFire

setRecord

setTHost

setTimeOfNextFire

init

updateFire

updateInput

getCurr

getCurr

getNB

getNG

getSensoryWeight

getTimeOfLastUpdate

memVoltage

setMemV

setTimeOfLastUpdate

toString

memStheta

safeD