diff --git a/README.md b/README.md index 851ce88..dd63456 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ![tiler_logo](https://user-images.githubusercontent.com/1889128/148645934-2b1545bc-e7ea-4f02-88fb-10100b6aa9be.png) tiler +# ![tiler_baby_logo](misc/baby_logo.png) tiler ![Tiler teaser image](misc/teaser/tiler_teaser.png) @@ -136,7 +136,8 @@ This section is a work in progress. **How do I create tiles with less dimensions than the data array?** -Tiler expects `tile_shape` to have the same length as `data_shape`. -However you can specify the unwanted dimension as just 1. -For example, if you want to get 2d tiles out from 3d array you can specify depth dimension of 1: +Tiler expects `tile_shape` to have less than or the same number of elements as `data_shape`. +If `tile_shape` has less elements than `data_shape`, `tile_shape` will be prepended with +ones to match the size of `data_shape`. +For example, if you want to get 2d tiles out from 3d array you can initialize Tiler like this: `Tiler(data_shape=(128,128,128), tile_shape=(128, 128))` and it will be equivalent to `Tiler(data_shape=(128,128,128), tile_shape=(1, 128, 128))`. diff --git a/docs/index.html b/docs/index.html index 6867bad..5f7bf29 100644 --- a/docs/index.html +++ b/docs/index.html @@ -135,6 +135,9 @@

such as semantic segmentation in deep learning, especially in domains where images do not fit into GPU memory (e.g., hyperspectral satellite images, whole slide images, videos, tomography data).

+

Please see Quick start section.
+If you want to use tiler interactively, I highly recommend napari and napari-tiler plugin.

+

Features