Struct spectrum_analyzer::FrequencySpectrum

pub struct FrequencySpectrum { /* fields omitted */ }

Convenient wrapper around the processed FFT result which describes each frequency and its value/amplitude in the analyzed slice of samples. It only consists of the frequencies which were desired, e.g. specified via crate::limit::FrequencyLimit when crate::samples_fft_to_spectrum was called.

Implementations

impl FrequencySpectrum

pub fn new(data: Vec<(Frequency, FrequencyValue)>) -> Self

Creates a new object. Calculates several metrics on top of the passed vector.

pub fn apply_total_scaling_fn(
    &self,
    total_scaling_fn: SpectrumTotalScaleFunctionFactory
)

Applies the function generated by total_scaling_fn to each element and updates min, max, etc. afterwards accordingly.

Parameters

• total_scaling_fn See crate::spectrum::SpectrumTotalScaleFunctionFactory.

pub fn average(&self) -> FrequencyValue

Getter for lazily evaluated average.

pub fn median(&self) -> FrequencyValue

Getter for lazily evaluated median.

pub fn max(&self) -> FrequencyValue

Getter for lazily evaluated max.

pub fn min(&self) -> FrequencyValue

Getter for lazily evaluated min.

pub fn range(&self) -> FrequencyValue

[max()] - [min()]

pub fn data(&self) -> Ref<'_, Vec<(Frequency, FrequencyValue)>>

Getter for data.

pub fn to_map(
    &self,
    scale_fn: Option<&dyn Fn(f32) -> u32>
) -> BTreeMap<u32, f32>

Returns a BTreeMap. The key is of type u32. (f32 is not Ord, hence we can’t use it as key.) You can optionally specify a scale function, e.g. multiply all frequencies with 1000 for better accuracy when represented as unsigned integer.

Parameters

• scale_fn optional scale function, e.g. multiply all frequencies with 1000 for better accuracy when represented as unsigned integer.

Return

New BTreeMap from frequency to frequency value.

Trait Implementations

impl Debug for FrequencySpectrum

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

Formats the value using the given formatter.