Struct WaveformTemplate 

pub struct WaveformTemplate {
    pub channel_ids: Vec<usize>,
    pub num_channels: usize,
    pub num_samples: usize,
    pub count: usize,
    pub trough_index: usize,
    pub mean: Vec<f32>,
    pub std: Vec<f32>,
    pub se: Vec<f32>,
}

Mean action potential template, standard deviation (std), and standard error of the mean (se) across a cluster of waveforms.

Row r of mean / std / se (each num_samples long) belongs to recording channel channel_ids[r].

Fields

channel_ids: Vec<usize>

Recording channel of each row.

num_channels: usize

num_samples: usize

count: usize

Number of waveforms accumulated into this template (>= 1).

trough_index: usize

Sample of the deepest trough (minimum of mean over all rows).

mean: Vec<f32>

std: Vec<f32>

se: Vec<f32>

Standard Error of the Mean (SE = SD / sqrt(count)).

Implementations

impl WaveformTemplate

pub fn new( channel_ids: Vec<usize>, num_samples: usize, mean: Vec<f32>, std: Vec<f32>, ) -> Self

Builds a template; mean and std are [channel_ids.len(), num_samples].

pub fn with_count( channel_ids: Vec<usize>, num_samples: usize, count: usize, mean: Vec<f32>, std: Vec<f32>, ) -> Self

Builds a template with explicit waveform count, automatically computing se = std / sqrt(count).

pub fn row(&self, r: usize) -> &[f32]

Mean waveform of row r.

pub fn std_row(&self, r: usize) -> &[f32]

Standard deviation waveform of row r.

pub fn se_row(&self, r: usize) -> &[f32]

Standard error waveform of row r.

pub fn channel_row(&self, channel: usize) -> Option<&[f32]>

Mean waveform on recording channel channel, if the template covers it.

pub fn best_channel(&self) -> Option<usize>

Recording channel with the largest peak-to-peak swing in mean.

pub fn amplitude(&self) -> f32

Largest peak-to-peak swing across all channels in mean.

Trait Implementations

impl Clone for WaveformTemplate

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 WaveformTemplate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WaveformTemplate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WaveformTemplate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for WaveformTemplate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WaveformTemplate