Struct SubBandLine 

pub struct SubBandLine { /* private fields */ }

The instantaneous frequency of the 20 to 200 Hz band of a segment, with the envelope of that band.

Implementations

impl SubBandLine

pub fn of( segment: &[f64], rate: SampleRate, start: Seconds, ) -> Result<Self, FilterError>

Builds the line of segment, whose first sample lies start into the stem.

The analytic signal is meant for note-sized segments. Each cut end carries an error that decays with the distance from it, so a caller keeps a margin of silence or signal around the span it reads.

Errors

Returns a FilterError when the rate puts 200 Hz at or above the Nyquist frequency.

pub fn with_low_edge( segment: &[f64], rate: SampleRate, start: Seconds, lo: Hz, ) -> Result<Self, FilterError>

Builds the line as Self::of does, with the high-pass at lo.

Errors

Returns a FilterError when lo is not above 0 Hz or the rate puts 200 Hz at or above the Nyquist frequency.

pub fn with_edges( segment: &[f64], rate: SampleRate, start: Seconds, lo: Hz, hi: Hz, ) -> Result<Self, FilterError>

Builds the line as Self::of does, with the high-pass at lo and the low-pass at hi.

Errors

Returns a FilterError when an edge is not above 0 Hz or the rate puts hi at or above the Nyquist frequency.

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

Returns the frequency between samples n and n + 1, in hertz. A value can be negative where the band holds no signal.

pub fn sample_rate(&self) -> SampleRate

Returns the rate of the segment.

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

Returns the envelope of the band, one value per sample.

pub fn time_of(&self, n: usize) -> Seconds

Returns the time of frequency value n: halfway between samples n and n + 1.

pub fn sample_time(&self, n: usize) -> Seconds

Returns the time of sample n.

pub fn index_at(&self, time: Seconds) -> usize

Returns the index of the first sample at or after time.

Trait Implementations

impl Clone for SubBandLine

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 SubBandLine

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

Formats the value using the given formatter.

impl PartialEq for SubBandLine

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SubBandLine