cnslab.cnsnetwork

Interface Neuron

All Known Implementing Classes:

BKPoissonNeuron, MiNiNeuron, SIFNeuron, SYNNeuron, UserSenNeuron, VSICLIFNeuron, VSICLIFNeuronV2

public interface Neuron

Interface for a Neuron object.

Version:

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

Author:

Yi Dong, David Wallace Croft, M.Sc., Jeremy Cohen

Method Summary

Methods

Modifier and Type	Method and Description
double[]	getCurr(double currTime)
double	getMemV(double currTime)
boolean	getRecord() record the neuron
long	getTHost()
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	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	setTimeOfNextFire(double timeOfNextFire) set a new value to timeOfNextFire
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

Method Detail

getCurr

double[] getCurr(double currTime)

Returns:

neuron's current currents of all the channels

getMemV

double getMemV(double currTime)

Returns:

neuron's current membrane voltage

getRecord

boolean getRecord()

record the neuron

Returns:

boolean whether it should be recorded

getTHost

long getTHost()

Returns:

the target host, maximum NetHost 64

getTimeOfNextFire

double getTimeOfNextFire()

get the value of timeOfNextFire

Returns:

the value of timeOfNextFire

isSensory

boolean isSensory()

sensory report

Returns:

true if the neuron is a sensory neuron

realFire

boolean realFire()

Returns:

whether the scheduled neuron fire means the neuron really fires

setRecord

void setRecord(boolean record)

set the neuron record or not.

setTHost

void setTHost(long id)

set the target host id, 0 means none, 1 means yes

setTimeOfNextFire

void setTimeOfNextFire(double timeOfNextFire)

set a new value to timeOfNextFire

Parameters:

timeOfNextFire - the new value to be used

init

void init(int expid,
        int trialid,
        Seed idum,
        Network net,
        int id)

initialize the neuron

updateFire

double updateFire()

update of the neuron after firing the current time is TimeOfNextFire

Returns:

the time interval until the next fire event, or negative if no spike is generated

updateInput

double updateInput(double time,
                 Synapse input)

update of the neuron after receiving a spike the current time is time

Parameters:

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