VoxelData
VoxelData is a small, modality-independent data model for spatially referenced voxel arrays, built on xarray.
A VoxelData array is an xarray.DataArray that is always:
- dimensioned
(*nonspatial_dims, k, j, i)— leading dimensions may appear in any order, including the optional temporal dimensiontime; the native voxel indicesk/j/iare always present and always last; - backed by a single
VoxelToWorldIndexattached to the world coordinatesz/y/x, which derives them lazily from a shared affine or an affine stack indexed by named nonspatialgeometry_dims.
World coordinates are never stored directly. This keeps cropping, slicing, registration, and I/O consistent: the affine always describes the whole physical grid, and indexing updates it exactly.
Installation
uv add voxeldata
Or with pip:
pip install voxeldata
Quick start
import numpy as np
import voxeldata as vd
data = vd.create_voxeldata(
np.zeros((3, 64, 128)),
dims=("k", "j", "i"),
spacing=(0.5, 0.1, 0.1), # z, y, x in millimetres
origin=(0.0, 0.0, 0.0),
)
data.coords["x"] # lazily derived world coordinates
data.sel(x=5.0) # select in world space
vd.validate_voxeldata(data)
data.vd.origin # {'z': 0.0, 'y': 0.0, 'x': 0.0}
data.vd.spacing # {'k': 0.5, 'j': 0.1, 'i': 0.1}
data.vd.direction # (3, 3) world direction matrix
Oblique grids work the same way:
data = vd.create_voxeldata(
np.zeros((3, 64, 128)),
dims=("k", "j", "i"),
voxel_to_world=affine, # (4, 4) homogeneous affine
)
geometry_dims names the nonspatial dimensions indexing an affine stack. For
example, geometry_dims=("time", "view") requires (ntime, nview, 4, 4) matrices;
other axes, such as channels, share geometry. A single (4, 4) affine has no
geometry dependencies, even when nonspatial dimensions are present. Timing
coordinates are independent of these geometry dependencies. A named time
DataArray may use (time, view, channel, ...), with any number of nonspatial
dependencies. Each timestamp series must increase along time. Select all
additional timestamp axes before using a shared-time index or analysis.
Auxiliary coordinates such as slice_time(time, k) may be added with
assign_coords; their acquisition-specific meaning belongs to the consumer.
All affine stacks require explicit geometry_dims; dimension names or matching
lengths never determine their meaning. Coordinates for arbitrary nonspatial axes
are supplied through extra_coords:
data = vd.create_voxeldata(
np.zeros((2, 3, 64, 128)),
dims=("view", "k", "j", "i"),
extra_coords={"view": [0, 1]},
voxel_to_world=affines, # (2, 4, 4)
geometry_dims=("view",),
)
assert data.vd.geometry_dims == ("view",)
Limitation: native Xarray .reindex() is unsupported on geometry dimensions;
use .isel() or .sel() to select/reorder existing labels instead. Alignment that
changes those labels is also unsupported. This does not affect the explicit
.vd.reindex_voxels() and .vd.reindex_voxels_like() geometry operations.
Creation preserves the supplied nonspatial dimension order. For example, both
(time, view, k, j, i) and (view, time, k, j, i) are valid.
data.vd.canonicalize() and data.vd.ensure() normalize to
(...extra_dims, time, k, j, i), preserving the relative order of extra
dimensions and omitting absent time dimensions. Canonicalization also
restores scalar-selected spatial dimensions, but does not restore selected nonspatial dimensions.
Public API
| Area | Functions |
|---|---|
| Dimensions | VOXEL_DIMS, WORLD_DIMS, TIME_DIM, CORE_DIMS |
| Construction | create_voxeldata, attach_voxel_to_world_index |
| Accessor | data.vd (VoxelDataAccessor) |
| Geometry | get_voxel_to_world_affine, get_voxel_to_world_units, get_voxel_to_world_index_origin, get_voxel_to_world_index_spacing, get_voxel_to_world_direction_matrix, convert_length_units |
| Validation | validate_voxeldata, ensure_voxeldata, canonicalize_voxeldata |
| Affine operations | apply_affine, reindex_voxels, reindex_voxels_like, get_bounding_box, get_relative_affine |
| Named affines | data.vd.get_affine, set_affine, remove_affine, apply, to |
| Extraction | extract_with_mask, extract_with_labels, unmask |
| Persistence | save, load_array, load_dataset, load_tree |
| Masks and labels | ensure_mask, validate_mask, ensure_labels, validate_labels, check_spatial_alignment |
The VoxelToWorldIndex and VoxelToWorldTransform classes implement the xarray
indexing machinery and are exported for advanced use.
Extraction
voxeldata.extract provides generic mask extraction, region aggregation, and
reconstruction. All three functions work out of the box using Xarray. Install
voxeldata[accel] for optional flox group-reduction acceleration,
voxeldata[lazy] for Dask arrays, voxeldata[io] for storage backends, or
voxeldata[all] for all runtime features:
uv add 'voxeldata[all]'
all includes optional runtime features, not development tools.
signals = vd.extract_with_mask(data, mask) # (..., space), selected native labels.
regions = vd.extract_with_labels(data, labels, reduction="mean") # (..., region).
restored = vd.unmask(signals, mask) # Rebuild the mask's full spatial grid.
Masks/labels must share the physical voxel grid. Select varying geometry before
using a shared spatial mask. Extraction preserves lazy signal data; unmask is
eager. See the extraction guide for formats and chunking limits.
Saving and loading
Install voxeldata[io] for Zarr and NetCDF persistence:
vd.save(data, "volume.zarr") # Or "volume.nc" for NetCDF.
with vd.load_array("volume.zarr") as restored:
volume = restored.compute()
Both formats restore the spatial index, ordered geometry dependencies, units,
native voxel labels, and named frames without storing dense world coordinates.
Loading uses storage-aligned Dask chunks when Dask is installed (for example via
voxeldata[lazy]), and backend lazy indexing otherwise. Pass chunks=None to opt
out of Dask. NetCDF overwrites existing files by default, following Xarray. See the
persistence guide for metadata restrictions and writer options.
Zarr also supports VoxelData datasets: ordinary Xarray Datasets containing spatial VoxelData variables on one shared grid, plus optional nonspatial variables. A VoxelData tree is an ordinary DataTree with these datasets at spatial leaves; grouping ancestors carry no spatial coordinates. Different leaves may use different grids. Variable names, diagnostics, and group names remain consumer-defined.
import xarray as xr
results = xr.Dataset({"image": data, "valid": data > 0})
vd.save(results, "results.zarr", compute=False).compute()
with vd.load_dataset("results.zarr") as restored:
vd.validate_voxeldata(restored["image"]) # Direct selection retains geometry.
# For multiple grids, save a DataTree and restore it with vd.load_tree(...).
Each container save uses one shared Dask write graph. Keep shared outputs in one container rather than making separate saves. Container I/O is Zarr-only. Xarray 2026.9.0 or newer is required.
Relationship to ConfUSIus
VoxelData and ConfUSIus are sister projects. ConfUSIus uses VoxelData for functional ultrasound imaging data. The model itself makes no assumption about modality, acquisition hardware, or signal semantics, so it is usable by any package working with spatially referenced voxel data.
Development
See the roadmap for planned geometry and extraction work.
uv sync # install dependencies
just test # run tests
just pre-commit # run lint, format, type checks, docstring checks
just docs # build documentation
License
BSD-3-Clause. See LICENSE and NOTICE.
Metadata
Release files for voxeldata 0.0.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| voxeldata-0.0.6.tar.gz | 56.0 kB | Without provenance | Details for voxeldata-0.0.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| voxeldata-0.0.6-py3-none-any.whl | Python 3 | none | any | Details for voxeldata-0.0.6-py3-none-any.whl |
Total release size: 119.1 kB
Release files / voxeldata-0.0.6.tar.gz
| Download URL | voxeldata-0.0.6.tar.gz |
|---|---|
| Size | 56.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe0e82d0d8df8655e6da23e20cdd7fc1bf5a9533d5dba74dc459b609ed706547
|
|
BLAKE2b-256 checksum How to use checksums |
14f034bd8667e64adf07313e29fded71b4f965bb4a204cd7777536b61694b671
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / voxeldata-0.0.6-py3-none-any.whl
| Download URL | voxeldata-0.0.6-py3-none-any.whl |
|---|---|
| Size | 63.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ff097a3bb2d1debaea6c4d899ba1ea0d255a314be2d5c8f67e7ebc955a54ba2a
|
|
BLAKE2b-256 checksum How to use checksums |
f3a4bae542905e74b9056d83d74f9b194ca3b709db07e569781aec90e352b82f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.7 {"installer":{"name":"uv","version":"0.13.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for voxeldata 0.0.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.