edges.save_edges_volume

edges.save_edges_volume(file, edges, res_um, units, **metadata)

Save an edges volume in the encoding volume layout, as published on S3.

Readable like brainwide_ephys_atlas_{res_um}um.npz: a single-feature ephys_atlas_vol of shape (ML, AP, DV, 1) named ephys_edges in feature_names, plus grid_shape and res_um. Voxels outside the mask are 0, the encoding volume’s “no data” sentinel, and values are float16.

Parameters

Name	Type	Description	Default
file	str or Path	Output .npz file.	required
edges	np.ndarray	(AP, ML, DV) edge strength, NaN outside the mask.	required
res_um	int	Voxel size in um.	required
units	str	Units of edges, e.g. EDGES_UNITS["median"].	required
**metadata		Extra scalars stored alongside (aggregate, sigma_um, n_pcs…).	{}