time_stream.qc.SpikeCheck

class time_stream.qc.SpikeCheck(threshold)

Detect spikes by assessing differences with neighboring values.

Parameters:

threshold (float)

__init__(threshold)

Initialise spike detection check.

Parameters:

threshold (float) – The spike detection threshold.

Methods

__init__(threshold)	Initialise spike detection check.
apply(df, time_name, check_column[, ...])	Apply the QC check to the data.
available()	Return a sorted list of available registered keys.
expr(ctx, column)	Return the Polars expression for spike detection.
get(spec, **kwargs)	Resolve spec to an instance of Self:
register(register_cls)	A method used as a decorator for subclasses to add to the register by its name attribute.

Attributes

name