ENH: scil_volume description

scilus · Aug 21, 2024 · 99673ab · 99673ab
1 parent d5bbfaf
commit 99673ab
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/scripts/scil_volume_crop.py b/scripts/scil_volume_crop.py
@@ -10,6 +10,14 @@
 it's looking for non-zero data. Therefore, you should validate the results on
 other types of images that haven't been masked.
 
+To:
+    - interpolate/reslice to an arbitrary voxel size, use
+      scil_volume_resample.py.
+    - pad or crop the volume to match the desired shape, use
+      scil_volume_reshape.py.
+    - reshape a volume to match the resolution of another, use
+      scil_volume_reslice_to_reference.py.
+
 Formerly: scil_crop_volume.py
 """
 

diff --git a/scripts/scil_volume_resample.py b/scripts/scil_volume_resample.py
@@ -5,9 +5,14 @@
 Script to resample a dataset to match the resolution of another
 reference dataset or to the resolution specified as in argument.
 
-This script will reslice the volume to match the desired shape. To pad or crop,
-use scil_volume_reshape.py.
-
+This script will reslice the volume to match the desired shape.
+
+To:
+    - pad or crop the volume to match the desired shape, use
+      scil_volume_reshape.py.
+    - reslice a volume to match the shape of another, use
+      scil_volume_reslice_to_reference.py.
+    - crop a volume to remove empty space, use scil_volume_crop.py.
 Formerly: scil_resample_volume.py
 """
 

diff --git a/scripts/scil_volume_reshape.py b/scripts/scil_volume_reshape.py
@@ -8,7 +8,12 @@
 specified resolution.
 
 This script will pad or crop the volume to match the desired shape.
-To interpolate, use scil_volume_resample.py.
+To
+    - interpolate/reslice to an arbitrary voxel size, use
+      scil_volume_resample.py.
+    - reslice a volume to match the shape of another, use
+      scil_volume_reslice_to_reference.py.
+    - crop a volume to constrain the field of view, use scil_volume_crop.py.
 """
 
 import argparse

diff --git a/scripts/scil_volume_reslice_to_reference.py b/scripts/scil_volume_reslice_to_reference.py
@@ -9,6 +9,13 @@
 >>> scil_volume_reshape_to_reference.py wmparc.mgz t1.nii.gz wmparc_t1.nii.gz\\
     --interpolation nearest
 
+To
+    - pad or crop the volume to match the desired shape, use
+      scil_volume_reshape.py.
+    - interpolate/reslice to an arbitrary voxel size, use
+      scil_volume_resample.py.
+    - crop a volume to remove empty space, use scil_volume_crop.py.
+
 Formerly: scil_reshape_to_reference.py
 """