dspk-synapse 0.0.9

Electrophysiology for dspk: recording and sorting formats, probes, spike detection, waveforms, features, clustering, localization, quality metrics, and the shared parts of the sorters
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

//! Probe geometry read from recording files, alongside (not inside) the recording.

use std::path::Path;

use dspk_core::DspResult;

use super::SensorLayout;
use dspk_io::core::Format;

/// A [`Format`] whose files can describe the probe a source was recorded with.
pub trait ProbeSource: Format {
    /// Geometry of source `id` of `path` (an id from [`Format::sources`]); `None` when the file
    /// has none for it.
    fn probe(&self, path: &Path, id: &str) -> DspResult<Option<SensorLayout>>;
}

/// Formats that implement [`ProbeSource`], in detection order.
static PROBE_SOURCES: &[&dyn ProbeSource] = &[&crate::io::spikeglx::SpikeGlx];

/// Probe geometry of source `id` of `path`; `None` when its format carries none. Sites are numbered
/// by the source's channels; apply [`SensorLayout::select_channels`] for a channel subset.
pub fn probe_of(path: &Path, id: &str) -> DspResult<Option<SensorLayout>> {
    match PROBE_SOURCES.iter().find(|f| f.detect(path)) {
        Some(f) => f.probe(path, id),
        None => Ok(None),
    }
}