SpikeGen Class Reference

#include <SpikeGen.h>

Collaboration diagram for SpikeGen:

Public Member Functions
bool	getEdgeTriggered () const
bool	getFired () const
double	getRefractT () const
double	getThreshold () const
void	handleVm (double val)
void	process (const Eref &e, ProcPtr p)
void	reinit (const Eref &e, ProcPtr p)
void	setEdgeTriggered (bool yes)
void	setRefractT (double val)
void	setThreshold (double threshold)
	SpikeGen ()

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Attributes
bool	edgeTriggered_
bool	fired_
double	lastEvent_
double	refractT_
double	threshold_
double	V_

Detailed Description

Definition at line 13 of file SpikeGen.h.

Constructor & Destructor Documentation

SpikeGen::SpikeGen

(

)

Definition at line 122 of file SpikeGen.cpp.

    : threshold_(0.0),
      refractT_(0.0),
      lastEvent_(0.0),
      V_(0.0),
      fired_( 0 ),
      edgeTriggered_(1)
{;}

Member Function Documentation

bool SpikeGen::getEdgeTriggered

(

)

const

Definition at line 183 of file SpikeGen.cpp.

References edgeTriggered_.

Referenced by initCinfo().

{
    return edgeTriggered_;
}

Here is the caller graph for this function:

bool SpikeGen::getFired

(

)

const

Definition at line 174 of file SpikeGen.cpp.

References fired_.

Referenced by initCinfo().

{
    return fired_;
}

Here is the caller graph for this function:

double SpikeGen::getRefractT

(

)

const

Definition at line 149 of file SpikeGen.cpp.

References refractT_.

Referenced by initCinfo().

{
    return refractT_;
}

Here is the caller graph for this function:

double SpikeGen::getThreshold

(

)

const

Definition at line 140 of file SpikeGen.cpp.

References threshold_.

Referenced by initCinfo().

{
    return threshold_;
}

Here is the caller graph for this function:

void SpikeGen::handleVm

(

double

val

)

Definition at line 214 of file SpikeGen.cpp.

References V_.

Referenced by initCinfo(), and SpikeGenStruct::send().

{
    V_ = val;
}

Here is the caller graph for this function:

const Cinfo * SpikeGen::initCinfo ( )

static

Definition at line 22 of file SpikeGen.cpp.

References getEdgeTriggered(), getFired(), getRefractT(), getThreshold(), handleVm(), Neutral::initCinfo(), process(), reinit(), setEdgeTriggered(), setRefractT(), setThreshold(), spikeGenCinfo, and spikeOut().

Referenced by HSolveActive::readSynapses().

