Add docstrings to Segmentation init (#73)

bhklab · Feb 24, 2023 · 223f0b6 · 223f0b6
1 parent 6327578
commit 223f0b6
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/imgtools/modules/segmentation.py b/imgtools/modules/segmentation.py
@@ -36,6 +36,19 @@ def map_over_labels(segmentation, f, include_background=False, return_segmentati
 
 class Segmentation(sitk.Image):
     def __init__(self, segmentation, roi_indices=None, existing_roi_indices=None, raw_roi_names=None):
+        """Initializes the Segmentation class
+        
+        Parameters
+        ----------
+        roi_indices
+            Dictionary of {"ROI": label number}
+        
+        existing_roi_indices
+            Dictionary of {"ROI": label number} of the existing ROIs
+
+        raw_roi_names
+            Dictionary of {"ROI": original countor names}
+        """
         super().__init__(segmentation)
         self.num_labels = self.GetNumberOfComponentsPerPixel()
         if not roi_indices: