Skip to main content

data.read_lfp_features

data.read_lfp_features(
    path_project,
    pid,
    level='default',
    scale=0,
    bin_channels=1,
)

Open a decompressed LFP reader for one insertion from the merged HDF5 archive.

Parameters

Name Type Description Default
path_project Path Path to the project folder (parent of lfp_aggregates/). required
pid str Insertion ID; matches the top-level recording key in the merged HDF5 file. required
level (small, default, fine) Compression tier to read, matching the file downloaded by :func:download_lfp_features. Requires lfpack>=1.0.0 (format 2). Defaults to “default”. "small"
scale int Pyramidal resolution level to open, 0 = base full LFP rate. Defaults to 0. 0
bin_channels int Number of adjacent channels to sum together on every read. Defaults to 1 (no binning). 1

Returns

Name Type Description
lfpack.LFPackReader Drop-in spikeglx.Reader-like object; chunks are decompressed on demand. sr[0:2500, :] returns an (n_samples, n_channels) float32 array in volts.