synapse::BaseSpikeDetector Class Reference

Base class for spike detectors. More...

#include <base_spike_detector.hpp>

Inheritance diagram for synapse::BaseSpikeDetector:

Public Member Functions
virtual SpikeEvent *	detect (const float sample, const uint64_t frame_timestamp, const uint32_t channel_id)=0
	Process a new sample and detect spikes.
virtual void	reset ()=0
	Reset the detector state.

Detailed Description

Base class for spike detectors.

Spike detectors take broadband neural data and identify spike events

Member Function Documentation

detect()

virtual SpikeEvent * synapse::BaseSpikeDetector::detect ( const float sample, const uint64_t frame_timestamp, const uint32_t channel_id )

pure virtual

Process a new sample and detect spikes.

Parameters

sample	The incoming broadband sample
frame_timestamp	Timestamp of the current frame
channel_id	Channel ID

Returns

SpikeEvent if a spike is detected, nullptr otherwise

Implemented in synapse::SpikeDetectorWrapper< DetectorType >.

reset()

virtual void synapse::BaseSpikeDetector::reset ( )

pure virtual

Reset the detector state.

Implemented in synapse::SpikeDetectorWrapper< DetectorType >.

---

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

• include/synapse-app-sdk/dsp/spike/base_spike_detector.hpp