MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
moose::LIF Class Reference

#include <LIF.h>

+ Inheritance diagram for moose::LIF:
+ Collaboration diagram for moose::LIF:

Public Member Functions

 LIF ()
 
void vProcess (const Eref &e, ProcPtr p)
 
void vReinit (const Eref &e, ProcPtr p)
 
virtual ~LIF ()
 
- Public Member Functions inherited from moose::IntFireBase
void activation (double val)
 
double getLastEventTime (const Eref &e) const
 
double getRefractoryPeriod (const Eref &e) const
 
double getThresh (const Eref &e) const
 
double getVReset (const Eref &e) const
 
bool hasFired (const Eref &e) const
 
 IntFireBase ()
 
void setRefractoryPeriod (const Eref &e, double val)
 
void setThresh (const Eref &e, double val)
 
void setVReset (const Eref &e, double val)
 
virtual ~IntFireBase ()
 
- Public Member Functions inherited from moose::Compartment
void cable ()
 
 Compartment ()
 
virtual double vGetCm (const Eref &e) const
 
virtual double vGetEm (const Eref &e) const
 
virtual double vGetIm (const Eref &e) const
 
virtual double vGetInitVm (const Eref &e) const
 
virtual double vGetInject (const Eref &e) const
 
virtual double vGetRa (const Eref &e) const
 
virtual double vGetRm (const Eref &e) const
 
virtual double vGetVm (const Eref &e) const
 
void vHandleAxial (double Vm)
 
void vHandleChannel (const Eref &e, double Gk, double Ek)
 
void vHandleRaxial (double Ra, double Vm)
 
void vInitProc (const Eref &e, ProcPtr p)
 
void vInitReinit (const Eref &e, ProcPtr p)
 
void vInjectMsg (const Eref &e, double current)
 
void vRandInject (const Eref &e, double prob, double current)
 
virtual void vSetCm (const Eref &e, double Cm)
 
virtual void vSetEm (const Eref &e, double Em)
 
virtual void vSetInitVm (const Eref &e, double initVm)
 
virtual void vSetInject (const Eref &e, double Inject)
 
virtual void vSetRa (const Eref &e, double Ra)
 
virtual void vSetRm (const Eref &e, double Rm)
 
virtual void vSetVm (const Eref &e, double Vm)
 
virtual ~Compartment ()
 
- Public Member Functions inherited from moose::CompartmentBase
void cable ()
 
 CompartmentBase ()
 
void displace (double dx, double dy, double dz)
 Displaces compartment by specified distance vector. More...
 
double getCm (const Eref &e) const
 
double getDiameter () const
 
double getEm (const Eref &e) const
 
double getIm (const Eref &e) const
 
double getInitVm (const Eref &e) const
 
double getInject (const Eref &e) const
 
double getLength () const
 
double getRa (const Eref &e) const
 
double getRm (const Eref &e) const
 
double getVm (const Eref &e) const
 
double getX () const
 
double getX0 () const
 
double getY () const
 
double getY0 () const
 
double getZ () const
 
double getZ0 () const
 
void handleAxial (double Vm)
 
void handleChannel (const Eref &e, double Gk, double Ek)
 
void handleRaxial (double Ra, double Vm)
 
void initProc (const Eref &e, ProcPtr p)
 
void initReinit (const Eref &e, ProcPtr p)
 
void injectMsg (const Eref &e, double current)
 
void process (const Eref &e, ProcPtr p)
 
void randInject (const Eref &e, double prob, double current)
 
bool rangeWarning (const string &field, double value)
 
void reinit (const Eref &e, ProcPtr p)
 
void setCm (const Eref &e, double Cm)
 
void setDiameter (double diameter)
 
void setEm (const Eref &e, double Em)
 
void setGeomAndElec (const Eref &e, double length, double dia)
 Scales electrical values along with setting length, dia. More...
 
void setInitVm (const Eref &e, double initVm)
 
void setInject (const Eref &e, double Inject)
 
void setLength (double length)
 
void setRa (const Eref &e, double Ra)
 
void setRm (const Eref &e, double Rm)
 
void setVm (const Eref &e, double Vm)
 
void setX (double value)
 
void setX0 (double value)
 
void setY (double value)
 
void setY0 (double value)
 
void setZ (double value)
 
void setZ0 (double value)
 
void updateLength ()
 
virtual void vSetSolver (const Eref &e, Id hsolve)
 
virtual ~CompartmentBase ()
 

Static Public Member Functions

static const CinfoinitCinfo ()
 
- Static Public Member Functions inherited from moose::IntFireBase
static const CinfoinitCinfo ()
 
static SrcFinfo1< double > * spikeOut ()
 Message src for outgoing spikes. More...
 
- Static Public Member Functions inherited from moose::Compartment
static const CinfoinitCinfo ()
 
- Static Public Member Functions inherited from moose::CompartmentBase
static const CinfoinitCinfo ()
 
