Struct StreamingDetectionConfig 

pub struct StreamingDetectionConfig {

    pub batch_duration_sec: f64,
    pub calibration_duration_sec: f64,
    pub calibration_chunks: usize,
    pub threshold_factor: f32,
    pub refractory_ms: f64,
    pub polarity: SpikePolarity,
    pub distance_rule: DistanceRule,
    pub spatial_radius_um: f32,
    pub k_neighbors: usize,
    pub pre_ms: f64,
    pub post_ms: f64,
    pub apply_sinc_shift: bool,
    pub locate: bool,
}

Configuration for super::StreamingDetector.

Fields

batch_duration_sec: f64

Duration of each valid interior streaming batch in seconds (default: 10.0 s).

calibration_duration_sec: f64

Total duration of the noise-floor calibration in seconds (default: 5.0 s), split into calibration_chunks chunks spread evenly over the recording.

calibration_chunks: usize

Number of calibration chunks; σ per channel is the median of the per-chunk estimates (default: 5).

threshold_factor: f32

Threshold multiplier in units of Quiroga $\sigma_n$ (default: 5.0).

refractory_ms: f64

Refractory period in milliseconds (default: 1.0 ms).

polarity: SpikePolarity

Which extrema are spikes (default: negative troughs).

distance_rule: DistanceRule

How crossings nearer than the refractory period are resolved (default: DistanceRule::LocallyExclusive, for which streaming equals whole-recording detection; DistanceRule::Scipy can differ at batch edges).

spatial_radius_um: f32

Spatial deduplication radius in micrometers (default: 150.0 $\mu\text{m}$).

k_neighbors: usize

Number of $K$-nearest neighbor channels extracted per waveform snippet (default: 4).

pre_ms: f64

Pre-trough snippet window in milliseconds (default: 1.0 ms).

post_ms: f64

Post-trough snippet window in milliseconds (default: 2.0 ms).

apply_sinc_shift: bool

Whether to apply sub-sample windowed-sinc (Blackman-Harris) realignment (default: true).

locate: bool

Whether to locate every spike: the centre of mass of its snippet’s peak-to-peak heights over its K neighbours (default: true; else locations are unknown, NaN).

Implementations

impl StreamingDetectionConfig

pub fn threshold_detector(&self) -> ThresholdSpikeDetector

The threshold detector’s settings these detections use (factor, polarity, refractory period, spacing rule).

pub fn refractory_samples(&self, sample_rate: f64) -> usize

Refractory period in samples at sample_rate Hz.

pub fn pre_samples(&self, sample_rate: f64) -> usize

Pre-trough snippet length in samples at sample_rate Hz.

pub fn post_samples(&self, sample_rate: f64) -> usize

Post-trough snippet length in samples at sample_rate Hz.

pub fn snippet_samples(&self, sample_rate: f64) -> usize

Total snippet length (pre_samples + post_samples) at sample_rate Hz.

pub fn batch_samples(&self, sample_rate: f64) -> u64

Valid interior batch size in samples at sample_rate Hz.

pub fn detection_range( &self, sample_rate: f64, total_samples: u64, ) -> Range<u64>

Global sample range where spikes are detected: a full snippet plus the realignment margin fits inside the recording.

pub fn calibration_chunks( &self, sample_rate: f64, total_samples: u64, ) -> Vec<Range<u64>>

Calibration chunks: calibration_chunks ranges totalling calibration_duration_sec, spread evenly across 0..total_samples (fewer / shorter for short recordings).

pub fn compute_halos( &self, sample_rate: f64, pipeline: &Pipeline, ) -> DspResult<(u64, u64)>

Computes the required (left_halo, right_halo) in samples at sample_rate Hz given the filter stages in pipeline:

• left_halo = settling_left + pre_samples(fs) + refractory_samples(fs) + SINC_RESAMPLE_MARGIN
• right_halo = settling_right + post_samples(fs) + refractory_samples(fs) + SINC_RESAMPLE_MARGIN

where (settling_left, settling_right) = pipeline.settling(fs) (forward-backward filters need both sides).

Errors

DspError::InvalidConfig when a filter stage’s design is invalid at sample_rate.

Trait Implementations

impl Clone for StreamingDetectionConfig

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 StreamingDetectionConfig

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

Formats the value using the given formatter.

impl Default for StreamingDetectionConfig

fn default() -> Self

Returns the “default value” for a type.