dspk-view 0.0.7

Preparing multi-channel signals for viewing: min/max envelopes and pyramids, local or remote
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

//! Preparing continuous multi-channel signals for viewing, wherever the viewer runs: a local
//! app next to the recording, or a remote viewer served over the network (dspk-stream carries
//! what this crate produces).
//!
//! - [`envelope`]: the min/max reduction (`[min, max]` per column keeps every spike peak visible
//!   at any zoom), on the host and (feature `device`, on by default with `wgpu`) on a CubeCL
//!   device.
//! - [`view`]: what a viewer asks for ([`View`]) and gets ([`Envelope`]), locally or remotely.
//! - [`pyramid`]: the min/max pyramid of a whole recording (in memory or in a file) and its
//!   background builder.
//! - [`signal`]: a signal as a viewer sees it ([`SignalBackend`]): [`LocalSignal`] (a recording
//!   and its pyramid in this process), or a remote session (dspk-stream) answering the same views.
//!
//! Rendering and UI belong to the app; transport to dspk-stream; file formats to dspk-io.

pub mod envelope;
pub mod pyramid;
pub mod signal;
pub mod view;
mod read;

pub use envelope::{min_max_decimate, min_max_decimate_into, Block, Columns};
#[cfg(feature = "device")]
pub use envelope::envelope_on_device;
pub use pyramid::{pyramid_path, OnProgress, Progress, Pyramid, PyramidBuilder, PyramidIdentity, FILE_BASE, MEMORY_BASE};
pub use signal::{LocalSignal, SignalBackend, FILE_PYRAMID_MIN_BYTES};
pub use view::{Envelope, View, RAW_BLOCK_VALUES};