Struct SpecCompute

pub struct SpecCompute { /* private fields */ }

This contains all the initialised data. This can then produce the spectrogram, and if necessary, save it to the filesystem as a PNG image.

This Spectrograph is created by SpecOptionsBuilder.

Example

  let mut spectrograph = SpecOptionsBuilder::new(2048)
    .load_data_from_file(&std::path::Path::new(wav_file))?
    .build();

  // Compute the spectrogram.  Need export it using `to_png()` or simlar.
  spectrograph.compute();

Implementations

impl SpecCompute

pub fn new( num_bins: usize, step_size: usize, data: Vec<f32>, window_fn: WindowFn, ) -> Self

Create a new Spectrograph from data.

You probably want to use [SpecOptionsBuilder] instead.

pub fn set_data(&mut self, data: Vec<f32>)

Update the sample data with a new set. Note, none of the settings from the builder are applied, all the samples are used in their raw form.

pub fn compute(&mut self) -> Spectrogram

Do the discrete fourier transform to create the spectrogram.

Arguments

• n_fft - How many fourier transform frequency bins to use. Must be a power of 2.

pub fn par_compute(&self, data: Option<&[f32]>) -> Spectrogram

Do the discrete fourier transform to create the spectrogram.

This function will use rayon to parallelize the FFT computation. It may create more FFT plans than there are threads, but will reuse them if called multiple times.

Arguments

• self - self is immutable so that the FFT plans can be shared between threads. Since the FFT plans are not thread safe, they are wrapped in a Mutex.

• data - The time domain data to compute the spectrogram from. data is not preprocessed other than windowing and casting to complex.