ibl-neuropixel
Collection of tools to handle Neuropixel 1.0 and 2.0 data (documentation coming soon...)
Installation
Minimum Python version supported is 3.10
uv pip install ibl-neuropixel
Destriping
Getting started
Compress a binary file losslessly using mtscomp
The mtscomp util implements fast chunked compression for neurophysiology data in a single shard. Package repository is here.
from pathlib import Path
import spikeglx
file_spikeglx = Path('/datadisk/neuropixel/file.imec0.ap.bin')
sr = spikeglx.Reader(file_spikeglx)
sr.compress_file()
# note: you can use sr.compress_file(keep_original=False) to also remove the orginal bin file
Reading raw spikeglx file and manipulating arrays
The mtscomp util implements fast chunked compression for neurophysiology data in a single shard. Package repository is here.
from pathlib import Path
import spikeglx
import ibldsp.voltage
file_spikeglx = Path('/datadisk/Data/neuropixel/human/Pt01.imec0.ap.bin')
sr = spikeglx.Reader(file_spikeglx)
# reads in 300ms of data
raw = sr[10_300_000:10_310_000, :sr.nc - sr.nsync].T
destripe = ibldsp.voltage.destripe(raw, fs=sr.fs, neuropixel_version=1)
# display with matplotlib backend
import ibldsp.plots
ibldsp.plots.voltageshow(raw, fs=sr.fs, title='raw')
ibldsp.plots.voltageshow(destripe, fs=sr.fs, title='destripe')
# display with QT backend
from viewephys.gui import viewephys
eqc = {}
eqc['raw'] = viewephys(raw, fs=sr.fs, title='raw')
eqc['destripe'] = viewephys(destripe, fs=sr.fs, title='destripe')
Destripe a binary file
This relies on a fast fourier transform external library: pip install pyfftw.
Minimal working example to destripe a neuropixel binary file.
from pathlib import Path
from ibldsp.voltage import decompress_destripe_cbin
sr_file = Path('/datadisk/Data/spike_sorting/pykilosort_tests/imec_385_100s.ap.bin')
out_file = Path('/datadisk/scratch/imec_385_100s.ap.bin')
decompress_destripe_cbin(sr_file=sr_file, output_file=out_file, nprocesses=8)
Viewer
The best way to look at the results is to use viewephys, open an ephys viewer on the raw data.
- tick the destripe box.
- move to a desired location in the file
- ctr+P will make the gain and axis the same on both windows
You can then move within the raw data file.
White Paper
The following describes the methods implemented in this repository. https://doi.org/10.6084/m9.figshare.19705522
Contribution
Please see our contribution guidelines for details on how to contribute to this project.
Release files for ibl-neuropixel 1.13.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ibl_neuropixel-1.13.0.tar.gz | 354.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ibl_neuropixel-1.13.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 465.3 kB
Release files / ibl_neuropixel-1.13.0.tar.gz
| Download URL | ibl_neuropixel-1.13.0.tar.gz |
|---|---|
| Size | 354.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f21487ae207ad862e090c99e3b4f044ce97fffd4fac84a950e9bcd6cde1dd551
|
|
BLAKE2b-256 checksum How to use checksums |
8b2d7136bbdf06e8618edb1a4aa3bae8def03646a0afdcaf9b052c0ff4e6b094
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / ibl_neuropixel-1.13.0-py3-none-any.whl
| Download URL | ibl_neuropixel-1.13.0-py3-none-any.whl |
|---|---|
| Size | 110.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
672426d89d7d377544dd32f6746fde00e9701b9070b9eae9a861df252e92c5d4
|
|
BLAKE2b-256 checksum How to use checksums |
e871bbe987d6ec34db5cfca17327c43bb98fb19de818904eb4540055098114d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
