RippleDetector

Detect ripples in a MultiChannelData stream and emits a ripple event in response

Input port

port name	data type	slots	description
data	MultiChannelData <double>	1	None

Output port

port name	data type	slots	description
events	EventData	1	A stream of ‘ripple’ events.
statistics	MultiChannelData <double>	1	None

Options

port name	data type	default	description
threshold dev	double	6.0	Multiplier (in number of signal standard deviations) to compute the initial threshold.
smooth time	double	10.0 seconds	Integration time for estimating signal statistics. Must be a positive number (sec).
analysis lockout time	double	30 ms	refractory period after threshold crossing detection that is not considered for updating of statistics and for detecting events to avoid over-stimulation. Must greater than 0 ms.
stream events	bool	True	enable/disable ripple event output
stream statistics	bool	True	Enable streaming of statistics
use power	bool	True	Use power of signal for detection.
statistics buffer size	double	0.5 sec	Buffer size (in seconds) for statistics output stream. This value determines the number of samples that will be collected for each data packet streamed out on the statistics output port. must be either equals or greater than 0.
statistics downsample factor	unsigned int	1	Downsample factor of streamed statistics signal

Static states

name	data type	initial value	external access	peers access	description
threshold dev	double	6.0	write	True	Multiplier (in number of signal standard deviations) to compute the initial threshold.
smooth time	double	10.0 seconds	write	True	Integration time for estimating signal statistics. Must be a positive number (sec).
analysis lockout time	double	30 ms	write	True	refractory period after threshold crossing detection that is not considered for updating of statistics and for detecting events to avoid over-stimulation. Must greater than 0 ms.
stream events	bool	True	write	True	enable/disable ripple event output
stream statistics	bool	True	write	True	Enable streaming of statistics

Follower states

name	data type	initial value	external access	description
detection enabled	bool	True	None	Enable the detection of ripples

Producer states

name	data type	initial value	external access	description
threshold	double	0.0	read	Current threshold that needs to be crossed
mean	double	0.0	read	Current signal mean. Same unit as input signal.
deviation	double	0.0	read	Current signal deviation. Same unit as input signal.