Skip to content

Commit b39a0c1

Browse files
committed
chore: typos and other minor fixes
1 parent 2d9423b commit b39a0c1

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/source/advanced/build_custom_pyramid.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@
131131
"id": "9a086164",
132132
"metadata": {},
133133
"source": [
134-
"You can use one of these functions for downsampling by passing the method name as a string to the writer function, e.g. `method=\"mean\"` or `method=\"resize\"`, i.e.:"
134+
"You can use one of these functions for downsampling by passing the method name as a string to the writer function, e.g. `method=\"local_mean\"` or `method=\"resize\"`, i.e.:"
135135
]
136136
},
137137
{
@@ -169,7 +169,7 @@
169169
"```{warning}\n",
170170
"\n",
171171
"The choice of the correct downsampling function is typically of secondary importance,\n",
172-
"*unless* your data spoeciufically requires a certain method.\n",
172+
"*unless* your data specifically requires a certain method.\n",
173173
"\n",
174174
"For instance, when writing categorical data (i.e., segmentations or generally labels),\n",
175175
"you will want to use a method that preserves the label values, such as {py:func}`ome_zarr.scale.Methods.NEAREST`.\n",

docs/source/basic/write_labels.ipynb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,15 @@
8383
"\n",
8484
"```\n",
8585
"test_ngff_image_with_labels.zarr\n",
86-
"\u251c\u2500\u2500 zarr.json\n",
87-
"\u251c\u2500\u2500 labels\n",
88-
"\u2502 \u251c\u2500\u2500 .zarr.json\n",
89-
"\u2502 \u2514\u2500\u2500 blobs\n",
90-
"| \u251c\u2500\u2500 .zarr.json\n",
91-
"| \u251c\u2500\u2500 s0\n",
92-
"| \u2514\u2500\u2500 s1\n",
93-
"\u251c\u2500\u2500 s0\n",
94-
"\u2514\u2500\u2500 s1\n",
86+
"├── zarr.json\n",
87+
"├── labels\n",
88+
" ├── zarr.json\n",
89+
" └── blobs\n",
90+
"| ├── .zarr.json\n",
91+
"| ├── s0\n",
92+
"| └── s1\n",
93+
"├── s0\n",
94+
"└── s1\n",
9595
"```"
9696
]
9797
},

docs/source/explanation/multiscale_pyramids.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Different downsampling methods are appropriate for different data types:
3232

3333
| Method | Use Case |
3434
|--------|----------|
35-
| `gaussian` | General intensity images |
36-
| `nearest` | Categorical data (labels, segmentations) |
37-
| `mean` | Averaging for smoother results |
38-
| `resize` | Fast skimage-based resizing |
35+
|`ome_zarr.scale.Methods.resize` | Fast skimage-based resizing |
36+
| `ome_zarr.scale.Methods.nearest` | Categorical data (labels, segmentations) |
37+
| `ome_zarr.scale.Methods.zoom` | Downsampling using the [scipy zoom function](https://docs.scipy.org/doc/scipy/reference/generated/scipy.ndimage.zoom.html#scipy.ndimage.zoom) |
38+
| `ome_zarr.scale.Methods.local_mean` | Local averaging for smoother results |
3939

40-
See {py:class}`ome_zarr.scale.Methods` for available options.
40+
See {py:class}`ome_zarr.scale.Methods` for all available options and more details.
4141

4242
## Resources
4343

0 commit comments

Comments
 (0)