edges.compute_edges_volume

edges.compute_edges_volume(
    volume_file,
    out_file=None,
    atlas=None,
    sigma_um=DEFAULT_SIGMA_UM,
    erode_um=DEFAULT_ERODE_UM,
    variance_threshold=DEFAULT_VARIANCE_THRESHOLD,
    exclude_acronyms=DEFAULT_EXCLUDE_ACRONYMS,
    aggregate=DEFAULT_AGGREGATE,
)

Encoding volume file -> edges volume file, next to it.

Parameters

Name	Type	Description	Default
volume_file	str or Path	Encoding volume `.npz`.	required
out_file	str or Path	Output file. Defaults to `brainwide_ephys_edges_{res_um}um.npz` in the folder of `volume_file`.	`None`
atlas		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`
sigma_um		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`
erode_um		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`
variance_threshold		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`
exclude_acronyms		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`
aggregate		See :func:`load_whitened_pcs` and :func:`edge_strength`.	`None`

Returns

Name	Type	Description
	np.ndarray	(AP, ML, DV) float32 edge strength (`EDGES_UNITS` [aggregate]), NaN outside the mask.