ezmsg.event.rate#

Count number of events in a given time window. Optionally, divide by window duration to get rate.

Functions

event_rate(bin_duration=0.05)[source]#
Parameters:

bin_duration (float)

Returns:

A primed generator object that yields an AxisArray object of event rates for every AxisArray of sparse events it receives via send.

Return type:

Generator[AxisArray, AxisArray, None]

Classes

class EventRate(*args, settings=None, **kwargs)[source]#

Bases: GenAxisArray

Parameters:

settings (Settings | None)

SETTINGS#

alias of EventRateSettings

construct_generator()[source]#
class EventRateSettings(bin_duration: float = 0.05)[source]#

Bases: Settings

Parameters:

bin_duration (float)

bin_duration: float = 0.05#
__init__(bin_duration=0.05)#
Parameters:

bin_duration (float)

Return type:

None

event_rate(bin_duration=0.05)[source]#
Parameters:

bin_duration (float)

Returns:

A primed generator object that yields an AxisArray object of event rates for every AxisArray of sparse events it receives via send.

Return type:

Generator[AxisArray, AxisArray, None]

class EventRateSettings(bin_duration: float = 0.05)[source]#

Bases: Settings

Parameters:

bin_duration (float)

bin_duration: float = 0.05#
__init__(bin_duration=0.05)#
Parameters:

bin_duration (float)

Return type:

None

class EventRate(*args, settings=None, **kwargs)[source]#

Bases: GenAxisArray

Parameters:

settings (Settings | None)

SETTINGS#

alias of EventRateSettings

construct_generator()[source]#