TimeFrequencyMap

Struct TimeFrequencyMap 

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

Power laid out as channel × frequency × time.

Implementations§

Source§

impl TimeFrequencyMap

Source

pub fn new( power: Array3<f64>, frequencies_hz: Vec<f64>, times_s: Vec<f64>, labels: Vec<String>, ) -> Result<Self, MethodError>

Source

pub fn power(&self) -> ArrayView3<'_, f64>

Source

pub fn frequencies_hz(&self) -> &[f64]

Source

pub fn times_s(&self) -> &[f64]

Source

pub fn labels(&self) -> &[String]

Source

pub fn with_sampling_rate( self, sampling_rate: SamplingRate, ) -> Result<Self, MethodError>

Set when there is one time column per sample at i / fs (CWT, Hilbert spectrum), which makes the map epochable. STFT frames are not per-sample and leave this unset.

Source

pub fn with_reliable(self, reliable: Array2<bool>) -> Result<Self, MethodError>

Frequency × time mask: false where edge effects make the value unreliable (for example inside a wavelet’s cone of influence).

Source

pub fn sampling_rate(&self) -> Option<SamplingRate>

Source

pub fn reliable(&self) -> Option<ArrayView2<'_, bool>>

Trait Implementations§

Source§

impl Clone for TimeFrequencyMap

Source§

fn clone(&self) -> TimeFrequencyMap

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TimeFrequencyMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for TimeFrequencyMap

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for TimeFrequencyMap

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.