{
    // Shared message definitions
    static DestFinfo process( "process",
        "Handles process call",
        new ProcOpFunc< SpikeGen >( &SpikeGen::process ) );
    static DestFinfo reinit( "reinit",
        "Handles reinit call",
        new ProcOpFunc< SpikeGen >( &SpikeGen::reinit ) );

    static Finfo* processShared[] =
    {
        &process, &reinit
    };

    static SharedFinfo proc( "proc",
        "Shared message to receive Process message from scheduler",
        processShared, sizeof( processShared ) / sizeof( Finfo* ) );

    // Dest Finfos.
    static DestFinfo Vm( "Vm",
            "Handles Vm message coming in from compartment",
            new OpFunc1< SpikeGen, double >( &SpikeGen::handleVm ) );

    // Value Finfos.

    static ValueFinfo< SpikeGen, double > threshold( "threshold",
        "Spiking threshold, must cross it going up",
        &SpikeGen::setThreshold,
        &SpikeGen::getThreshold
    );
    static ValueFinfo< SpikeGen, double > refractT( "refractT",
        "Refractory Time.",
        &SpikeGen::setRefractT,
        &SpikeGen::getRefractT
    );
    static ValueFinfo< SpikeGen, double > absRefract( "abs_refract",
        "Absolute refractory time. Synonym for refractT.",
        &SpikeGen::setRefractT,
        &SpikeGen::getRefractT
    );
    static ReadOnlyValueFinfo< SpikeGen, bool > hasFired( "hasFired",
        "True if SpikeGen has just fired",
        &SpikeGen::getFired
    );
    static ValueFinfo< SpikeGen, bool > edgeTriggered( "edgeTriggered",
        "When edgeTriggered = 0, the SpikeGen will fire an event in each "
        "timestep while incoming Vm is > threshold and at least abs_refract"
        "time has passed since last event. This may be problematic if the "
        "incoming Vm remains above threshold for longer than abs_refract. "
        "Setting edgeTriggered to 1 resolves this as the SpikeGen generates"
        "an event only on the rising edge of the incoming Vm and will "
        "remain idle unless the incoming Vm goes below threshold.",
        &SpikeGen::setEdgeTriggered,
        &SpikeGen::getEdgeTriggered
    );

    static Finfo* spikeGenFinfos[] =
    {
        spikeOut(), // SrcFinfo
        &proc,      // Shared
        &Vm,        // Dest
        &threshold, // Value
        &refractT,  // Value
        &absRefract,    // Value
        &hasFired,  // ReadOnlyValue
        &edgeTriggered, // Value

    };

    static string doc[] =
    {
        "Name", "SpikeGen",
        "Author", "Upi Bhalla",
        "Description", "SpikeGen object, for detecting threshold crossings."
        "The threshold detection can work in multiple modes.\n "
        "If the refractT < 0.0, then it fires an event only at the rising "
        "edge of the input voltage waveform"
    };
    static Dinfo< SpikeGen > dinfo;
    static Cinfo spikeGenCinfo(
        "SpikeGen",
        Neutral::initCinfo(),
        spikeGenFinfos, sizeof( spikeGenFinfos ) / sizeof( Finfo* ),
        &dinfo,
                doc,
                sizeof(doc)/sizeof(string)
    );

    return &spikeGenCinfo;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpikeGen::process	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 192 of file SpikeGen.cpp.

References ProcInfo::currTime, ProcInfo::dt, edgeTriggered_, fired_, lastEvent_, refractT_, spikeOut(), threshold_, and V_.

Referenced by initCinfo(), and SpikeGenStruct::send().

{
    double t = p->currTime;
    if ( V_ > threshold_ ) {
        if ((t + p->dt/2.0) >= (lastEvent_ + refractT_)) {
            if ( !( edgeTriggered_ && fired_ ) ) {
                spikeOut()->send( e, t );
                lastEvent_ = t;
                fired_ = true;
            }
        }
    } else {
            fired_ = false;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void SpikeGen::reinit	(	const Eref &	e,
		ProcPtr	p
	)

Definition at line 209 of file SpikeGen.cpp.

References lastEvent_, and refractT_.

Referenced by initCinfo(), and SpikeGenStruct::reinit().

{
    lastEvent_ = -refractT_ ;
}

Here is the caller graph for this function:

void SpikeGen::setEdgeTriggered

(

bool

yes

)

Definition at line 179 of file SpikeGen.cpp.

References edgeTriggered_.

Referenced by initCinfo().

{
    edgeTriggered_ = yes;
}

Here is the caller graph for this function:

void SpikeGen::setRefractT

(

double

val

)

Definition at line 145 of file SpikeGen.cpp.

References refractT_.

Referenced by initCinfo().

{
    refractT_ = val;
}

Here is the caller graph for this function:

void SpikeGen::setThreshold

(

double

threshold

)

Definition at line 136 of file SpikeGen.cpp.

References threshold_.

Referenced by initCinfo().

{
    threshold_ = threshold;
}

Here is the caller graph for this function:

Member Data Documentation

bool SpikeGen::edgeTriggered_

private

Definition at line 54 of file SpikeGen.h.

Referenced by getEdgeTriggered(), process(), and setEdgeTriggered().

bool SpikeGen::fired_

private

Definition at line 53 of file SpikeGen.h.

Referenced by getFired(), and process().

double SpikeGen::lastEvent_

private

Definition at line 51 of file SpikeGen.h.

Referenced by process(), and reinit().

double SpikeGen::refractT_

private

Definition at line 50 of file SpikeGen.h.

Referenced by getRefractT(), process(), reinit(), and setRefractT().

double SpikeGen::threshold_

private

Definition at line 49 of file SpikeGen.h.

Referenced by getThreshold(), process(), and setThreshold().

double SpikeGen::V_

private

Definition at line 52 of file SpikeGen.h.

Referenced by handleVm(), and process().

---

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

• moose-core/biophysics/SpikeGen.h
• moose-core/biophysics/SpikeGen.cpp