time_stream.aggregation.PeaksOverThreshold

class time_stream.aggregation.PeaksOverThreshold(threshold)

Parameters:

threshold (int | float)

__init__(threshold)

Initialise Peaks Over Threshold aggregation.

Parameters:

threshold (int | float) – The threshold to count peaks over.

Methods

__init__(threshold)	Initialise Peaks Over Threshold aggregation.
available()	Return a sorted list of available registered keys.
expr(ctx, columns)	Return the Polars expression for calculating the conditional count in an aggregation period.
get(spec, **kwargs)	Resolve spec to an instance of Self:
post_expr(_ctx, _columns)	Return additional Polars expressions to be applied after the aggregation.
register(register_cls)	A method used as a decorator for subclasses to add to the register by its name attribute.

Attributes

name