Enum ApsMode 

pub enum ApsMode {
    AllAveraging {},
    ExponentialWeighting {
        tau: Flt,
    },
    Spectrogram {},
}

The ‘mode’ used in computing averaged power spectra. When providing data in blocks to the [AvPowerSpectra] the resulting ‘current estimate’ responds differently, depending on the model.

Variants

AllAveraging

Averaged over all data provided. New averages can be created by calling AvPowerSpectra::reset()

ExponentialWeighting

In this mode, the AvPowerSpectra works a bit like a sound level meter, where new data is weighted with old data, and old data exponentially backs off. This mode only makes sense when tau >> nfft/fs

Fields

tau: Flt

Time weighting constant, follows convention of Sound Level Meters. Means the data is approximately low-pass filtered with a cut-off frequency f_c of s/tau ≅ 1 → f_c = (2 * pi * tau)^-1.

Spectrogram

Spectrogram mode. Only returns the latest estimate(s).

Trait Implementations

impl Clone for ApsMode

fn clone(&self) -> ApsMode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApsMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ApsMode

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for ApsMode

type Target = ApsMode

The Python output type

type Output = Bound<'py, <ApsMode as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PartialEq for ApsMode

fn eq(&self, other: &ApsMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for ApsMode

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for ApsMode

type LayoutAsBase = PyClassObject<ApsMode>

type BaseNativeType = <ApsMode as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<ApsMode>

type PyClassMutability = <ApsMode as PyClassImpl>::PyClassMutability

impl PyClassImpl for ApsMode

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<ApsMode>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClass__eq__SlotFragment<ApsMode> for PyClassImplCollector<ApsMode>

unsafe fn __eq__( self, py: Python<'_>, _raw_slf: *mut PyObject, arg0: *mut PyObject, ) -> PyResult<*mut PyObject>

Safety: _slf and _other must be valid non-null Python objects

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a ApsMode

type Holder = Option<PyRef<'py, ApsMode>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<ApsMode> for PyClassImplCollector<ApsMode>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for ApsMode

const NAME: &'static str = "ApsMode"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Copy for ApsMode

impl StructuralPartialEq for ApsMode