Acquisition and state¶
These entries are rendered from NumPy-style source docstrings. The documentation builder reads source files without importing the processing package or CUDA.
Acquisition inspection¶
Parse an OME-Zarr OPM manifest without opening or reading pixel data.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
Acquisition store or containing directory to inspect without reading pixels. |
required |
root
|
ZarrGroup | None
|
Opened OME-Zarr root group used to avoid rereading root metadata. |
None
|
Returns:
| Type | Description |
|---|---|
AcquisitionMetadata
|
Normalized acquisition dimensions, channels, calibration, and scan geometry. |
Open a logical TPCZYX TensorStore after metadata inspection.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
acquisition
|
AcquisitionMetadata | str | Path
|
Inspected acquisition dimensions, stage geometry, and camera calibration. |
required |
Returns:
| Type | Description |
|---|---|
TensorStore
|
Virtual TPCZYX view stacking the per-position TCZYX acquisition arrays. |
Processed arrays¶
Open a yaozarrs Bf2Raw collection as ordered TensorStore arrays.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
OME-Zarr directory to open. |
required |
Returns:
| Type | Description |
|---|---|
PositionCollection
|
Ordered array handles, pyramid levels, and physical metadata. |
Open one dataset from a yaozarrs Image group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
str | Path
|
OME-Zarr directory to open. |
required |
level
|
str
|
Dataset path within the image group, usually a pyramid level number. |
'0'
|
Returns:
| Type | Description |
|---|---|
Any
|
TensorStore handle for the requested image dataset. |