Function reference
Compression
Compress LFP recordings to HDF5.
| compress_bin_to_h5 | Full pipeline: raw LFP binary → decimate → Cadzow denoise → SVD+WP compress → HDF5. |
| compress_to_h5 | Compress a decimated (ns, nc) .npy into a format-2 HDF5 archive, chunk by chunk. |
| compress_pipeline | Full LFP compression pipeline: Cadzow denoise → SVD-adapt → WP threshold. |
| compress | Compress an LFP snippet using adaptive SVD and wavelet-packet thresholding. |
| decompress | Reconstruct LFP data from a compressed representation. |
| run_cadzow_checkpoint | Cadzow-denoise a decimated LFP array in overlapping chunks and save a contiguous checkpoint. |
| cadzow_lfp_kwargs | Cadzow LFP settings for a probe geometry: the defaults of the ibldsp NP1 or NP2 entry point. |
Data types
Core data structures.
| LFPCompressed | Compressed representation of an (nc, ns) LFP matrix. |
Reader
Random-access decompression.
| LFPackReader | Drop-in spikeglx.Reader for HDF5-packed LFP-compressed files. |
Multi-recording archives
Combine, subset or upgrade archives without re-compressing.
| merge_h5 | Merge multiple per-recording HDF5 files into one multi-recording archive. |
| subset_h5 | Copy a subset of recordings out of a multi-recording HDF5 archive. |
| upgrade_h5 | Rewrite a format-1 archive in format 2, without re-compressing. |
Sync
Piecewise sample-to-time knots on a scale’s meta group.
| write_sync_attrs | Write ALF sync knots plus a derived affine summary to a meta HDF5 group. |
| clear_sync_attrs | Delete all four sync entries (SYNC_ATTRS) from a meta HDF5 group. |