ezmsg.baseproc.counter

Counter generator for sample counting and timing.

Classes

class Counter(*args, settings=None, **kwargs)

Bases: BaseClockDrivenUnit[CounterSettings, CounterTransformer]

Transforms clock ticks into monotonically increasing counter values as AxisArray.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs AxisArray.

Parameters:

settings (Settings | None)

SETTINGS

alias of CounterSettings

class CounterSettings(fs, n_time=None, mod=None)

Bases: ClockDrivenSettings

Settings for Counter and CounterTransformer.

Parameters:

• fs (float)

• n_time (int | None)

• mod (int | None)

mod: int | None = None

If set, counter values rollover at this modulus.

__init__(fs, n_time=None, mod=None)

Parameters:

• fs (float)

• n_time (int | None)

• mod (int | None)

Return type:

None

fs: float

Output sampling rate in Hz.

class CounterTransformer(*args, **kwargs)

Bases: BaseClockDrivenProducer[CounterSettings, CounterTransformerState]

Transforms clock ticks (LinearAxis) into AxisArray counter values.

Each clock tick produces a block of counter values. The block size is either fixed (n_time setting) or derived from the clock’s gain (fs * gain).

class CounterTransformerState

Bases: ClockDrivenState

State for CounterTransformer.

template: AxisArray | None = None

class CounterSettings(fs, n_time=None, mod=None)

Bases: ClockDrivenSettings

Settings for Counter and CounterTransformer.

Parameters:

• fs (float)

• n_time (int | None)

• mod (int | None)

mod: int | None = None

If set, counter values rollover at this modulus.

__init__(fs, n_time=None, mod=None)

Parameters:

• fs (float)

• n_time (int | None)

• mod (int | None)

Return type:

None

fs: float

Output sampling rate in Hz.

class CounterTransformerState

Bases: ClockDrivenState

State for CounterTransformer.

template: AxisArray | None = None

class CounterTransformer(*args, **kwargs)

Bases: BaseClockDrivenProducer[CounterSettings, CounterTransformerState]

Transforms clock ticks (LinearAxis) into AxisArray counter values.

Each clock tick produces a block of counter values. The block size is either fixed (n_time setting) or derived from the clock’s gain (fs * gain).

class Counter(*args, settings=None, **kwargs)

Bases: BaseClockDrivenUnit[CounterSettings, CounterTransformer]

Transforms clock ticks into monotonically increasing counter values as AxisArray.

Receives timing from INPUT_CLOCK (LinearAxis from Clock) and outputs AxisArray.

Parameters:

settings (Settings | None)

SETTINGS

alias of CounterSettings