#include <beatdetector.h>

Inheritance diagram for BeatDetector:

Collaboration diagram for BeatDetector:

Public Member Functions
	BeatDetector (const string &ident="", int mode=0)

	~BeatDetector (void)

virtual int	init (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)

virtual void	notify (void)

virtual int	adjust (const EventList &events)

virtual int	detect (const EventList &inevents, EventList &outevents, const EventList &other, const EventData &stimuli)

int	checkPeak (EventSizeIterator first, EventSizeIterator last, EventSizeIterator event, EventIterator eventtime, EventSizeIterator index, EventIterator indextime, EventSizeIterator prevevent, EventIterator prevtime, EventList &outevents, double &threshold, double &minthresh, double &maxthresh, double &time, double &size, double &width)

int	checkTrough (EventSizeIterator first, EventSizeIterator last, EventSizeIterator event, EventIterator eventtime, EventSizeIterator index, EventIterator indextime, EventSizeIterator prevevent, EventIterator prevtime, EventList &outevents, double &threshold, double &minthresh, double &maxthresh, double &time, double &size, double &width)

Public Member Functions inherited from Filter
	Filter (const string &ident, int mode, FilterType type, int outtraces=0, const string &name="", const string &pluginset="", const string &author="unknown", const string &version="unknown", const string &date=__DATE__)

virtual	~Filter (void)

virtual int	init (const InData &indata, InData &outdata)

virtual int	init (const InList &indata, InList &outdata)

virtual int	init (const EventData &inevents, InData &outdata)

virtual int	init (const EventList &inevents, InList &outdata)

virtual int	init (const InData &indata, EventData &outevents, const EventList &other, const EventData &stimuli)

virtual int	init (const InList &indata, EventList &outevents, const EventList &other, const EventData &stimuli)

virtual int	init (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)

virtual int	adjust (const InData &indata, InData &outdata)

virtual int	adjust (const InList &indata, InList &outdata)

virtual int	adjust (const EventData &inevents, InData &outdata)

virtual int	adjust (const EventList &inevents, InList &outdata)

virtual int	adjust (const InData &indata)

virtual int	adjust (const InList &indata)

virtual int	adjust (const EventData &inevents)

virtual int	autoConfigure (const InData &indata, double tbegin, double tend)

virtual int	autoConfigure (const InList &indata, double tbegin, double tend)

virtual int	autoConfigure (const EventData &inevents, double tbegin, double tend)

virtual int	autoConfigure (const EventList &inevents, double tbegin, double tend)

virtual int	filter (const InData &indata, InData &outdata)

virtual int	filter (const InList &indata, InList &outdata)

virtual int	filter (const EventData &inevents, InData &outdata)

virtual int	filter (const EventList &inevents, InList &outdata)

virtual int	detect (const InData &data, EventData &outevents, const EventList &other, const EventData &stimuli)

virtual int	detect (const InList &data, EventList &outevents, const EventList &other, const EventData &stimuli)

virtual int	detect (const EventData &inevents, EventData &outevents, const EventList &other, const EventData &stimuli)

virtual void	save (const string &param)

void	save (void)

const string &	ident (void) const

virtual void	setIdent (const string &ident)

virtual void	setName (const string &name)

FilterType	type (void) const

int	outTraces (void) const

int	mode (void) const

void	setMode (int mode)

Public Member Functions inherited from ConfigDialog
	ConfigDialog (const string &configident="", int configgroup=0, const string &name="", const string &author="", const string &version="", const string &date=__DATE__)

virtual	~ConfigDialog (void)

string	name (void) const

string	author (void) const

virtual void	setAuthor (const string &author)

string	version (void) const

virtual void	setVersion (const string &version)

string	date (void) const

virtual void	setDate (const string &date)

virtual OptWidget *	dialogOptions (OptDialog od, string tabhotkeys=0)

virtual void	dialogButtons (OptDialog *od)

virtual void	dialogEmptyMessage (OptDialog *od)

int	dialogSelectMask (void) const

void	setDialogSelectMask (int mask)

void	addDialogSelectMask (int mask)

int	dialogReadOnlyMask (void) const

void	setDialogReadOnlyMask (int mask)

void	addDialogReadOnlyMask (int mask)

int	dialogStyle (void) const

void	setDialogStyle (int style)

void	addDialogStyle (int style)

string	dialogCaption (void) const

void	setDialogCaption (const string &caption)

bool	dialogHeader (void) const

void	setDialogHeader (bool d)

string	headerBackgroundColor (void) const

void	setHeaderBackgroundColor (const string &color)

string	headerForegroundColor (void) const

void	setHeaderForegroundColor (const string &color)

string	headerImageFile (void) const

void	setHeaderImageFile (const string &file)

virtual void	dialogHeaderWidget (OptDialog *od)

bool	dialogHelp (void) const

void	setDialogHelp (bool d)

string	helpCaption (void) const

void	setHelpCaption (const string &caption)

string	helpPath (int inx=0) const

int	helpPathes (void) const

void	clearHelpPathes (void)

void	setHelpPath (const string &path)

void	addHelpPath (const string &path)

virtual string	helpFileName (void) const

bool	dialogOpen (void) const

bool	helpOpen (void) const

QWidget *	mainWidget (void)

virtual void	setMainWidget (QWidget *widget)

void	lock () const

void	unlock () const

bool	tryLock (int timeout=1)

QMutex *	mutex (void)

Public Member Functions inherited from ConfigClass
	ConfigClass (const string &ident, int group=0, int mode=0xffff, int selectmask=0)

	ConfigClass (const ConfigClass &C)

