Struct StreamingDetectionResult 

pub struct StreamingDetectionResult {
    pub channels: usize,
    pub total_samples: u64,
    pub sample_rate_hz: f64,
    pub halos: (u64, u64),
    pub channel_sigmas_uv: Vec<f32>,
    pub total_raw_crossings: u64,
    pub total_dedup_spikes: u64,
    pub channel_spike_counts: Vec<u64>,
    pub channel_templates: Vec<Option<WaveformTemplate>>,
    pub spikes: Vec<DeduplicatedSpike>,
    pub spike_locations_um: Vec<[f32; 3]>,
}

Result of running out-of-core threshold spike sorting over a recording.

Fields

channels: usize

Number of channels in the recording.

total_samples: u64

Total samples processed across the recording.

sample_rate_hz: f64

Sampling rate in Hz.

halos: (u64, u64)

Computed (left_halo, right_halo) in samples used during chunked streaming.

channel_sigmas_uv: Vec<f32>

Calibrated Quiroga MAD noise floor ($\sigma_n$ in $\mu\text{V}$) per channel.

total_raw_crossings: u64

Total raw threshold crossings across all channels before spatial deduplication.

total_dedup_spikes: u64

Total spatially deduplicated spikes across the recording.

channel_spike_counts: Vec<u64>

Deduplicated spike count per primary channel.

channel_templates: Vec<Option<WaveformTemplate>>

Online Welford-accumulated waveform template (mean $\pm$ std) per primary channel.

spikes: Vec<DeduplicatedSpike>

Deduplicated spike events with global sample_index across the recording.

spike_locations_um: Vec<[f32; 3]>

Location of each spike of spikes (µm, centre of mass over its K neighbours); empty when not located (StreamingDetectionConfig::locate).

Implementations

impl StreamingDetectionResult

pub fn to_sorting_output( &self, sorter_name: impl Into<String>, probe: Option<SensorLayout>, ) -> SortingOutput

This result as a SortingOutput with one unit per primary channel that has spikes (a channel-level summary, not a spike sorting: unit metrics describe channels).

Trait Implementations

impl Clone for StreamingDetectionResult

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 StreamingDetectionResult

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

Formats the value using the given formatter.