Skip to content

Commit b024031

Browse files
committed
update README
1 parent fbef151 commit b024031

1 file changed

Lines changed: 10 additions & 3 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,11 @@ BiocManager::install("ImageArray")
3636

3737
## Getting started
3838

39+
**ImageArray** allows saving images to either HDF5 (HDF5ImageArray) or
40+
Zarr (ZarrImageArray) where you can define the number of layers of the
41+
pyramids (i.e. number of downscaled images) and the path to the on-disk h5
42+
or zarr store.
43+
3944
```r
4045
library(ImageArray)
4146
library(EBImage)
@@ -48,6 +53,7 @@ h5_sample <- file.path(td, "sample")
4853
imgarray <- writeImageArray(img,
4954
format = "HDF5ImageArray",
5055
output = h5_sample,
56+
nlevels = 2,
5157
replace = TRUE)
5258
```
5359

@@ -66,7 +72,8 @@ plot(as.raster(imgarray))
6672
<br>
6773

6874
A number of memory-efficient (delayed or lazy) operations are available
69-
for pyramid images.
75+
for pyramid images, including rotation (0, 90, 180, 270), horizontal or
76+
vertical flipping and negation.
7077

7178
```r
7279
imgarray <- rotate(imgarray, degrees = 90)
@@ -78,7 +85,7 @@ imgarray
7885

7986
<br>
8087

81-
We can crop or slice images via indexing.
88+
We can crop or slice images via lazy indexing.
8289

8390
```r
8491
# crop or slice via indexing
@@ -94,7 +101,7 @@ Level 2 (51,51)
94101

95102
<br>
96103

97-
You can also use an existing OME-TIFF (or any Bioformats image) to
104+
You can also use an existing **OME-TIFF** (or any Bioformats image) to
98105
create an ImageArray object.
99106

100107
```r

0 commit comments

Comments
 (0)