Merge pull request #720 from thewtex/large-roi-note

DOC: Add note about roi chunk re-alignment
InsightSoftwareConsortium · Dec 19, 2023 · 2f267e2 · 2f267e2
2 parents 9aba3d9 + 97b43df
commit 2f267e2
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/examples/integrations/itk/SelectROI.ipynb b/examples/integrations/itk/SelectROI.ipynb
@@ -599,6 +599,13 @@
     "to_ngff_zarr('roi.zarr', multiscales=roi_multiscales)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If the goal is just to view or process the ROI, use `get_roi_image`. If the goal is to save the entire roi to disk, use `get_roi_multiscales` followed `to_ngff_zarr`. There is a need to re-align array chunks after roi extraction, which can take some time for the entire multiscale dataset with very large images."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 17,

diff --git a/examples/integrations/itkwasm/SelectROI.ipynb b/examples/integrations/itkwasm/SelectROI.ipynb
@@ -588,6 +588,13 @@
     "to_ngff_zarr('roi.zarr', multiscales=roi_multiscales)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If the goal is just to view or process the ROI, use `get_roi_image`. If the goal is to save the entire roi to disk, use `get_roi_multiscales` followed `to_ngff_zarr`. There is a need to re-align array chunks after roi extraction, which can take some time for the entire multiscale dataset with very large images."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 17,