VARFilter#

class myoverse.datasets.filters.temporal.VARFilter(input_is_chunked, is_output=False, name=None, run_checks=True, *, window_size, shift=1)[source]#

Filter that computes the variance [1] of the input array.

Variance is the average of the squared differences from the mean. It is a measure of the spread of the signal.

\[\text{VAR} = \frac{1}{N} \sum_{i=1}^{N} (x_i - \mu)^2\]
Parameters:
  • input_is_chunked (bool) – Whether the input is chunked or not.

  • is_output (bool) – Whether the filter is an output filter.

  • name (str | None) – Name of the filter, by default None.

  • run_checks (bool) –

    Whether to run the checks when filtering. By default, True. If False can potentially speed up performance.

    Warning

    If False, the user is responsible for ensuring that the input array is valid.

  • window_size (int) – The window size to use.

  • shift (int) – The shift to use. Default is 1.

References

Methods

__init__(input_is_chunked[, is_output, ...])