CSIM: SpikeFilter Class Reference

SpikeFilter Class Reference

#include <spikefilter.h>

Inheritance diagram for SpikeFilter:

List of all members.

Detailed Description

Base class of all spike filters.

Public Member Functions

SpikeFilter (unsigned int values_per_channel=1)
virtual ~SpikeFilter (void)
virtual int filter (const double *r, double *x, int *indices)
virtual void reset ()
virtual void addChannel (csimClass *o)

Protected Member Functions

virtual double processSpike (int channel, double *target)=0

Protected Attributes

int nChannels
Number of Input channels to filter.
int lChannels
Number of allocated input channels.
double m_dt
Time step length.
double m_simtime
Current time.
double ** lastValues
Last filtered values of all channels.
int * firstSpike
Index of the first spike in the time window.
SpikingNeuron ** p_spikeSource
Pointers to the spiking neurons.
int nValuesPerChannel
Number of values stored for each channel in lastValues. [range=(1,2);].

Constructor & Destructor Documentation

SpikeFilter::SpikeFilter ( unsigned int values_per_channel = 1 )

Constructs a new spike filter.
Parameters:

values_per_channel Number of values to store per channel (e.g. 1 for exp-filter, 2 for alpha-filter).

SpikeFilter::~SpikeFilter ( void ) [virtual]

Frees the memory.

Member Function Documentation

void SpikeFilter::addChannel ( csimClass * o ) [virtual]

Adds one input channel.
Parameters:

o Pointer to spiking neuron. The "spikes" channel of this neuron is inserted.

int SpikeFilter::filter ( const double * r,

double * x,

int * indices

) [virtual]

Filter a spike signal of the neural microcircuit.
Parameters:

r Response of the neural microcircuit. (not needed for spikes)

x Target vector where to save the results.

indices Indices where to store the results in X.

Returns:
-1 if an error occured, 1 for success.

Implements FilterFunction.

virtual double SpikeFilter::processSpike ( int channel,

double * target

) [protected, pure virtual]

Process the occurence of a spike.
Parameters:

channel Index of the channel to filter.

target Target value where to store the new filtered value.

Implemented in AlphaSpikeFilter, CountSpikeFilter, and ExpSpikeFilter.

void SpikeFilter::reset ( ) [virtual]

Resets the information stored within the filter.
Implements FilterFunction.

last modified 07/10/2006