Skip to main content

Crate dspk_io

Crate dspk_io 

Source
Expand description

Recording file formats for dspk.

Every format implements dspk_core::RecordingSource, so callers read bounded chunks of any recording without knowing how it is stored, and Format, so open can pick the reader from the path (registry::formats).

  • core: the Format trait, detection and opening, source listing, chunk cache. Out-of-core window streaming is dspk_core::WindowLoader.
  • container: storage containers shared by every format (binary codecs, …).
  • generic: domain-independent recording formats (raw binary, Zarr /traces).

Neural-recording formats (NWB, SpikeGLX, mtscomp, Phy, probes) live in dspk-synapse (dspk_synapse::io).

Re-exports§

pub use crate::core::default_source;
pub use crate::core::detect;
pub use crate::core::open;
pub use crate::core::open_source;
pub use crate::core::sources;
pub use crate::core::sources;
pub use crate::core::CachedRecording;
pub use crate::core::Format;
pub use crate::core::MergeInput;
pub use crate::core::MergedRecording;
pub use crate::core::SourceEntry;
pub use crate::core::SourceKind;
pub use generic::raw::write_raw;
pub use generic::raw::RawParams;
pub use generic::raw::RawRecording;
pub use generic::zarr_traces::write_zarr;
pub use generic::zarr_traces::ZarrCompression;
pub use generic::zarr_traces::ZarrOptions;
pub use generic::zarr_traces::ZarrRecording;
pub use generic::zarr_traces::ZarrWriter;
pub use generic::zarr_traces::DEFAULT_PARALLEL_WRITES;
pub use generic::zarr_traces::DEFAULT_ZARR_COMPRESSION;
pub use channel_map::channel_map_toml;
pub use channel_map::parse_channel_map;
pub use channel_map::read_channel_map;
pub use registry::formats;

Modules§

channel_map
Channel map files (ChannelMap under [remap]), TOML or JSON by extension.
container
Storage containers shared by every format: how bytes are stored, independent of what they mean.
core
Format-independent entry points: the Format trait, detection and opening, source listing, and chunk caching.
generic
Domain-independent recording formats.
registry
Every compiled-in Format, in detection order.