RMSFilter#
- class myoverse.datasets.filters.temporal.RMSFilter(input_is_chunked, is_output=False, name=None, run_checks=True, *, window_size, shift=1, stabilization_factor=np.float64(2.220446049250313e-16))[source]#
Filter that computes the root mean squared value [1] of the input array.
Root mean squared value is the square root of the mean of the squared values of the input array. It is a measure of the magnitude of the signal.
\[\text{RMS} = \sqrt{\frac{1}{N} \sum_{i=1}^{N} 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.
stabilization_factor (float) – A small value to add to the squared values before taking the mean to stabilize the computation. By default, this is the machine epsilon for float values. See numpy.finfo(float).eps.
References
Methods
__init__(input_is_chunked[, is_output, ...])