virtual	~ConfigClass (void)

const string &	configIdent (void) const

void	setConfigIdent (const string &ident)

int	configGroup (void) const

void	setConfigGroup (int group)

int	configMode (void) const

void	setConfigMode (int mode)

void	addConfigMode (int mode)

void	delConfigMode (int mode)

int	configSelectMask (void) const

void	setConfigSelectMask (int mask)

void	addConfig (void)

void	readConfig (void)

virtual void	readConfig (StrQueue &sq)

virtual void	saveConfig (ofstream &str)

virtual int	configSize (void) const

virtual void	config (void)

virtual void	preConfig (void)

Protected Attributes
Detector< EventSizeIterator, EventIterator >	D

double	Threshold

double	MinThresh

double	MaxThresh

double	Delay

double	Decay

double	Ratio

double	ChirpDistance

const EventData *	ChirpEvents

OptWidget	BDW

Protected Attributes inherited from ConfigDialog
Options	DialogOptions

Additional Inherited Members
Public Types inherited from Filter
enum	FilterType

Public Types inherited from ConfigClass
enum	Action

Public Slots inherited from ConfigDialog
virtual void	dialog (void)

virtual void	help (void)

virtual void	notifyDialog (const Options &opt)

Signals inherited from ConfigDialog
void	dialogAccepted (void)

void	dialogAction (int r)

void	dialogClosed (int r)

Static Public Member Functions inherited from ConfigClass
static void	setConfigureClasses (ConfigureClasses *cfg)

Protected Slots inherited from ConfigDialog
void	notificationFromDialog (const Parameter &p)

virtual void	dClosed (int r)

virtual void	hClosed (int r)

Protected Member Functions inherited from ConfigDialog
void	setDialogOpen (bool open=true)

void	setHelpOpen (bool open=true)

Detailed Description

[Detector] Detects beats in EODs of wave-type weakly electric fish

Author: Jan Benda

Detects the peaks and troughs of EOD beats. The dynamic threshold is set to ratio times the amplitude of the beat and decays after a delay down to minthresh with a time constant decay.

Input: The times and amplitudes of EOD cycles.

Output: The times and amplitudes of beat peaks and troughs.

Options

threshold=6: Threshold (number)
minthresh=6: Minimum threshold (number)
delay=0sec: Delay time (number)
decay=10sec: Decay time constant (number)
ratio=50%: Ratio threshold / size (number)

Version: 1.2 (Jun 17, 2009)

Constructor & Destructor Documentation

BeatDetector	(	const string &	ident = `""`,
		int	mode = `0`
	)

The constructor.

References OptWidget::assign(), BeatDetector::BDW, BeatDetector::ChirpDistance, BeatDetector::ChirpEvents, BeatDetector::Decay, BeatDetector::Delay, BeatDetector::MaxThresh, BeatDetector::MinThresh, ConfigDialog::mutex(), BeatDetector::Ratio, ConfigClass::setConfigSelectMask(), ConfigDialog::setDialogSelectMask(), OptWidget::setMargins(), OptWidget::setVerticalSpacing(), and BeatDetector::Threshold.

~BeatDetector ( void )

The destructor.

Member Function Documentation

int init	(	const EventList &	inevents,
		EventList &	outevents,
		const EventList &	other,
		const EventData &	stimuli
	)

virtual

Reimplemented from Filter.

References BeatDetector::adjust(), BeatDetector::ChirpEvents, BeatDetector::D, and Detector< DataIter, TimeIter >::init().

void notify ( void )

virtual

References BeatDetector::BDW, BeatDetector::Decay, BeatDetector::Delay, BeatDetector::MinThresh, BeatDetector::Ratio, BeatDetector::Threshold, and OptWidget::updateValues().

int adjust ( const EventList & events )

virtual

Reimplemented from Filter.

References BeatDetector::BDW, Filter::ident(), BeatDetector::MaxThresh, InData::maxValue(), min(), InData::unit(), and OptWidget::updateSettings().

Referenced by BeatDetector::init().

int detect	(	const EventList &	inevents,
		EventList &	outevents,
		const EventList &	other,
		const EventData &	stimuli
	)

virtual

Detect the beat maxima and minima in EOD events.

Reimplemented from Filter.

References BeatDetector::BDW, BeatDetector::D, BeatDetector::Decay, BeatDetector::Delay, Detector< DataIter, TimeIter >::dynamicPeakTrough(), BeatDetector::MaxThresh, BeatDetector::MinThresh, EventList::size(), sum(), BeatDetector::Threshold, and OptWidget::updateValues().

int checkPeak	(	EventSizeIterator	first,
		EventSizeIterator	last,
		EventSizeIterator	event,
		EventIterator	eventtime,
		EventSizeIterator	index,
		EventIterator	indextime,
		EventSizeIterator	prevevent,
		EventIterator	prevtime,
		EventList &	outevents,
		double &	threshold,
		double &	minthresh,
		double &	maxthresh,
		double &	time,
		double &	size,
		double &	width
	)

References BeatDetector::ChirpDistance, BeatDetector::ChirpEvents, and EventData::within().

int checkTrough	(	EventSizeIterator	first,
		EventSizeIterator	last,
		EventSizeIterator	event,
		EventIterator	eventtime,
		EventSizeIterator	index,
		EventIterator	indextime,
		EventSizeIterator	prevevent,
		EventIterator	prevtime,
		EventList &	outevents,
		double &	threshold,
		double &	minthresh,
		double &	maxthresh,
		double &	time,
		double &	size,
		double &	width
	)