dspk-synapse 0.0.7

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

//! Which sorting file format a path holds.

use std::path::Path;

use crate::io::phy::PhyFolder;
use crate::io::{nwb::NwbUnitsTable, sorting_zarr::SortingZarr};

/// Spike-sorting file formats.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SortingFormat {
    /// Phy / Kilosort folder of `.npy` arrays and `.tsv` tables.
    Phy,
    /// dspk `.sorting.zarr` store.
    SortingZarr,
    /// NWB `/units` table in a `.nwb.zarr` store.
    NwbUnits,
}

impl SortingFormat {
    /// The format a path's name implies: `.nwb.zarr` → NWB units, other `.zarr` → `.sorting.zarr`,
    /// anything else → Phy (the format to write when none is asked for).
    pub fn from_path_name(path: &Path) -> Self {
        let name = path.to_string_lossy();
        if name.ends_with(".nwb.zarr") {
            Self::NwbUnits
        } else if name.ends_with(".zarr") {
            Self::SortingZarr
        } else {
            Self::Phy
        }
    }
}

/// The format of the sorting at `path`, from its contents, else from its name
/// ([`SortingFormat::from_path_name`]).
pub fn detect_sorting(path: &Path) -> SortingFormat {
    if PhyFolder::is_phy_folder(path) {
        return SortingFormat::Phy;
    }
    {
        if NwbUnitsTable::is_units_table(path) {
            return SortingFormat::NwbUnits;
        }
        if SortingZarr::is_sorting_zarr(path) {
            return SortingFormat::SortingZarr;
        }
    }
    SortingFormat::from_path_name(path)
}