aind-zarr-utils
Utilities for working with AIND Zarr assets, metadata, Neuroglancer annotations, and SmartSPIM pipeline coordinate transforms.
Recommended API
The primary entry point is Asset. It discovers an asset's alignment-channel
Zarr, loads acquisition metadata and processing.json, opens the Zarr once, and
reuses that state for image, stub, and point-transform workflows.
from aind_zarr_utils import Asset, Points, Space
from aind_s3_cache.json_utils import get_json
zarr_uri = "s3://aind-open-data/dataset/image.ome.zarr/0"
ng_state = get_json("s3://aind-open-data/dataset/neuroglancer_state.json")
asset = Asset.from_zarr(zarr_uri)
points = Points.from_neuroglancer(ng_state)
ccf = asset.transform(points, to=Space.CCF_MM)
print(ccf.values)
If you already have metadata and processing dictionaries loaded, use the no-I/O
constructor. alignment_zarr_uri should be the Zarr used by the alignment
pipeline; source_zarr_uri is optional provenance for the Zarr you started
from.
from aind_zarr_utils import Asset
asset = Asset(
alignment_zarr_uri="s3://bucket/asset/alignment.ome.zarr/0",
metadata=metadata,
processing=processing,
source_zarr_uri="s3://bucket/asset/acquisition.ome.zarr/0",
)
Metadata Reader Integration
This branch uses aind-metadata-reader to interpret historical and newer
acquisition and processing layouts. Asset discovery reads metadata.nd.json
when present and falls back to acquisition.json when the aggregate is absent.
Malformed JSON and access failures propagate. This file preference preserves
existing behavior; callers who need a different source can load it explicitly.
Anatomical conversion matches recorded coordinate-axis names to Zarr axis names.
It requires one cardinal frame; multiple frames require explicit selection.
Asset and all three discovery constructors accept an acquisition reader view
and a registration process:
from aind_metadata_reader import Document, read_acquisition, read_processing
from aind_zarr_utils import Asset
acquisition = read_acquisition(Document(metadata), device_name="SmartSPIM", frame_scope="local")
registrations = read_processing(Document(processing)).find("Image importing")
for run in registrations:
print(run.document.pointer, run.pipeline_name, run.pipeline_version, run.code_version)
# Choose a source pointer after inspecting the runs; a channel can have multiple runs.
registration = next(run for run in registrations if run.document.pointer == registration_pointer)
asset = Asset(
alignment_zarr_uri=zarr_uri,
metadata=metadata,
processing=processing,
acquisition=acquisition,
registration=registration,
)
image = asset.image(level=0)
pipeline_stub, size = asset.stub(pipeline=True)
Choose the device and frame that describe the Zarr. This selection does not
compose tile transforms or establish a global origin. To select a frame by its
exact source pointer, pass the CoordinateFrame returned by
read_acquisition(document).one_frame(pointer=frame_pointer) as acquisition.
The low-level image functions also accept either kind of view. The legacy
direction_from_* helpers still require recorded array dimensions, which newer
coordinate frames may omit.
The selected acquisition supplies geometry; the original asset.metadata
mapping remains the input to overlay predicates. The selected registration
supplies the component version and pipeline association used for overlays and
transform paths. Both views retain their source pointers, and asset.processing
keeps the original processing mapping. An explicit selection takes precedence
over automatic selection without rewriting the source metadata.
Registration component versions continue to select pipeline overlays independently of the metadata schema version. The reader's SmartSPIM helper interprets the observed registration 0.0.37 input convention; unverified producer conventions remain unresolved. Repeated registration steps require an unambiguous selection. Reading metadata does not certify schema validity. Pyramid translation corrections are explicit, as described below.
The reader is installed from PyPI with aind-metadata-reader>=0.2.3,<0.3.
Run uv sync to install the locked dependencies; a sibling checkout and internal
GitHub access are unnecessary. The upper bound keeps this integration within the
reader's tested experimental release series.
Physical Geometry And Pyramid Translations
Images and stubs use the recorded NGFF scales and translations, including
image-level transforms. Missing translations mean zero. Origin.default()
honors that recorded geometry; Origin.at(...) and Origin.at_corner(...)
rebase the full-resolution grid while preserving relative level translations.
No SmartSPIM fusion release records correct pyramid translations. Levels are
aligned block means, so level k sits (2**k - 1) / 2 level-0 voxels past
level 0, but the capsule's Python writer (fusion <0.0.4) records no
translation and BigStitcher-Spark (fusion >=0.0.3) records the offset in
voxels under micrometer axes. aind_zarr_utils.domain.pyramid keys a rule for
each on the fusion process's code_version and the writer that actually ran,
read from the Zarr's Bigstitcher-Spark attributes and the process notes.
Asset applies these rules by default, and zarr_to_sitk, zarr_to_ants and
zarr_to_sitk_stub apply them when given processing_data:
asset = Asset.from_root(asset_uri)
image = asset.image(level=3) # corrected
manifest = asset.pyramid_geometry.manifest() # audit trail
image = zarr_to_sitk(uri, metadata, level=3, processing_data=processing)
Fusion versions newer than the last verified one are corrected with a warning.
A missing or ambiguous fusion record, a version no rule covers, notes that
contradict the Zarr attributes, or translations that do not show the rule's
defect leave the recorded geometry in place, with a warning. Pass
pyramid_rules=() to an Asset to use recorded translations.
To supply your own evidence instead, use with_pyramid_translation_correction:
corrected = asset.with_pyramid_translation_correction(
author="your-name",
association_evidence=(association_check_reference,),
averaging_evidence=(block_averaging_check_reference,),
)
Either way the result is the reader's interpretation, bound to this Zarr's
attribute capture, with a replayable manifest. Stored attributes, pixels,
acquisition metadata and processing records are unchanged. Low-level callers
can pass aind_zarr_utils.io.ngff.interpreted_zarr(...) as opened_zarr.
Historical registration frames remain separate: pipeline images, stubs, and CCF point transforms keep the geometry used by registration. Physical pyramid translation correction does not modify the stored ANTs transform chain.
Pipeline majors 3 through 6 use the verified individual SyN warp/affine chain. The recorded registration-frame anchor is verified through importer 0.0.37; newer importer versions still emit a warning when that convention is assumed.
Synthetic pyramids should declare their actual translations in NGFF metadata.
Asset constructors use anonymous S3 access for metadata and image data by default.
Pass anonymous=False to use the normal AWS credential chain. Access settings
remain attached to each opened store and its child locations.
Images And Stubs
Asset.image() returns a SimpleITK image by default and can also return an ANTs
image. Asset.stub() returns a header-only SimpleITK image for coordinate
operations without loading pixel data.
from aind_zarr_utils import Asset, Origin
asset = Asset.from_root("s3://aind-open-data/dataset")
sitk_img = asset.image(level=3)
ants_img = asset.image(level=3, library="ants")
stub, size_ijk = asset.stub(level=0)
pipeline_stub, native_size_ijk = asset.stub(pipeline=True)
anchored = asset.image(
level=3,
origin=Origin.at_corner("RAS", (0.0, 0.0, 0.0)),
)
origin is only accepted when pipeline=False. Pipeline images and stubs use
the pipeline-corrected origin from processing.json.
Coordinate Spaces
Points stores named (N, 3) arrays plus a Space tag. Constructors validate
shape and coerce arrays to floating point.
import numpy as np
from aind_zarr_utils import Asset, Points, Space
asset = Asset.from_zarr("s3://bucket/asset/image.ome.zarr/0")
indices = Points(
{"soma": np.array([[100, 200, 50], [120, 180, 60]])},
Space.ZARR_INDICES,
)
pipeline_mm = asset.transform(indices, to=Space.LS_PIPELINE_ANATOMICAL_MM)
ccf_mm = asset.transform(indices, to=Space.CCF_MM)
round_trip = asset.transform(ccf_mm, to=Space.ZARR_INDICES)
Supported spaces are:
Space.ZARR_INDICES: continuous level-0(z, y, x)Zarr indicesSpace.LS_SCALED_MM: spacing-scaled light-sheet coordinatesSpace.LS_ANATOMICAL_MM: raw Zarr anatomical LPS millimetersSpace.LS_PIPELINE_ANATOMICAL_MM: pipeline-corrected LPS millimetersSpace.CCF_MM: Allen CCF LPS millimeters
SWC coordinates can enter the same graph without opening image data first:
swc_points = Points.from_swc(swc_array, axis_order="zyx", units="micrometer")
ccf_points = asset.transform(swc_points, to=Space.CCF_MM)
Legacy Functions
The lower-level modules remain available for compatibility:
aind_zarr_utils.zarr:zarr_to_ants,zarr_to_sitk,zarr_to_sitk_stubaind_zarr_utils.neuroglancer: Neuroglancer annotation readersaind_zarr_utils.pipeline_transformed: explicit metadata transform helpers
The auto-metadata convenience helpers in pipeline_transformed are deprecated
in favor of Asset.from_zarr(...) / Asset.from_root(...) plus
Asset.transform(...).
Installation
pip install aind-zarr-utils
For development:
git clone https://github.com/AllenNeuralDynamics/aind-zarr-utils.git
cd aind-zarr-utils
uv sync
Development
Run the core checks with:
uv run ruff format
uv run ruff check
uv run mypy
uv run pytest
uv run --group docs sphinx-build docs/source docs/build/html -W --keep-going
Pull requests use Angular-style commit messages:
<type>(<scope>): <short summary>
Metadata
Release files for aind-zarr-utils 0.21.1
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 |
|---|---|---|---|---|
| aind_zarr_utils-0.21.1.tar.gz | 599.3 kB | Without provenance | Details for aind_zarr_utils-0.21.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aind_zarr_utils-0.21.1-py3-none-any.whl | Python 3 | none | any | Details for aind_zarr_utils-0.21.1-py3-none-any.whl |
Total release size: 680.7 kB
Release files / aind_zarr_utils-0.21.1.tar.gz
| Download URL | aind_zarr_utils-0.21.1.tar.gz |
|---|---|
| Size | 599.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
21ba0f6453a1be608d70b2add8d38d4fd16713991769de206beaefe0c1c2ee1a
|
|
BLAKE2b-256 checksum How to use checksums |
85d11ad175341d9e4baaf90b83967e877a970266d14da49c4de6037c8380e5b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / aind_zarr_utils-0.21.1-py3-none-any.whl
| Download URL | aind_zarr_utils-0.21.1-py3-none-any.whl |
|---|---|
| Size | 81.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ee98b438045b367fe79af99a1c9f6fb220e429b18f862b209c76169eb19e5ffc
|
|
BLAKE2b-256 checksum How to use checksums |
0604cd6e0ac78cf713b78035ee3223a134aa9fca1a0f5959141a0b152fe8c85e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for aind-zarr-utils 0.21.1
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.