Skip to content

Commit

Permalink
Update CHANGELOG and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
aliddell committed Aug 21, 2023
1 parent 7da3130 commit 2c21e7d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 7 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased

### Added

- Support for [Zarr v3](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).

## [0.1.4](https://github.com/acquire-project/acquire-driver-zarr/compare/v0.1.3...v0.1.4) - 2023-08-11

### Fixed
Expand Down
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ This is an Acquire Driver that supports chunked streaming to [zarr][].
- **Zarr**
- **ZarrBlosc1ZstdByteShuffle**
- **ZarrBlosc1Lz4ByteShuffle**
- **ZarrV3**
- **ZarrV3Blosc1ZstdByteShuffle**
- **ZarrV3Blosc1Lz4ByteShuffle**

## Using the Zarr storage device

Expand All @@ -24,6 +27,10 @@ Chunking is configured using `storage_properties_set_chunking_props()` when conf
Multiscale storage can be enabled or disabled by calling `storage_properties_set_enable_multiscale()` when configuring
the video stream.

For the [Zarr v3] version of each device, you can use the `ZarrV3*` devices.
**Note:** Zarr v3 is not [yet](https://github.com/ome/ngff/pull/206) supported by the Python OME-Zarr library, so you
will not be able to read multiscale metadata from the resulting dataset.

### Configuring chunking

You can configure chunking by calling `storage_properties_set_chunking_props()` on your `StorageProperties` object
Expand All @@ -41,21 +48,21 @@ storage_properties_set_chunking_props(struct StorageProperties* out,
```
| ![frames](https://github.com/aliddell/acquire-driver-zarr/assets/844464/3510d468-4751-4fa0-b2bf-0e29a5f3ea1c) |
|:--:|
| A collection of frames. |
|:-------------------------------------------------------------------------------------------------------------:|
| A collection of frames. |
A _tile_ is a contiguous section, or region of interest, of a _frame_.
| ![tiles](https://github.com/aliddell/acquire-driver-zarr/assets/844464/f8d16139-e0ac-44db-855f-2f5ef305c98b) |
|:--:|
| A collection of frames, divided into tiles. |
|:------------------------------------------------------------------------------------------------------------:|
| A collection of frames, divided into tiles. |
A _chunk_ is nothing more than some number of stacked tiles from subsequent frames, with each tile in a chunk having
the same ROI in its respective frame.
| ![chunks](https://github.com/aliddell/acquire-driver-zarr/assets/844464/653e4d82-363e-4e04-9a42-927b052fb6e7) |
|:--:|
| A collection of frames, divided into tiles. A single chunk has been highlighted in red. |
| ![chunks](https://github.com/aliddell/acquire-driver-zarr/assets/844464/653e4d82-363e-4e04-9a42-927b052fb6e7) |
|:-------------------------------------------------------------------------------------------------------------:|
| A collection of frames, divided into tiles. A single chunk has been highlighted in red. |
You can specify the width and height, in pixels, of each tile, and if your frame size has more than one plane, you can
specify the number of planes you want per tile as well.
Expand Down Expand Up @@ -120,3 +127,5 @@ Then the sequence of levels will have dimensions 1920 x 1080, 960 x 540, 480 x 2
[Blosc]: https://github.com/Blosc/c-blosc
[Blosc docs]: https://www.blosc.org/
[Zarr v3]: https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html

0 comments on commit 2c21e7d

Please sign in to comment.