Type aliases

Type aliases used throughout the zarr-vectors API. All are defined in zarr_vectors.typing and re-exported from the top-level package.

Shared type aliases used throughout the zarr-vectors package.

These provide consistent typing across modules without importing heavy dependencies at type-check time.

zarr_vectors.typing.AggregationMethod

One of: ‘mean’, ‘sum’, ‘mode’, ‘count’, ‘min’, ‘max’.

zarr_vectors.typing.AttributeAggregation

Mapping from attribute name to aggregation method for coarsening.

alias of dict[str, str]

zarr_vectors.typing.BinCoords

Integer coordinates identifying a supervoxel bin, e.g. (0, 3, 7) for 3D. Bins are a finer spatial grid than chunks — multiple bins tile each chunk.

alias of tuple[int, …]

zarr_vectors.typing.BinRatio

Per-dimension integer fold-change of bin shape relative to level 0, e.g. (2, 2, 2) means the bin is 2× wider in each axis at this level.

alias of tuple[int, …]

zarr_vectors.typing.BinShape

Physical edge lengths of a supervoxel bin, e.g. (25.0, 25.0, 25.0). Must evenly divide the chunk shape in every dimension.

alias of tuple[float, …]

zarr_vectors.typing.BoundingBox

(min_corner, max_corner) arrays, each shape (D,).

alias of tuple[ndarray[tuple[Any, …], dtype[floating]], ndarray[tuple[Any, …], dtype[floating]]]

zarr_vectors.typing.ChunkCoords

Integer coordinates identifying a spatial chunk, e.g. (0, 1, 2) for 3D.

alias of tuple[int, …]

zarr_vectors.typing.ChunkShape

Physical size of a spatial chunk per dimension, e.g. (100.0, 100.0, 50.0).

alias of tuple[float, …]

zarr_vectors.typing.CrossChunkLink

A link (edge/face vertex pair) between vertices in different spatial chunks.

alias of tuple[tuple[tuple[int, …], int], tuple[tuple[int, …], int]]

zarr_vectors.typing.CrossChunkStrategy

One of: ‘boundary_deduplication’, ‘explicit_links’, ‘both’.

zarr_vectors.typing.Edges

(M, 2) array of edge endpoint indices.

alias of ndarray[tuple[Any, …], dtype[integer]]

zarr_vectors.typing.Faces

(F, L) array of face indices — L vertices per face (3=tri, 4=quad).

alias of ndarray[tuple[Any, …], dtype[integer]]

zarr_vectors.typing.FragmentIndex

Index of a fragment within a spatial chunk (0-based).

zarr_vectors.typing.FragmentRef

(chunk_coordinates, fragment_index).

Type:

Reference to a fragment

alias of tuple[tuple[int, …], int]

zarr_vectors.typing.GeometryType

One of: ‘point_cloud’, ‘line’, ‘polyline’, ‘streamline’, ‘skeleton’, ‘graph’, ‘mesh’.

zarr_vectors.typing.GroupID

Integer identifier for a group of objects (tract, cell type, region, …).

zarr_vectors.typing.LinksConvention

One of: ‘explicit’, ‘implicit_sequential’, ‘implicit_sequential_with_branches’.

zarr_vectors.typing.ObjectID

Integer identifier for an object (streamline, neuron, mesh, cell, …).

zarr_vectors.typing.ObjectIndexConvention

One of: ‘standard’, ‘identity’.

zarr_vectors.typing.ObjectManifest

Ordered list of fragment references composing one object.

alias of list[tuple[tuple[int, …], int]]

zarr_vectors.typing.ParentArray

(N,) array where parent[i] is the index of node i’s parent (-1 for root).

alias of ndarray[tuple[Any, …], dtype[integer]]

zarr_vectors.typing.Vertices

(N, D) array of vertex positions in D-dimensional space.

alias of ndarray[tuple[Any, …], dtype[floating]]

Reference table

Alias	Definition	Notes
ChunkShape	tuple[float, ...]	D-tuple of positive floats (physical units)
BinShape	tuple[float, ...]	D-tuple; must evenly divide ChunkShape
BinRatio	tuple[int, ...]	D-tuple of positive integers
ChunkCoords	tuple[int, ...]	D-tuple; chunk grid coordinate
BoundingBox	tuple[ndarray, ndarray]	(lo, hi) arrays of shape (D,)
CrossChunkLink	tuple[int, int]	(src_global_id, dst_global_id)
ObjectManifest	list[tuple[int, int]]	Ordered (chunk_flat, vg_flat) pairs
AttributeDict	dict[str, ndarray]	Named per-vertex or per-object attribute arrays
LevelConfig	TypedDict	bin_ratio, object_sparsity, sparsity_strategy
StorePath	str | zarr.storage.Store	Accepts local path, fsspec mapper, or MemoryStore