Merge branch 'dev'

b-heifets · Aug 14, 2024 · 52e76d3 · 52e76d3
2 parents 674999d + fa699b0
commit 52e76d3
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 1 deletion.
diff --git a/pyproject.toml b/pyproject.toml
@@ -149,6 +149,7 @@ utils_clean_tifs = "unravel.utilities.clean_tif_dirs:main"
 utils_prepend = "unravel.utilities.prepend_conditions:main"
 utils_rename = "unravel.utilities.rename:main"
 utils_toggle = "unravel.utilities.toggle_samples:main"
+utils_points_compressor = "unravel.utilities.points_compressor:main"
 vstats_apply_mask = "unravel.voxel_stats.apply_mask:main"
 vstats_hemi_to_avg = "unravel.voxel_stats.hemi_to_LR_avg:main"
 vstats_whole_to_avg = "unravel.voxel_stats.whole_to_LR_avg:main"

diff --git a/unravel/docs/guide.md b/unravel/docs/guide.md
@@ -410,6 +410,7 @@ unravel_commands -m
 - [**utils_rename**](unravel.utilities.rename): Rename files.
 - [**utils_toggle**](unravel.utilities.toggle_samples): Toggle sample?? folders for select batch processing.
 - [**utils_clean_tifs**](unravel.utilities.clean_tif_dirs): Clean TIF directories (no spaces, move non-tifs).
+- [**utils_points_compressor**](unravel.utilities.points_compressor): Pack or unpack point data in a CSV file or summarize the number of points per region.
 :::
 
 ::::

diff --git a/unravel/docs/unravel/utilities/points_compressor.rst b/unravel/docs/unravel/utilities/points_compressor.rst
@@ -0,0 +1,9 @@
+.. _unravel.utilities.points_compressor:
+
+unravel.utilities.points_compressor module
+==========================================
+
+.. automodule:: unravel.utilities.points_compressor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/unravel/docs/unravel/utilities/toc.rst b/unravel/docs/unravel/utilities/toc.rst
@@ -10,6 +10,7 @@ unravel.utilities package
    prepend_conditions
    rename
    toggle_samples
+   points_compressor
 
 .. automodule:: unravel.utilities
    :members:

diff --git a/unravel/unravel_commands.py b/unravel/unravel_commands.py
@@ -497,6 +497,11 @@ def main():
                 "module": "unravel.utilities.clean_tif_dirs",
                 "description": "Clean TIF directories (no spaces, move non-tifs).",
                 "common": False
+            },
+            "utils_points_compressor": {
+                "module": "unravel.utilities.points_compressor",
+                "description": "Pack or unpack point data in a CSV file or summarize the number of points per region.",
+                "common": False
             }
         }
     }

diff --git a/unravel/utilities/points_compressor.py b/unravel/utilities/points_compressor.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python3
 
 """
-Use ``utils_points_compressor`` from UNRAVEL to pack or unpack point data in a CSV file.
+Use ``utils_points_compressor`` from UNRAVEL to pack or unpack point data in a CSV file or summarize the number of points per region.
 
 Packing: Group points with the same coordinates and `Region_ID`, adding a `count` column.
 Unpacking: Expand packed points back to individual rows based on the `count` column.