Struct SpectrogramParams 

pub struct SpectrogramParams { /* private fields */ }

Spectrogram computation parameters.

• stft: STFT parameters
• sample_rate_hz: Sample rate in Hz

Implementations

impl SpectrogramParams

pub fn new(stft: StftParams, sample_rate_hz: f64) -> SpectrogramResult<Self>

Create new spectrogram parameters.

Arguments

• stft - STFT parameters
• sample_rate_hz - Sample rate in Hz

Errors

Returns an error if the sample rate is not positive and finite.

Returns

A SpectrogramParams instance.

pub fn builder() -> SpectrogramParamsBuilder

Create a builder for spectrogram parameters.

Errors

Returns an error if required parameters are not set or are invalid.

Returns

A builder for SpectrogramParams.

Examples

use spectrograms::{SpectrogramParams, WindowType, nzu};

let params = SpectrogramParams::builder()
    .sample_rate(16000.0)
    .n_fft(nzu!(512))
    .hop_size(nzu!(256))
    .window(WindowType::Hanning)
    .centre(true)
    .build()?;

assert_eq!(params.sample_rate_hz(), 16000.0);

pub fn speech_default(sample_rate_hz: f64) -> SpectrogramResult<Self>

Create default parameters for speech processing.

Arguments

• sample_rate_hz - Sample rate in Hz

Returns

A SpectrogramParams instance with default settings for music analysis.

Errors

Returns an error if the sample rate is not positive and finite.

Uses:

• n_fft: 512 (32ms at 16kHz)
• hop_size: 160 (10ms at 16kHz)
• window: Hanning
• centre: true

pub fn music_default(sample_rate_hz: f64) -> SpectrogramResult<Self>

Create default parameters for music processing.

Arguments

• sample_rate_hz - Sample rate in Hz

Returns

A SpectrogramParams instance with default settings for music analysis.

Errors

Returns an error if the sample rate is not positive and finite.

Uses:

• n_fft: 2048 (46ms at 44.1kHz)
• hop_size: 512 (11.6ms at 44.1kHz)
• window: Hanning
• centre: true

pub const fn stft(&self) -> &StftParams

Get the STFT parameters.

pub const fn sample_rate_hz(&self) -> f64

Get the sample rate in Hz.

pub fn frame_period_seconds(&self) -> f64

Get the frame period in seconds.

pub fn nyquist_hz(&self) -> f64

Get the Nyquist frequency in Hz.

Trait Implementations

impl Clone for SpectrogramParams

fn clone(&self) -> SpectrogramParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpectrogramParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpectrogramParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SpectrogramParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SpectrogramParams