compress_pipeline

compress_pipeline(
    data,
    h=None,
    epsilon=150.0,
    alpha=28.0,
    fs=250.0,
    cadzow_rank=5,
    cadzow_niter=1,
    cadzow_fmax=100.0,
)

Full LFP compression pipeline: Cadzow denoise → SVD-adapt → WP threshold.

Parameters

Name	Type	Description	Default
data	ndarray of shape (nc, ns), float32	Raw LFP data at fs Hz. Rows are channels, columns are time samples.	required
h	dict or None	Neuropixel probe header containing ‘x’ and ‘y’ channel coordinates. Defaults to the first nc channels of the NP1 (version 1) geometry. Pass neuropixel.trace_header(version=2) for NP2 probes.	None
epsilon	float	SVD-adapt threshold multiplier. Default 150.	150.0
alpha	float	WP threshold multiplier. Default 28.	28.0
fs	float	LFP sampling rate [Hz]. Default 250.	250.0
cadzow_rank	int	Spatial de-rank applied by the Cadzow denoiser. Default 5.	5
cadzow_niter	int	Number of Cadzow iterations. Default 1.	1
cadzow_fmax	float	Maximum frequency passed to the Cadzow denoiser [Hz]. Default 100.	100.0

Returns

Name	Type	Description
reconstructed	ndarray of shape (nc, ns), float32	Denoised and compressed–reconstructed LFP.
compressed	LFPCompressed	Compression metadata and per-stage compression ratios.