Expand description
Read, write, and edit data stored in NeuroExplorer .nex and .nex5 files.
Modules§
- fixture_
paths - Paths to bundled and sibling-repo test recordings.
Structs§
- Continuous
Variable - Event
Variable - File
Data - In-memory representation of a .nex or .nex5 file, mirroring the Python
FileDataclass. - File
Data Builder - Builds a
FileDatawith a fluent API. - File
Data Diff - Summary of differences between two in-memory files.
- File
Metadata - File-level metadata block from a
.nex5file. - File
Write Plan - Interval
Variable - Marker
Variable - Neuron
Variable - Open
NexFile - An open
.nex/.nex5file with a cached handle for efficient lazy loading. - Population
Vector - Read
Options - Options controlling file read behavior.
- Reader
- Reads and parses NeuroExplorer
.nexand.nex5files. - Spike
Export Options - Options for spike export.
- Timestamp
Range - Range of timestamps to read from a spike/event variable.
- Timestamp
Stream - Callback-driven timestamp reader for one variable payload.
- Timestamps
- Spike/event timestamps stored as
f64or compactf32seconds. - Variable
Diff - Per-variable difference details.
- Variable
Metadata - Per-variable metadata entry inside the file JSON block.
- Variable
Write Plan - Prepared write headers for one variable (does not mutate
FileData). - Waveform
Variable - Waveform variable with flat sample storage (
count × n_pointsvalues, row-major). - Write
Options - Options controlling file write behavior.
- Writer
- Writes NeuroExplorer
.nexand.nex5files.
Enums§
- Marker
Field Value - NexError
- NexFile
VarType - Variable type constants matching NeuroExplorer .nex / .nex5 format.
- NexFormat
- On-disk format selector for
Reader::read_from_reader. - Spike
Export Format - Export format for spike timestamps.
- Variable
Constants§
Functions§
- ensure_
all_ payloads_ loaded - export_
spikes - Write spike timestamps for
var_nameto anyWritetarget. - export_
spikes_ to_ file - Write spike timestamps to a file.
- prepare_
nex5_ write_ plan - prepare_
nex_ write_ plan - read_
nex5_ file - Convenience function — read as
.nex5(or.nexif extension says so). - read_
nex_ file - Convenience function — read using file extension to pick format.
- spike_
export_ names - List neuron and event variable names suitable for spike export.
- validate_
timestamp_ range - Validate a timestamp range against a variable header.
- write_
nex5_ file - Convenience function — write as
.nex5(or.nexif extension says so). - write_
nex5_ file_ with_ options - Convenience function with custom write options.
- write_
nex_ file - Convenience function — write using file extension to pick format.