Skip to main content

Crate openreadout_plexon

Crate openreadout_plexon 

Source
Expand description

Reader for Plexon PLX (“Plexon 1”) and PL2 electrophysiology recordings.

Layout and vocabulary: docs/formats/plexon.md. Provenance: docs/provenance/plexon.md (PLX from Neo, BSD-3, read as documentation; PL2 from hex dumps of corpus files only — Plexon’s own PL2 reader is a DLL that is neither opened nor run). Continuous channels are traces (channels sampled on one grid share a trace; recording pauses split sweeps); spike waveforms and events are tables.

§Example

Every reader implements openreadout_core::FormatReader: descriptor says what it reads, sniff recognises a file from its first bytes, and open returns a openreadout_core::Dataset with a header-only info() summary and lazy data access.

use openreadout_core::FormatReader;
use openreadout_plexon::PlexonReader;

let format = PlexonReader.descriptor();
assert_eq!(format.id, openreadout_plexon::FORMAT_ID);
println!("{} ({}): .{}", format.name, format.family, format.extensions.join(", ."));

Reading a file:

use std::path::Path;

use openreadout_core::FormatReader;
use openreadout_plexon::PlexonReader;

let mut dataset = PlexonReader.open(Path::new("session.plx"))?;
let info = dataset.info()?;
for t in &info.traces {
    println!("trace {}: {} channel(s) at {} Hz", t.index, t.channels.len(), t.sample_rate_hz);
}
// The first 100 spikes: time, channel, unit and waveform samples in mV.
let spikes = dataset.read_table(0, 0, 100)?;
println!("{} spike rows", spikes.columns[0].len());

Applications that accept any instrument file usually register every reader in an openreadout_core::Registry and let it detect the format; that is what the openreadout command-line tool does.

§API stability

The supported API is what this page documents. The parser modules are public only so that tests and fuzz targets can reach them: they are hidden from this documentation and may change in any release.

Structs§

PlexonReader
The Plexon reader.

Constants§

EXTENSIONS
Extensions this reader opens.
FORMAT_ID
Format id used on the command line and in JSON.