dspk-app-core 0.0.8

DSP App core: the workbench for any multichannel signal (open, view, process, write) and the plugin interface the domain plugins (electrophysiology: dspk-app-synapse) extend
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
64
65
66
67
68
69
70
71
72
73

//! The workspaces of the title bar (Blender style): each is a stage of the work on the open
//! recording, with its own arrangement of views. Explore is built; the others say what they will
//! hold (Curation is parked in `.refactoring/dspk-app/` while the app is rewired).

use gpui_kit::assets::IconName;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Default, Serialize, Deserialize)]
pub enum Workspace {
    /// Traces, heatmaps, channels and the timeline: the entry point.
    #[default]
    Explore,
    Sorting,
    Pipeline,
    Curation,
    /// Charts across recordings, sortings and runs (what it holds: to be decided).
    Analytics,
}

impl Workspace {
    pub const ALL: [Workspace; 5] = [Workspace::Explore, Workspace::Sorting, Workspace::Pipeline, Workspace::Curation, Workspace::Analytics];

    pub fn title(self) -> &'static str {
        match self {
            Workspace::Explore => "Explore",
            Workspace::Sorting => "Sorting",
            Workspace::Pipeline => "Pipeline",
            Workspace::Curation => "Curation",
            Workspace::Analytics => "Analytics",
        }
    }

    /// One line for the tab's tooltip.
    pub fn hint(self) -> &'static str {
        match self {
            Workspace::Explore => "Look at the recording: traces, heatmaps, channels, timeline",
            Workspace::Sorting => "Run the installed sorters on the recording or a part of it, compare their units",
            Workspace::Pipeline => "The processing graph: recordings, operations, views and writes on a canvas",
            Workspace::Curation => "Judge a sorting: units, waveforms, features, correlograms; label and merge",
            Workspace::Analytics => "Charts across recordings, sortings and runs (coming)",
        }
    }

    /// What a workspace that is not built yet will hold.
    pub fn planned(self) -> Option<&'static str> {
        match self {
            Workspace::Explore => None,
            Workspace::Sorting => Some(
                "Choose the channels and the part of the recording to sort, the sorter and its parameters, \
                 then run it and follow its progress here.",
            ),
            Workspace::Pipeline => Some("Open a recording: its view's processing shows here as a chain of operators."),
            Workspace::Curation => Some(
                "Inspect and judge sorting results: clusters, waveforms, correlograms and amplitudes, \
                 with merges and splits recorded for the sorting files.",
            ),
            Workspace::Analytics => Some(
                "Charts across the session: recordings, sortings, metrics and runs side by side. \
                 What it shows is being designed.",
            ),
        }
    }

    pub fn icon(self) -> IconName {
        match self {
            Workspace::Explore => IconName::AudioWaveform,
            Workspace::Sorting => IconName::SlidersHorizontal,
            Workspace::Pipeline => IconName::Workflow,
            Workspace::Curation => IconName::Microscope,
            Workspace::Analytics => IconName::ChartPie,
        }
    }
}