Struct StftParams 

pub struct StftParams { /* private fields */ }

STFT parameters for spectrogram computation.

• n_fft: Size of the FFT window.
• hop_size: Number of samples between successive frames.
• window: Window function to apply to each frame.
• centre: Whether to pad the input signal so that frames are centered.

Implementations

impl StftParams

pub fn new( n_fft: NonZeroUsize, hop_size: NonZeroUsize, window: WindowType, centre: bool, ) -> SpectrogramResult<Self>

Create new STFT parameters.

Arguments

• n_fft - Size of the FFT window
• hop_size - Number of samples between successive frames
• window - Window function to apply to each frame
• centre - Whether to pad the input signal so that frames are centered

Errors

Returns an error if:

• hop_size > n_fft
• Custom window size doesn’t match n_fft

Returns

New StftParams instance.

pub const fn n_fft(&self) -> NonZeroUsize

Get the FFT window size.

Returns

The FFT window size.

pub const fn hop_size(&self) -> NonZeroUsize

Get the hop size (samples between successive frames).

Returns

The hop size.

pub fn window(&self) -> WindowType

Get the window function.

Returns

The window function.

pub const fn centre(&self) -> bool

Get whether frames are centered (input signal is padded).

Returns

true if frames are centered, false otherwise.

pub fn builder() -> StftParamsBuilder

Create a builder for STFT parameters.

Returns

A StftParamsBuilder instance.

Examples

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

let stft = StftParams::builder()
    .n_fft(nzu!(2048))
    .hop_size(nzu!(512))
    .window(WindowType::Hanning)
    .centre(true)
    .build()?;

assert_eq!(stft.n_fft(), nzu!(2048));
assert_eq!(stft.hop_size(), nzu!(512));

Trait Implementations

impl Clone for StftParams

fn clone(&self) -> StftParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StftParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StftParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PyStftParams> for StftParams

fn from(val: PyStftParams) -> Self

Converts to this type from the input type.

impl From<StftParams> for PyStftParams

fn from(inner: StftParams) -> Self

Converts to this type from the input type.

impl PartialEq for StftParams

fn eq(&self, other: &StftParams) -> 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 Serialize for StftParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StftParams