RandSpike Class Reference

#include <RandSpike.h>

Collaboration diagram for RandSpike:

Public Member Functions
bool	getDoPeriodic () const
bool	getFired () const
double	getRate () const
double	getRefractT () const
void	process (const Eref &e, ProcPtr p)
	RandSpike ()
void	reinit (const Eref &e, ProcPtr p)
void	setDoPeriodic (bool val)
void	setRate (double rate)
void	setRefractT (double val)

Static Public Member Functions
static const Cinfo *	initCinfo ()

Private Attributes
bool	doPeriodic_
bool	fired_
double	lastEvent_
double	rate_
double	realRate_
double	refractT_
double	threshold_

Detailed Description

Definition at line 13 of file RandSpike.h.

Constructor & Destructor Documentation

RandSpike::RandSpike

(

)

Definition at line 119 of file RandSpike.cpp.

    :
    rate_( 0.0 ),
    realRate_( 0.0 ),
    refractT_(0.0),
    lastEvent_(0.0),
    threshold_(0.0),
    fired_( false ),
    doPeriodic_( false )
{
    ;
}

Member Function Documentation

bool RandSpike::getDoPeriodic

(

)

const

Definition at line 179 of file RandSpike.cpp.

References doPeriodic_.

Referenced by initCinfo().

{
    return doPeriodic_;
}

Here is the caller graph for this function:

bool RandSpike::getFired

(

)

const

Definition at line 170 of file RandSpike.cpp.

References fired_.

Referenced by initCinfo().

{
    return fired_;
}

Here is the caller graph for this function:

double RandSpike::getRate

(

)

const

Definition at line 156 of file RandSpike.cpp.

References rate_.

Referenced by initCinfo().

{
    return rate_;
}

Here is the caller graph for this function:

double RandSpike::getRefractT

(

)

const

Definition at line 165 of file RandSpike.cpp.

References refractT_.

Referenced by initCinfo().

{
    return refractT_;
}

Here is the caller graph for this function:

const Cinfo * RandSpike::initCinfo ( )

static

Definition at line 25 of file RandSpike.cpp.

References getDoPeriodic(), getFired(), getRate(), getRefractT(), Neutral::initCinfo(), process(), reinit(), setDoPeriodic(), setRate(), setRefractT(), spikeGenCinfo, and spikeOut().

