SIFNeuron (ERNST API)

java.lang.Object
- cnslab.cnsnetwork.SIFNeuron

All Implemented Interfaces:

Neuron, Serializable
```
public class SIFNeuron
extends Object
implements Neuron, Serializable
```
Implemented simple integrate and fire neuron. Only two channels are allowed, one excitatory and one inhibitory, and the decay of inhibitory channel should be longer than the excitatory one. Look up table is used for quick spike test.

Version:

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

Author:

Yi Dong, David Wallace Croft

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static double[]`	`currMax` For table max boundary
`static double[]`	`currMin` For table min boundary
`static double`	`currStep` For table step size
`static double`	`maxWeight`
`static double`	`memMax` For table max boundary
`static double`	`memMin` For table min boundary
`static double`	`memStep` For table step size
`static int`	`TABLESIZE_c` For table size
`static int`	`TABLESIZE_o` For table size
`long`	`tHost` long imposes a constraint on the maximum number of hosts to be 64

Constructor Summary

Constructors
Constructor and Description

SIFNeuron(SIFNeuronPara para)

Constructors
Constructor and Description
`SIFNeuron(SIFNeuronPara para)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`doesFire()`
`double[]`	`getCurr(double currTime)`
`double`	`getMemV(double currTime)`
`boolean`	`getRecord()` record the neuron
`double`	`getSensoryWeight()` It looks this was originally a method in the Neuron interface which has since been removed.
`long`	`getTHost()`
`double`	`getTimeOfLastUpdate()` get the value of timeOfLastUpdate
`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
`boolean`	`realFire()`
`void`	`setMemV(double memV)` set a new value to memV
`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)` set a new value to timeOfLastUpdate
`void`	`setTimeOfNextFire(double timeOfNextFire)` set a new value to timeOfNextFire
`double`	`timeOfFire(double currTime)`
`String`	`toString()`
`double`	`updateFire()` update of the neuron after firing the current time is TimeOfNextFire
`double`	`updateInput(double time, Synapse inputSynapse)` 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
  - maxWeight
```
public static double maxWeight
```
  - TABLESIZE_o
```
public static int TABLESIZE_o
```
    For table size
  - TABLESIZE_c
```
public static int TABLESIZE_c
```
    For table size
  - memMin
```
public static double memMin
```
    For table min boundary
  - memMax
```
public static double memMax
```
    For table max boundary
  - currMin
```
public static double[] currMin
```
    For table min boundary
  - currMax
```
public static double[] currMax
```
    For table max boundary
  - memStep
```
public static double memStep
```
    For table step size
  - currStep
```
public static double currStep
```
    For table step size
  - tHost
```
public long tHost
```
    long imposes a constraint on the maximum number of hosts to be 64
- Constructor Detail
  - SIFNeuron
```
public SIFNeuron(SIFNeuronPara 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()
```
    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
  - getSensoryWeight
```
public double getSensoryWeight()
```
    It looks this was originally a method in the Neuron interface which has since been removed. Probably can be deleted.
  - getTimeOfLastUpdate
```
public double getTimeOfLastUpdate()
```
    get the value of timeOfLastUpdate
    
    Returns:
    the value of timeOfLastUpdate
  - setMemV
```
public void setMemV(double memV)
```
    set a new value to memV
    
    Parameters:
    memV - the new value to be used
  - setRecord
```
public void setRecord(boolean record)
```
    set the neuron record or not.
    
    Specified by:
    
    setRecord in interface Neuron
  - setTHost
```
public void setTHost(long id)
```
    set the target host id //0 means none , 1 means yes
    
    Specified by:
    
    setTHost in interface Neuron
  - setTimeOfNextFire
```
public void setTimeOfNextFire(double timeOfNextFire)
```
    set a new value to timeOfNextFire
    
    Specified by:
    
    setTimeOfNextFire in interface Neuron
    
    Parameters:
    timeOfNextFire - the new value to be used
  - setTimeOfLastUpdate
```
public void setTimeOfLastUpdate(double timeOfLastUpdate)
```
    set a new value to timeOfLastUpdate
    
    Parameters:
    timeOfLastUpdate - 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 inputSynapse)
```
    Description copied from interface: Neuron
    
    update of the neuron after receiving a spike the current time is time
    
    Specified by:
    
    updateInput in interface Neuron
    
    inputSynapse - it is a InputEvent event in the input queue
    
    Returns:
    the time interval until next fire event, or negative if no spike is generated
  - doesFire
```
public boolean doesFire()
```
    Returns:
    true if the neuron will fire in future
  - timeOfFire
```
public double timeOfFire(double currTime)
```
    Returns:
    the time when the neuron fires
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SIFNeuron

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

maxWeight

TABLESIZE_o

TABLESIZE_c

memMin

memMax

currMin

currMax

memStep

currStep

tHost

Constructor Detail

SIFNeuron

Method Detail

getCurr

getMemV

getRecord

getTHost

getTimeOfNextFire

isSensory

realFire

getSensoryWeight

getTimeOfLastUpdate

setMemV

setRecord

setTHost

setTimeOfNextFire

setTimeOfLastUpdate

init

updateFire

updateInput

doesFire

timeOfFire

toString