|
1 | | -# 🐍 Python Array API |
| 1 | +# 🐍 Python Interface |
2 | 2 |
|
3 | | -NGFF-Zarr supports conversion of any NumPy array-like object that follows the |
4 | | -[Python Array API Standard](https://data-apis.org/array-api/latest/) into |
5 | | -OME-Zarr. This includes such objects an NumPy `ndarray`'s, Dask Arrays, PyTorch |
6 | | -Tensors, CuPy arrays, Zarr array, etc. |
| 3 | +NGFF-Zarr is a Python library that provides a simple, natural interface for |
| 4 | +working with OME-Zarr data structures, creating chunked, multiscale OME-Zarr |
| 5 | +image pyramids, and reading and writing OME-Zarr multiscale image files. |
| 6 | + |
| 7 | +NGFF-Zarr's interface, which reflects the OME-Zarr data model, is built on |
| 8 | +Python's built-in [dataclasses] and [Dask arrays]. It is designed to be simple, |
| 9 | +flexible, and easy to use. |
7 | 10 |
|
8 | 11 | ## Array to NGFF Image |
9 | 12 |
|
10 | | -Convert the array to an `NgffImage`, which is a standard |
11 | | -[Python dataclass](https://docs.python.org/3/library/dataclasses.html) that |
12 | | -represents an OME-Zarr image for a single scale. |
| 13 | +NGFF-Zarr supports conversion of any NumPy array-like object that follows the |
| 14 | +[Python Array API Standard] into the OME-Zarr data model. This includes such |
| 15 | +objects an NumPy `ndarray`'s, Dask Arrays, PyTorch Tensors, CuPy arrays, Zarr |
| 16 | +array, etc. |
| 17 | + |
| 18 | +Convert the array to an {NgffImage}`ngff_zarr.ngff_image.NgffImage`, which is a |
| 19 | +standard Python [dataclass] that represents an OME-Zarr image for a single |
| 20 | +scale. |
13 | 21 |
|
14 | 22 | When creating the image from the array, you can specify |
15 | 23 |
|
@@ -165,3 +173,8 @@ Any other |
165 | 173 | also be used. |
166 | 174 |
|
167 | 175 | The multiscales will be computed and written out-of-core, limiting memory usage. |
| 176 | + |
| 177 | +[dataclass]: https://docs.python.org/3/library/dataclasses.html |
| 178 | +[dataclasses]: https://docs.python.org/3/library/dataclasses.html |
| 179 | +[Dask arrays]: https://docs.dask.org/en/stable/array.html |
| 180 | +[Python Array API Standard]: https://data-apis.org/array-api/latest/ |
0 commit comments