Skip to main content

GpuSpectrogram

Struct GpuSpectrogram 

Source
pub struct GpuSpectrogram { /* private fields */ }
Expand description

GPU-accelerated (or CPU-fallback) spectrogram computer.

§Example

use scirs2_signal::gpu_spectrograms::{GpuSpectrogram, GpuSpectrogramConfig};
use scirs2_core::ndarray::ArrayView1;

let config = GpuSpectrogramConfig::default();
let sg = GpuSpectrogram::new(config).expect("config is valid");

// 4096-sample sine wave at normalised frequency 0.1
let signal: Vec<f32> = (0..4096)
    .map(|i| (2.0 * std::f32::consts::PI * 0.1 * i as f32).sin())
    .collect();

let mag = sg.compute(ArrayView1::from(&signal)).expect("compute ok");
println!("spectrogram shape: {:?}", mag.dim());

Implementations§

Source§

impl GpuSpectrogram

Source

pub fn new(config: GpuSpectrogramConfig) -> Result<Self, GpuSpectrogramError>

Construct a new spectrogram computer from the given configuration.

§Errors

Returns GpuSpectrogramError::InvalidFftSize when fft_size is not a power of two or is zero.

Source

pub fn compute( &self, signal: ArrayView1<'_, f32>, ) -> Result<Array2<f32>, GpuSpectrogramError>

Compute the magnitude spectrogram of signal.

Returns an Array2<f32> of shape [n_frames, fft_size / 2 + 1]. Each row is the single-sided magnitude spectrum of one analysis frame.

§Errors

Returns GpuSpectrogramError::SignalTooShort when signal is shorter than one FFT frame.

Source

pub fn compute_power( &self, signal: ArrayView1<'_, f32>, ) -> Result<Array2<f32>, GpuSpectrogramError>

Compute the power spectrogram (magnitude squared) of signal.

Returns an Array2<f32> of shape [n_frames, fft_size / 2 + 1].

Source

pub fn compute_batch( &self, signals: &[Vec<f32>], ) -> Result<Vec<Array2<f32>>, GpuSpectrogramError>

Compute spectrograms for a batch of signals.

Each element of signals is processed independently. Returns a Vec of Array2 in the same order as the input slice.

§Errors

Propagates errors from the single-signal GpuSpectrogram::compute call for each element.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V