SpikeRingBuffer Class Reference

#include <SpikeRingBuffer.h>

Collaboration diagram for SpikeRingBuffer:

Public Member Functions
void	addSpike (double timestamp, double weight)
	Adds spike into the buffer. More...
double	pop (double currTime)
	Advances the buffer one step, returns the current weight. More...
void	reinit (double dt, double bufferTime)
	Sets up buffer parameters. More...
	SpikeRingBuffer ()

Private Attributes
unsigned int	currentBin_
double	currTime_
double	dt_
vector< double >	weightSum_

Static Private Attributes
static const unsigned int	MAXBIN = 128

Detailed Description

This ring buffer handles incoming spikes. It spans an interval equal to the longest arrival delay. When a spike event is notified it puts it into the slot defined by the arrival time. It just adds the weight onto the existing value in this slot, assuming a linear summation of the weights of coincident inputs.

Definition at line 19 of file SpikeRingBuffer.h.

Constructor & Destructor Documentation

SpikeRingBuffer::SpikeRingBuffer

(

)

Definition at line 20 of file SpikeRingBuffer.cpp.

        : dt_( 1e-4 ),
        currTime_( 0 ),
        currentBin_( 0 ),
        weightSum_( 20, 0.0 )
{;}

Member Function Documentation

void SpikeRingBuffer::addSpike	(	double	timestamp,
		double	weight
	)

Adds spike into the buffer.

Definition at line 49 of file SpikeRingBuffer.cpp.

References currentBin_, currTime_, dt_, MAXBIN, and weightSum_.

{
    unsigned int bin = round( ( t - currTime_ ) / dt_ );

    if ( bin > weightSum_.size() ) {
    // Should do catch-throw here
        if ( t < currTime_ ) {
            cout << "Warning: SpikeRingBuffer: handling spike too late: " <<
                t << " <  " << currTime_ << ", using currTime\n";
            bin = 0;
        } else if ( bin >= MAXBIN ) {
            cout << "Warning: SpikeRingBuffer: bin number exceeds limit: "<<
                "spikeTime = " << t << ", currtime=  " << currTime_ <<
                ", dt = " << dt_ << ", bin = " << bin << " >=  " << MAXBIN << ", terminating\n";
                assert( 0 );
        } else {
            weightSum_.resize( bin + 1 );
        }
    }

    // Replace the % with a bitwise operation.
    weightSum_[ ( bin + currentBin_ ) % weightSum_.size() ] += w;
}

double SpikeRingBuffer::pop

(

double

currTime

)

Advances the buffer one step, returns the current weight.

Definition at line 73 of file SpikeRingBuffer.cpp.

References currentBin_, currTime_, and weightSum_.

{
    currTime_ = currTime;
    if ( currentBin_ == weightSum_.size() )
        currentBin_ = 0;
    double ret = weightSum_[ currentBin_ ];
    weightSum_[ currentBin_++ ] = 0.0;
    return ret;
}

void SpikeRingBuffer::reinit	(	double	dt,
		double	bufferTime
	)

Sets up buffer parameters.

Definition at line 27 of file SpikeRingBuffer.cpp.

References currentBin_, currTime_, dt_, MAXBIN, and weightSum_.

{
    dt_ = dt;
    currTime_ = 0.0;
    currentBin_ = 0;
    unsigned int newsize = bufferTime / dt;
    if ( newsize > MAXBIN ) {
        cout << "Warning: SpikeRingBuffer::reinit: buffer size too big: " <<
            newsize << " = " << bufferTime << " / " <<
                dt << ", using " << MAXBIN << endl;
        newsize = MAXBIN;
    }
    if ( newsize == 0 ) {
        cout << "Warning: SpikeRingBuffer::reinit: buffer size too small: " <<
            newsize << " = " << bufferTime << " / " <<
                dt << ", using " << 10 << endl;
        newsize = 10;
    }
    weightSum_.clear();
    weightSum_.resize( newsize, 0.0 );
}

Member Data Documentation

unsigned int SpikeRingBuffer::currentBin_

private

Definition at line 35 of file SpikeRingBuffer.h.

Referenced by addSpike(), pop(), and reinit().

double SpikeRingBuffer::currTime_

private

Definition at line 34 of file SpikeRingBuffer.h.

Referenced by addSpike(), pop(), and reinit().

double SpikeRingBuffer::dt_

private

Definition at line 33 of file SpikeRingBuffer.h.

Referenced by addSpike(), and reinit().

const unsigned int SpikeRingBuffer::MAXBIN = 128

staticprivate

Definition at line 32 of file SpikeRingBuffer.h.

Referenced by addSpike(), and reinit().

vector< double > SpikeRingBuffer::weightSum_

private

Definition at line 36 of file SpikeRingBuffer.h.

Referenced by addSpike(), pop(), and reinit().

---

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

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