Skip to content

Repository files navigation

lfpack — LFP codec for Neuropixels recordings

lfpack logo

Lossy codec for local-field-potential (LFP) recordings from Neuropixels probes. Achieves >100× compression with median RMSE < 25 µV via an 8-stage pipeline (bad-channel detection → dephasing → highpass → interpolation → CAR → decimation → Cadzow → adaptive SVD + wavelet-packet thresholding).

IBL Brain-Wide Map LFP dataset — 699 recordings, 384 channels, session-clock aligned. How to access →

pip install lfpack

Visualise with viewephys

viewephys opens lfpack .h5 files natively — viewephys -f recording.h5 gets you a browsable, brain-region-coloured view with no manual decompression step:

viewephys opened directly on a lfpack HDF5 file, showing brain-region-coloured LFP traces

See the BWM how-to for details.

Documentation

Full documentation is at https://int-brain-lab.github.io/lfpack/.

Section Contents
Tutorial End-to-end compression and decompression of a recording
How-To: binned reads Memory-efficient channel-binned access
How-To: multi-recording files Combining multiple recordings in one HDF5 file
API reference Full public API (compress_bin_to_h5, LFPackReader, …)
HDF5 format On-disk layout specification
Pipeline explanation Stage-by-stage description of the compression pipeline
SVD+WP benchmark RMSE, SNR, and compression-ratio results across 11 insertions

Help and Feedback

Have a question, found an issue, or want to share feedback? Please open an issue on GitHub. We welcome bug reports, questions, suggestions, and other feedback.

About

LFP compression for Neuropixels recordings

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages