Zarr Streaming Python API Reference¶
This documentation details the functions, modules, and objects provided by the Python API. For learning about the core concepts of Zarr, see the Core Concepts page. For examples of using the Python API, see the Python Examples page.
acquire_zarr.CompressionCodec
¶
Bases: pybind11_builtins.pybind11_object
Members:
NONE
BLOSC_LZ4
BLOSC_ZSTD
Attributes:
| Name | Type | Description |
|---|---|---|
BLOSC_LZ4 |
Members: |
|
BLOSC_ZSTD |
Members: |
|
NONE |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.CompressionSettings
¶
Bases: pybind11_builtins.pybind11_object
Attributes:
| Name | Type | Description |
|---|---|---|
codec |
|
|
compressor |
|
|
level |
|
|
shuffle |
|
acquire_zarr.Compressor
¶
Bases: pybind11_builtins.pybind11_object
Members:
NONE
BLOSC1
Attributes:
| Name | Type | Description |
|---|---|---|
BLOSC1 |
Members: |
|
NONE |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.DataType
¶
Bases: pybind11_builtins.pybind11_object
Members:
UINT8
UINT16
UINT32
UINT64
INT8
INT16
INT32
INT64
FLOAT32
FLOAT64
Attributes:
| Name | Type | Description |
|---|---|---|
FLOAT32 |
Members: |
|
FLOAT64 |
Members: |
|
INT16 |
Members: |
|
INT32 |
Members: |
|
INT64 |
Members: |
|
INT8 |
Members: |
|
UINT16 |
Members: |
|
UINT32 |
Members: |
|
UINT64 |
Members: |
|
UINT8 |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.Dimension
¶
Bases: pybind11_builtins.pybind11_object
Properties of a dimension of the Zarr array.
Attributes:
| Name | Type | Description |
|---|---|---|
array_size_px |
|
|
chunk_size_px |
|
|
kind |
|
|
name |
The name of the dimension. |
|
shard_size_chunks |
|
acquire_zarr.DimensionType
¶
Bases: pybind11_builtins.pybind11_object
Members:
SPACE
CHANNEL
TIME
OTHER
Attributes:
| Name | Type | Description |
|---|---|---|
CHANNEL |
Members: |
|
OTHER |
Members: |
|
SPACE |
Members: |
|
TIME |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.LogLevel
¶
Bases: pybind11_builtins.pybind11_object
Members:
DEBUG
INFO
WARNING
ERROR
NONE
Attributes:
| Name | Type | Description |
|---|---|---|
DEBUG |
Members: |
|
ERROR |
Members: |
|
INFO |
Members: |
|
NONE |
Members: |
|
WARNING |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.S3Settings
¶
Bases: pybind11_builtins.pybind11_object
Attributes:
| Name | Type | Description |
|---|---|---|
access_key_id |
|
|
bucket_name |
|
|
endpoint |
|
|
secret_access_key |
|
acquire_zarr.StreamSettings
¶
Bases: pybind11_builtins.pybind11_object
Attributes:
| Name | Type | Description |
|---|---|---|
compression |
|
|
custom_metadata |
|
|
data_type |
|
|
dimensions |
|
|
max_threads |
|
|
multiscale |
|
|
s3 |
|
|
store_path |
|
|
version |
|
acquire_zarr.VectorDimension
¶
Bases: pybind11_builtins.pybind11_object
Methods:
| Name | Description |
|---|---|
append |
append(self: acquire_zarr.VectorDimension, x: PyZarrDimensionProperties) -> None |
clear |
clear(self: acquire_zarr.VectorDimension) -> None |
extend |
extend(args, *kwargs) |
insert |
insert(self: acquire_zarr.VectorDimension, i: int, x: PyZarrDimensionProperties) -> None |
pop |
pop(args, *kwargs) |
append()
¶
append(self: acquire_zarr.VectorDimension, x: PyZarrDimensionProperties) -> None
Add an item to the end of the list
clear()
¶
clear(self: acquire_zarr.VectorDimension) -> None
Clear the contents
extend()
¶
extend(args, *kwargs) Overloaded function.
- extend(self: acquire_zarr.VectorDimension, L: acquire_zarr.VectorDimension) -> None
Extend the list by appending all the items in the given list
- extend(self: acquire_zarr.VectorDimension, L: Iterable) -> None
Extend the list by appending all the items in the given list
insert()
¶
insert(self: acquire_zarr.VectorDimension, i: int, x: PyZarrDimensionProperties) -> None
Insert an item at a given position.
pop()
¶
pop(args, *kwargs) Overloaded function.
- pop(self: acquire_zarr.VectorDimension) -> PyZarrDimensionProperties
Remove and return the last item
- pop(self: acquire_zarr.VectorDimension, i: int) -> PyZarrDimensionProperties
Remove and return the item at index i
acquire_zarr.ZarrStream
¶
acquire_zarr.ZarrVersion
¶
Bases: pybind11_builtins.pybind11_object
Members:
V2
V3
Attributes:
| Name | Type | Description |
|---|---|---|
V2 |
Members: |
|
V3 |
Members: |
|
name |
name(self: object) -> str |
|
value |
|
acquire_zarr.get_log_level()
¶
get_log_level() -> acquire_zarr.LogLevel
Get the current log level for the Zarr API
acquire_zarr.set_log_level()
¶
set_log_level(level: acquire_zarr.LogLevel) -> None
Set the log level for the Zarr API