#include <chirpdetector.h>

Inheritance diagram for ChirpDetector:

Collaboration diagram for ChirpDetector:

Public Slots
void	autoConfigure (void)

Public Slots inherited from ConfigDialog
virtual void	dialog (void)

virtual void	help (void)

virtual void	notifyDialog (const Options &opt)

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

	~ChirpDetector (void)

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

virtual void	notify (void)

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

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

int	checkEvent (EventFrequencyIterator first, EventFrequencyIterator last, EventFrequencyIterator event, EventIterator eventtime, EventFrequencyIterator index, EventIterator indextime, EventFrequencyIterator prevevent, EventIterator prevtime, EventData &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 EventList &inevents, EventList &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	adjust (const EventList &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 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 EventList &inevents, EventList &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 < EventFrequencyIterator, EventIterator >	D

double	Threshold

double	MinThresh

double	ChirpMinWidth

double	ChirpMaxWidth

int	ChirpCycles

int	AverageCycles

const EventList *	Other

OptWidget	CDW

const EventData *	Data

Protected Attributes inherited from ConfigDialog
Options	DialogOptions

Additional Inherited Members
Public Types inherited from Filter
enum	FilterType

Public Types inherited from ConfigClass
enum	Action

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 chirps of wave-type weakly electric fish

Author: Jan Benda

Version: 1.3 (Jan 19, 2013)

Chirps are transient increases of the EOD frequency of wave-type weakly electric fish. A chirp is detected if the EOD frequency increases by more than threshold Hz. A chirp has to last at least minwidth and at most maxwidth and has a minimum size of minthresh.

Input: The event times of an EOD.

Output: The times, sizes, and widths of chirps.

Options

threshold=10Hz: Threshold (number)
minthresh=0Hz: Minimum threshold (number)
minwidth=3ms: Minimum width (number)
maxwidth=50ms: Maximum width (number)

Constructor & Destructor Documentation

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

References OptWidget::assign(), ChirpDetector::autoConfigure(), ChirpDetector::AverageCycles, ChirpDetector::CDW, ChirpDetector::ChirpCycles, ChirpDetector::ChirpMaxWidth, ChirpDetector::ChirpMinWidth, ChirpDetector::Data, ConfigDialog::dialogAccepted(), ConfigDialog::help(), ChirpDetector::MinThresh, ConfigDialog::mutex(), ChirpDetector::Other, ConfigClass::setConfigSelectMask(), ConfigDialog::setDialogSelectMask(), OptWidget::setMargins(), OptWidget::setVerticalSpacing(), and ChirpDetector::Threshold.

~ChirpDetector ( void )

Member Function Documentation

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

virtual

Reimplemented from Filter.

References EventData::begin(), ChirpDetector::CDW, ChirpDetector::D, ChirpDetector::Data, EventData::end(), Detector< DataIter, TimeIter >::init(), ChirpDetector::Other, EventData::setSizeFormat(), EventData::setSizeScale(), EventData::setSizeUnit(), EventData::setWidthFormat(), EventData::setWidthScale(), EventData::setWidthUnit(), and OptWidget::updateValues().

void notify ( void )

virtual

References ChirpDetector::CDW, ChirpDetector::ChirpMaxWidth, ChirpDetector::ChirpMinWidth, ChirpDetector::MinThresh, ChirpDetector::Threshold, and OptWidget::updateValues().

int autoConfigure	(	const EventData &	data,
		double	tbegin,
		double	tend
	)

virtual

Reimplemented from Filter.

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

virtual

Detect chirps in EOD events inevents.

Reimplemented from Filter.

References ChirpDetector::CDW, ChirpDetector::D, EventData::end(), EventData::meanRate(), EventData::meanSize(), EventData::meanWidth(), EventData::minBegin(), ChirpDetector::MinThresh, Detector< DataIter, TimeIter >::peak(), EventData::size(), ChirpDetector::Threshold, EventData::updateMean(), and OptWidget::updateValues().

int checkEvent	(	EventFrequencyIterator	first,
		EventFrequencyIterator	last,
		EventFrequencyIterator	event,
		EventIterator	eventtime,
		EventFrequencyIterator	index,
		EventIterator	indextime,
		EventFrequencyIterator	prevevent,
		EventIterator	prevtime,
		EventData &	outevents,
		double &	threshold,
		double &	minthresh,
		double &	maxthresh,
		double &	time,
		double &	size,
		double &	width
	)