BurstDetector¶
Detect population bursts using a threshold crossing algorithm.
port name |
data type |
slots |
description |
---|---|---|---|
mua |
MUAData |
1 |
Binned multi-unit activity in Hz (e.g. from MUAEstimator). |
port name |
data type |
slots |
description |
---|---|---|---|
events |
EventData |
1 |
A stream of ‘burst’ events. |
statistics |
MultiChannelData <double> |
1 |
A stream of nsamples-by-2 arrays with the signal test value (first column) and the threshold (second column). The number of samples in each statistics data packet is set by the statistics_buffer_size option. |
port name |
data type |
default |
description |
---|---|---|---|
threshold dev |
double |
6.0 |
for threshold multiplier. Same unit as signal standard deviations. |
smooth time |
double |
10.0 seconds |
Integration time for estimating signal statistics. Must be a positive number (sec). |
detection lockout time |
double |
30 ms |
refractory period after threshold crossing detection that is not considered for updating of statistics and for detecting events. Must greater than 0 ms. |
stream events |
bool |
True |
enable/disable burst event output |
stream statistics |
bool |
True |
enable/disable burst event output |
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. |
name |
data type |
initial value |
external access |
peers access |
description |
---|---|---|---|---|---|
threshold dev |
double |
6.0 |
write |
True |
for threshold multiplier. Same unit as signal standard deviations. |
detection 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. Must greater than 0 ms. |
stream events |
bool |
True |
write |
True |
enable/disable burst event output |
stream statistics |
bool |
True |
write |
True |
enable/disable burst event output |
smooth time |
double |
10.0 seconds |
write |
True |
Integration time for estimating signal statistics. Must be a positive number (sec). |
name |
data type |
initial value |
external access |
description |
---|---|---|---|---|
bin size |
None |
1.0 |
read |
None |