Struct Spectrogram 

pub struct Spectrogram { /* private fields */ }

A short-time Fourier transform (STFT) result.

Data layout: (num_channels, num_frames, num_freq_bins). Use channel for per-channel access and frame for per-frame access.

Frame times and frequency bins are derived from the sample rate, window size and hop size, so they always match the data.

Implementations

impl Spectrogram

pub fn raw_magnitude(&self) -> Array3<f64>

pub fn raw_magnitude_db(&self, floor_db: f64) -> Array3<f64>

pub fn amplitude_spectrum(&self) -> Array3<f64>

pub fn amplitude_spectrum_db(&self, floor_db: f64) -> Array3<f64>

pub fn power_spectrum(&self) -> Array3<f64>

pub fn power_spectrum_db(&self, floor_db: f64) -> Array3<f64>

pub fn power_spectral_density(&self) -> Array3<f64>

pub fn power_spectral_density_db(&self, floor_db: f64) -> Array3<f64>

impl Spectrogram

pub fn new( data: Array3<Complex64>, sample_rate: f64, window_size: usize, hop_size: usize, window_fn: WindowFn, ) -> Result<Self, SignalError>

Wrap STFT data, shape (num_channels, num_frames, num_freq_bins).

Frame f is centred at (f * hop_size + window_size / 2) / sample_rate seconds and bin k sits at k * sample_rate / window_size Hz. The data must have window_size / 2 + 1 bins, as a real FFT of that size gives. The calibration gains are computed from window_fn, the periodic window the frames were tapered with.

pub fn channel_label(&self, channel: usize) -> Option<&str>

pub fn set_channel_label(&mut self, channel: usize, label: Option<&str>)

pub fn num_channels(&self) -> usize

pub fn num_frames(&self) -> usize

pub fn num_freq_bins(&self) -> usize

pub fn sample_rate(&self) -> f64

pub fn window_size(&self) -> usize

pub fn hop_size(&self) -> usize

pub fn window_fn(&self) -> WindowFn

The window the frames were tapered with (its periodic form).

pub fn normalization(&self) -> SpectrogramNormalization

Calibration gains of window_fn at window_size samples.

pub fn frame_times(&self) -> CowArray<'_, f64, Ix1>

Center time of each STFT frame in seconds. Computed on each call; use frame_axis for single values.

pub fn frame_axis(&self) -> &XAxis

Frame time axis in seconds, without allocating.

pub fn freq_bins(&self) -> CowArray<'_, f64, Ix1>

Frequency bin centers in Hz. Computed on each call; use freq_axis for single values.

pub fn freq_axis(&self) -> &XAxis

Frequency axis in Hz, without allocating.

pub fn data(&self) -> ArrayView3<'_, Complex64>

Raw complex STFT data, shape (num_channels, num_frames, num_freq_bins).

pub fn channel(&self, ch: usize) -> ArrayView2<'_, Complex64>

Complex STFT data for a single channel, shape (num_frames, num_freq_bins).

pub fn frame(&self, t: usize) -> ArrayView2<'_, Complex64>

Complex STFT data for a single frame, shape (num_channels, num_freq_bins).

Trait Implementations

impl Clone for Spectrogram

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spectrogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spectrogram

Available on crate feature serde only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Spectrogram

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

Formats the value using the given formatter.

impl PartialEq for Spectrogram

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Spectrogram

Available on crate feature serde only.

Stored form: the data plus what cannot be derived from it. Frame times, frequency bins and calibration gains are rebuilt when reading, through Spectrogram::new.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Spectrogram