Skip to main content

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lfpack-0.4.0.tar.gz (11.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lfpack-0.4.0-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file lfpack-0.4.0.tar.gz.

File metadata

  • Download URL: lfpack-0.4.0.tar.gz
  • Upload date:
  • Size: 11.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lfpack-0.4.0.tar.gz
Algorithm Hash digest
SHA256 de070d9bb0efd25e070e470fadc19a109bea0044375f7248a94f772d44285d65
MD5 259a30f1e314040e00bb51f0393fc807
BLAKE2b-256 4da2634f2e79595124473cc1e528620e739921c23fa9b5f245c4a1e06d47bfb6

See more details on using hashes here.

File details

Details for the file lfpack-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: lfpack-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lfpack-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1f06972f7c49d3545b5c29228ebe0ab89c5c58116e67b89aab89196a1a0c5f6f
MD5 c60a5e63f18f30815c110cd3434f7798
BLAKE2b-256 a9475199cbc9136ca102370e17e11472df697f7ddcce1ab728fd8096ffd66b33

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.0

2 files

0.1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page