SSCFilter

class myoverse.datasets.filters.temporal.SSCFilter(input_is_chunked, is_output=False, name=None, run_checks=True, *, window_size, shift=1)

Computes the slope sign change [1] of the input array.

Slope sign change is the number of times the slope of the signal changes sign. It is a measure of the number of times the signal changes direction.

\[\text{SSC} = \sum_{i=1}^{N} \frac{1}{2} |\text{sign}(x_i - x_{i-1}) - \text{sign}(x_{i-1} - x_{i-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

[1]

https://doi.org/10.1080/10255842.2023.2165068

Methods

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