data.download_edges_volume

data.download_edges_volume(
    local_path,
    label='2026_W42',
    project=None,
    res_um=None,
    one=None,
    overwrite=False,
)

Download the ephys edges volume of an encoding volume vintage from AWS S3.

The edges volume is the local gradient of the encoding volume (see :mod:ephysatlas.edges), stored as a .npz file with the encoding volume’s conventions: ephys_atlas_vol of shape (nx, ny, nz, 1), 0 outside the brain mask.

Parameters

Name	Type	Description	Default
local_path	Path	Local directory where the file will be saved.	required
label	str	Vintage label, e.g. “2026_W42”. Defaults to “2026_W42”.	'2026_W42'
project	str	Project name. Defaults to “ea_active”.	None
res_um	int	CCF voxel resolution in µm. If not specified, picks the finest resolution available on S3 for this project/label.	None
one	ONE	ONE client instance for AWS authentication.	None
overwrite	bool	Force re-download even if the file already exists. Defaults to False.	False

Returns

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