Skip to main content

data.download_lfp_features

data.download_lfp_features(
    local_path,
    project='ibl_neuropixel_brainwide_01',
    one=None,
    overwrite=False,
    level='default',
)

Download the merged LFP-compressed HDF5 archive (lfpack v04) from AWS S3.

The archive is a single multi-recording HDF5 file (lfpack format 2, produced by lfpack.merge_h5) containing one top-level group per insertion (pid). Use :func:read_lfp_features to open a reader for a specific pid. Reading format 2 requires lfpack>=1.0.0.

Parameters

Name Type Description Default
local_path Path Local root; file is placed under local_path/project/lfp_aggregates/. required
project str Project name. Defaults to “ibl_neuropixel_brainwide_01”. 'ibl_neuropixel_brainwide_01'
one one.api.ONE ONE client instance for AWS authentication. None
overwrite bool Force re-download if the file already exists locally. Defaults to False. False
level (small, default, fine) Compression tier to download (epsilon=100; tiers differ only in alpha). “small” (alpha=14, ~11 GB, 0.57 % of float32) decodes like the former v03 “mild”; “default” (alpha=7, ~21.5 GB, 1.10 %); “fine” (alpha=2.5, ~46 GB, 2.35 %) is the closest to the raw LFP. The v03 levels “mild” and “aggressive” are removed and raise a ValueError. Defaults to “default”. "small"

Returns

Name Type Description
Path Local path to the downloaded HDF5 file.