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

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.3.0.tar.gz (11.0 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.3.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lfpack-0.3.0.tar.gz
Algorithm Hash digest
SHA256 7924c15ad9ee96adfc6702b4adc5b45068bb065e222fc2f9d946ee764e52776b
MD5 6316b51a80a607778f65db0eb79cc406
BLAKE2b-256 ae5e43c31419932483c757f58319cb3890652b9ea6f53ac24a2c1221f0ea5e73

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lfpack-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f04dc24ac4acaedb657fb9899ee79c7fc178ce14e70bbc33fbcf5fbbb2fde0d8
MD5 1b5a0d45672398876017cfd07812af60
BLAKE2b-256 caf73830e0c0c899f2200944c3eff47c80f03b0a36f9052d7502c9fe8ac83074

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.0

2 files

This release

0.3.0 This release

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