static SrcFinfo1< double > * VmOut ()
 
static void zombify (Element *orig, const Cinfo *zClass, Id hsolve)
 

Additional Inherited Members

- Protected Attributes inherited from moose::IntFireBase
double activation_
 
bool fired_
 
double lastEvent_
 
double refractT_
 
double threshold_
 
double vReset_
 
- Protected Attributes inherited from moose::Compartment
double A_
 
double B_
 
double Cm_
 
double Em_
 
double Im_
 
double initVm_
 
double inject_
 
double lastIm_
 
double Ra_
 
double Rm_
 
double sumInject_
 
double Vm_
 

Detailed Description

The IntFire class sets up an integrate-and-fire compartment.

Definition at line 20 of file LIF.h.

Constructor & Destructor Documentation

LIF::LIF ( )

Definition at line 46 of file LIF.cpp.

47 {
48  ;
49 }
LIF::~LIF ( )
virtual

Definition at line 51 of file LIF.cpp.

52 {
53  ;
54 }

Member Function Documentation

const Cinfo * LIF::initCinfo ( )
static

Initializes the class info.

Definition at line 19 of file LIF.cpp.

References moose::IntFireBase::initCinfo(), and lifCinfo.

20 {
21  static string doc[] =
22  {
23  "Name", "LIF",
24  "Author", "Upi Bhalla",
25  "Description", "Leaky Integrate-and-Fire neuron"
26  };
27  static Dinfo< LIF > dinfo;
28  static Cinfo lifCinfo(
29  "LIF",
31  0, 0,
32  &dinfo,
33  doc,
34  sizeof(doc)/sizeof(string)
35  );
36 
37  return &lifCinfo;
38 }
Definition: Dinfo.h:60
static const Cinfo * initCinfo()
Definition: IntFireBase.cpp:27
static const Cinfo * lifCinfo
Definition: LIF.cpp:40
Definition: Cinfo.h:18

+ Here is the call graph for this function:

void LIF::vProcess ( const Eref e,
ProcPtr  p 
)
virtual

The process function does the object updating and sends out messages to channels, nernsts, and so on.

Implements moose::IntFireBase.

Definition at line 60 of file LIF.cpp.

References moose::Compartment::A_, moose::IntFireBase::activation_, moose::Compartment::B_, ProcInfo::currTime, ProcInfo::dt, moose::IntFireBase::fired_, moose::IntFireBase::lastEvent_, moose::IntFireBase::refractT_, moose::Compartment::Rm_, moose::IntFireBase::spikeOut(), moose::Compartment::sumInject_, moose::IntFireBase::threshold_, moose::Compartment::Vm_, moose::CompartmentBase::VmOut(), moose::Compartment::vProcess(), and moose::IntFireBase::vReset_.

61 {
62  fired_ = false;
63  if ( p->currTime < lastEvent_ + refractT_ )
64  {
65  Vm_ = vReset_;
66  A_ = 0.0;
67  B_ = 1.0 / Rm_;
68  sumInject_ = 0.0;
69  VmOut()->send( e, Vm_ );
70  }
71  else
72  {
73  // activation can be a continous variable (graded synapse).
74  // So integrate it at every time step, thus *dt.
75  // For a delta-fn synapse, SynHandler-s divide by dt and send activation.
76  // See: http://www.genesis-sim.org/GENESIS/Hyperdoc/Manual-26.html#synchan
77  // for this continuous definition of activation.
78  Vm_ += activation_ * p->dt;
79  activation_ = 0.0;
80  if ( Vm_ > threshold_ )
81  {
82  Vm_ = vReset_;
83  lastEvent_ = p->currTime;
84  fired_ = true;
85  spikeOut()->send( e, p->currTime );
86  VmOut()->send( e, Vm_ );
87  }
88  else
89  {
90  Compartment::vProcess( e, p );
91  }
92  }
93 }
double currTime
Definition: ProcInfo.h:19
void vProcess(const Eref &e, ProcPtr p)
double dt
Definition: ProcInfo.h:18
static SrcFinfo1< double > * spikeOut()
Message src for outgoing spikes.
Definition: IntFireBase.cpp:17
static SrcFinfo1< double > * VmOut()

+ Here is the call graph for this function:

void LIF::vReinit ( const Eref e,
ProcPtr  p 
)
virtual

The reinit function reinitializes all fields.

Implements moose::IntFireBase.

Definition at line 95 of file LIF.cpp.

References moose::IntFireBase::activation_, moose::IntFireBase::fired_, moose::IntFireBase::lastEvent_, moose::IntFireBase::refractT_, and moose::Compartment::vReinit().

96 {
97  activation_ = 0.0;
98  fired_ = false;
99  lastEvent_ = -refractT_; // Allow it to fire right away.
100  Compartment::vReinit( e, p );
101 }
void vReinit(const Eref &e, ProcPtr p)

+ Here is the call graph for this function:


The documentation for this class was generated from the following files: