Enum spectrum_analyzer::FrequencyLimit

pub enum FrequencyLimit {
    All,
    Min(f32),
    Max(f32),
    Range(f32, f32),
}

Can be used to specify a desired frequency limit. If you know that you only need frequencies f <= 1000Hz, 1000 <= f <= 6777, or 10000 <= f, then this can help you to accelerate overall computation speed and memory usage.

Please note that due to frequency inaccuracies the FFT result may not contain a value for 1000Hz but for 998.76Hz!

Variants

All

Interested in all frequencies. [0, sampling_rate/2] (Nyquist theorem). Semantically equivalent to “None” limit at all).

Min(f32)

Only interested in frequencies Frequency <= x. Limit is inclusive. Supported values are 0 <= x <= Nyquist-Frequency.

Max(f32)

Only interested in frequencies x <= Frequency. Limit is inclusive. Supported values are 0 <= x <= N.

Range(f32, f32)

Only interested in frequencies 1000 <= f <= 6777 for example. Both values are inclusive. The first value of the tuple is equivalent to FrequencyLimit::Min and the latter equivalent to FrequencyLimit::Max. Furthermore, the first value must not be bigger than the second value.

Implementations

impl FrequencyLimit

pub const fn maybe_min(&self) -> Option<f32>

Returns the minimum value, if any.

pub const fn maybe_max(&self) -> Option<f32>

Returns the maximum value, if any.

pub fn min(&self) -> f32

Returns the minimum value, panics if it’s none. Unwrapped version of Self::maybe_min.

pub fn max(&self) -> f32

Returns the minimum value, panics if it’s none. Unwrapped version of Self::maybe_max.

pub fn verify(
    &self,
    max_detectable_frequency: f32
) -> Result<(), FrequencyLimitError>

Verifies that the frequency limit has sane values and takes the maximum possible frequency into account.

Trait Implementations

impl Clone for FrequencyLimit

fn clone(&self) -> FrequencyLimit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyLimit

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

Formats the value using the given formatter.

impl Copy for FrequencyLimit