Zarr Streaming Python API Reference¶
Information on classes and methods for the acquire-zarr Python library. Check
https://github.com/acquire-project/acquire-zarr for more information.
acquire_zarr.CompressionCodec
¶
Codec to use for compression, if any.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
CompressionCodec
|
No compression |
BLOSC_LZ4 |
CompressionCodec
|
LZ4 compression using Blosc |
BLOSC_ZSTD |
CompressionCodec
|
Zstd compression using Blosc |
acquire_zarr.CompressionSettings
¶
Settings for compressing during acquisition.
acquire_zarr.Compressor
¶
Compressor to use, if any.
Attributes:
| Name | Type | Description |
|---|---|---|
NONE |
Compressor
|
No compression. |
BLOSC1 |
Compressor
|
Blosc compressor. |
acquire_zarr.DataType
¶
Data type used in the stream.
Attributes:
| Name | Type | Description |
|---|---|---|
UINT8 |
DataType
|
Unsigned 8-bit integer. |
UINT16 |
DataType
|
Unsigned 16-bit integer. |
UINT32 |
DataType
|
Unsigned 32-bit integer. |
UINT64 |
DataType
|
Unsigned 64-bit integer. |
INT8 |
DataType
|
Signed 8-bit integer. |
INT16 |
DataType
|
Signed 16-bit integer. |
INT32 |
DataType
|
Signed 32-bit integer. |
INT64 |
DataType
|
Signed 64-bit integer. |
FLOAT32 |
DataType
|
Single precision floating point. |
FLOAT64 |
DataType
|
Double precision floating point. |
acquire_zarr.Dimension
¶
Properties of a dimension of the output array.
acquire_zarr.DimensionType
¶
Type of dimension.
Attributes:
| Name | Type | Description |
|---|---|---|
SPACE |
DimensionType
|
Spatial dimension. |
CHANNEL |
DimensionType
|
Channel dimension. |
TIME |
DimensionType
|
Time dimension. |
OTHER |
DimensionType
|
Other dimension. |
acquire_zarr.LogLevel
¶
acquire_zarr.S3Settings
¶
Settings for connecting to and storing data in S3.
acquire_zarr.StreamSettings
¶
Settings for the Zarr stream.
acquire_zarr.ZarrStream
¶
acquire_zarr.ZarrVersion
¶
Zarr format version.
Attributes:
| Name | Type | Description |
|---|---|---|
V2 |
ZarrVersion
|
Zarr format version 2 |
V3 |
ZarrVersion
|
Zarr format version 3 |
acquire_zarr.get_log_level() -> LogLevel
¶
Get the current log level for the Zarr API
acquire_zarr.set_log_level(level: LogLevel) -> None
¶
Set the log level for the Zarr API