CSIM: AnalogFilter Class Reference

AnalogFilter Class Reference

#include <analogfilter.h>

Inheritance diagram for AnalogFilter:

List of all members.

Detailed Description

Base class of all analog filters.

Public Member Functions

AnalogFilter (unsigned int kernel_length)
virtual ~AnalogFilter (void)
virtual int filter (const double *r, double *x, int *indices=0)
virtual void createKernel (unsigned int n)=0
virtual void reset ()
virtual int setNumInputs (unsigned int nInputs)
virtual void addChannel ()
virtual int updateInternal ()

Public Attributes

int nKernelLength
The length of the kernel.

Protected Attributes

double * filter_kernel
The filter kernel.
int oldKernelLength
The length of the old kernel.
int nChannels
Number of Input channels to filter.
int lChannels
Number of allocated input channels.
deque< double > ** dataQueues
Storage of the last datapoints for low-pass filtering.
int nInputAvailable
Number of data-points received.
double dKernelLength
Dummy variable for parameter setting and getting.

Constructor & Destructor Documentation

AnalogFilter::AnalogFilter ( unsigned int kernel_length )

Constructs a new analog filter.
Parameters:

kernel_length The length of the filter kernel.

AnalogFilter::~AnalogFilter ( void ) [virtual]

Frees the memory.

Member Function Documentation

void AnalogFilter::addChannel ( ) [virtual]

Adds one input channel.

virtual void AnalogFilter::createKernel ( unsigned int n ) [pure virtual]

Calculates a new filter kernel for the given number of data points.
Parameters:

n Number of data points to filter.

Implemented in GaussianAnalogFilter, TriangularAnalogFilter, and UserAnalogFilter.

int AnalogFilter::filter ( const double * r,

double * x,

int * indices = 0

) [virtual]

Filter a response signal of the neural microcircuit.
Parameters:

r Response of the neural microcircuit.

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.

void AnalogFilter::reset ( ) [virtual]

Resets the information stored within the filter.
Implements FilterFunction.

int AnalogFilter::setNumInputs ( unsigned int nInputs ) [virtual]

Sets the number of input channels.
Parameters:

nInputs The number of inputs.

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

int AnalogFilter::updateInternal ( ) [virtual]

This function is called after parameters are updated.
Reimplemented from FilterFunction.
Reimplemented in UserAnalogFilter.

last modified 07/10/2006