dspk-synapse 0.0.5

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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

//! Neural-recording formats (NWB, SpikeGLX, mtscomp), spike-sorting files (Phy / Kilosort, NWB
//! units, `.sorting.zarr`), probe geometry, and synthetic recordings, on top of `dspk-io`
//! (host-side: no device needed).
//!
//! [`open`], [`detect`], [`sources`] and [`open_source`] know every format of `dspk-io` plus the
//! neural ones ([`formats`]); `dspk_io::open` knows only the generic ones.

use std::path::Path;

use dspk_core::{DspResult, RecordingSource};
use dspk_io::{Format, SourceEntry};

pub mod mtscomp;
pub mod nwb;
pub mod phy;
pub mod probe;
mod sorting_format;
pub mod sorting_zarr;
pub mod spikeglx;
pub mod synthetic;
pub mod templates;

pub use mtscomp::MtscompRecording;
pub use nwb::NwbZarrRecording;
pub use probe::{probe_of, Position3D, SensorLayout, SensorSite};
pub use sorting_format::{detect_sorting, SortingFormat};
pub use spikeglx::SpikeGlxMeta;
pub use synthetic::{SyntheticParams, SyntheticRecording};

static FORMATS: &[&dyn Format] = &[
    // NWB before generic Zarr: an NWB store is also a Zarr store
    &nwb::Nwb,
    &dspk_io::generic::zarr_traces::ZarrTraces,
    // SpikeGLX before mtscomp: a SpikeGLX `.cbin` is read with its `.meta`
    &spikeglx::SpikeGlx,
    &mtscomp::Mtscomp,
    &dspk_io::generic::raw::Raw,
];

/// Every compiled-in format, neural and generic, in detection order.
pub fn formats() -> &'static [&'static dyn Format] {
    FORMATS
}

/// The format of `path` among [`formats`].
pub fn detect(path: &Path) -> DspResult<&'static dyn Format> {
    dspk_io::core::detect_in(formats(), path)
}

/// Opens the default source of `path` (see [`Format::open_default`]).
pub fn open(path: &Path) -> DspResult<Box<dyn RecordingSource>> {
    detect(path)?.open_default(path)
}

/// Every source of `path`, from metadata only.
pub fn sources(path: &Path) -> DspResult<Vec<SourceEntry>> {
    detect(path)?.sources(path)
}

/// Opens source `id` of `path` (an id from [`sources`]).
pub fn open_source(path: &Path, id: &str) -> DspResult<Box<dyn RecordingSource>> {
    detect(path)?.open(path, id)
}