{
    // Shared message definitions
    static DestFinfo process( "process",
                              "Handles process call",
                              new ProcOpFunc< RandSpike >( &RandSpike::process ) );
    static DestFinfo reinit( "reinit",
                             "Handles reinit call",
                             new ProcOpFunc< RandSpike >( &RandSpike::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.

    // Value Finfos.

    static ValueFinfo< RandSpike, double > rate( "rate",
            "Specifies rate for random spike train. Note that this is"
            "probabilistic, so the instantaneous rate may differ. "
            "If the rate is assigned be message and it varies slowly then "
            "the average firing rate will approach the specified rate",
            &RandSpike::setRate,
            &RandSpike::getRate
                                               );
    static ValueFinfo< RandSpike, double > refractT( "refractT",
            "Refractory Time.",
            &RandSpike::setRefractT,
            &RandSpike::getRefractT
                                                   );
    static ValueFinfo< RandSpike, double > absRefract( "abs_refract",
            "Absolute refractory time. Synonym for refractT.",
            &RandSpike::setRefractT,
            &RandSpike::getRefractT
                                                     );
    static ValueFinfo< RandSpike, bool > doPeriodic( "doPeriodic",
            "Flag: when false, do Poisson process with specified mean rate.\n"
            "When true, fire periodically at specified rate.\n"
            "Defaults to false. Note that refractory time overrides this: "
            "Rate cannot exceed 1/refractT.",
            &RandSpike::setDoPeriodic,
            &RandSpike::getDoPeriodic
                                                   );
    static ReadOnlyValueFinfo< RandSpike, bool > hasFired( "hasFired",
            "True if RandSpike has just fired",
            &RandSpike::getFired
                                                         );

    static Finfo* spikeGenFinfos[] =
    {
        spikeOut(), // SrcFinfo
        &proc,      // Shared
        &rate,      // Value
        &refractT,  // Value
        &absRefract,    // Value
        &doPeriodic,    // Value
        &hasFired,  // ReadOnlyValue
    };

    static string doc[] =
    {
        "Name", "RandSpike",
        "Author", "Upi Bhalla",
        "Description", "RandSpike object, generates random or regular "
        "spikes at "
        "specified mean rate. Based closely on GENESIS randspike. "
    };
    static Dinfo< RandSpike > dinfo;
    static Cinfo spikeGenCinfo(
        "RandSpike",
        Neutral::initCinfo(),
        spikeGenFinfos, sizeof( spikeGenFinfos ) / sizeof( Finfo* ),
        &dinfo,
        doc,
        sizeof(doc)/sizeof(string)
    );

    return &spikeGenCinfo;
}

Here is the call graph for this function:

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

Definition at line 189 of file RandSpike.cpp.

References ProcInfo::currTime, doPeriodic_, ProcInfo::dt, fired_, lastEvent_, moose::mtrand(), rate_, realRate_, refractT_, and spikeOut().

Referenced by initCinfo().

{
    if ( refractT_ > p->currTime - lastEvent_  || rate_ <= 0.0 )
        return;

    fired_ = false;
    if (doPeriodic_)
    {
        if ( (p->currTime - lastEvent_) > 1.0/rate_ )
        {
            lastEvent_ = p->currTime;
            spikeOut()->send( e, p->currTime );
            fired_ = true;
        }
    }
    else
    {
        double prob = realRate_ * p->dt;
        if ( prob >= 1.0 || prob >= moose::mtrand() )
        {
            lastEvent_ = p->currTime;
            spikeOut()->send( e, p->currTime );
            fired_ = true;
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 217 of file RandSpike.cpp.

References lastEvent_, moose::log(), moose::mtrand(), rate_, and realRate_.

Referenced by initCinfo().

{
    if ( rate_ <= 0.0 )
    {
        lastEvent_ = 0.0;
        realRate_ = 0.0;
    }
    else
    {
        double prob = moose::mtrand();
        double m = 1.0 / rate_;
        lastEvent_ = m * log( prob );
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

void RandSpike::setDoPeriodic

(

bool

val

)

Definition at line 175 of file RandSpike.cpp.

References doPeriodic_.

Referenced by initCinfo().

{
    doPeriodic_ = val;
}

Here is the caller graph for this function:

void RandSpike::setRate

(

double

rate

)

Definition at line 137 of file RandSpike.cpp.

References rate_, realRate_, and refractT_.

Referenced by initCinfo().

{
    if ( rate < 0.0 )
    {
        cout <<"Warning: RandSpike::setRate: Rate must be >= 0. Using 0.\n";
        rate = 0.0;
    }
    rate_ = rate;
    double prob = 1.0 - rate * refractT_;
    if ( prob <= 0.0 )
    {
        cout << "Warning: RandSpike::setRate: Rate is too high compared to refractory time\n";
        realRate_ = rate_;
    }
    else
    {
        realRate_ = rate_ / prob;
    }
}

Here is the caller graph for this function:

void RandSpike::setRefractT

(

double

val

)

Definition at line 161 of file RandSpike.cpp.

References refractT_.

Referenced by initCinfo().

{
    refractT_ = val;
}

Here is the caller graph for this function:

Member Data Documentation

bool RandSpike::doPeriodic_

private

Definition at line 48 of file RandSpike.h.

Referenced by getDoPeriodic(), process(), and setDoPeriodic().

bool RandSpike::fired_

private

Definition at line 47 of file RandSpike.h.

Referenced by getFired(), and process().

double RandSpike::lastEvent_

private

Definition at line 45 of file RandSpike.h.

Referenced by process(), and reinit().

double RandSpike::rate_

private

Definition at line 42 of file RandSpike.h.

Referenced by getRate(), process(), reinit(), and setRate().

double RandSpike::realRate_

private

Definition at line 43 of file RandSpike.h.

Referenced by process(), reinit(), and setRate().

double RandSpike::refractT_

private

Definition at line 44 of file RandSpike.h.

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

double RandSpike::threshold_

private

Definition at line 46 of file RandSpike.h.

---

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

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