doc: eval (#161)

Co-authored-by: anna-grim <[email protected]>

Author: anna-grim

demo/results-overview.txt

@@ -1,82 +1,3 @@
-Average Results...
-  # Splits: 7.2780
-  # Merges: 0.0000
-  Split Rate: 124.3079
-  Merge Rate: nan
-  % Split Edges: 1.1996
-  % Omit Edges: 4.5086
-  % Merged Edges: 0.0000
-  Edge Accuracy: 95.4914
-  ERL: 180.8849
-  Normalized ERL: 0.3949
-
-Total Results...
-  # Splits: 27
-  # Merges: 0
-Average Results...
-  # Splits: 7.2780
-  # Merges: nan
-  % Split Edges: 1.1997
-  % Omit Edges: 0.9740
-  % Merged Edges: 0.0000
-  ERL: 187.0877
-  Normalized ERL: 0.4006
-  Edge Accuracy: 97.8253
-  Split Rate: 116.9354
-  Merge Rate: nan
-
-Total Results...
-  # Splits: 27.0
-  # Merges: 0.0
-
-Average Results...
-  # Splits: 7.2780
-  # Merges: nan
-  % Split Edges: 1.1997
-  % Omit Edges: 0.9740
-  % Merged Edges: 0.0000
-  ERL: 187.0877
-  Normalized ERL: 0.4006
-  Edge Accuracy: 97.8253
-  Split Rate: 116.9354
-  Merge Rate: nan
-
-Total Results...
-  # Splits: 27.0
-  # Merges: 0.0
-
-Average Results...
-  # Splits: 7.2780
-  # Merges: nan
-  % Split Edges: 1.1997
-  % Omit Edges: 0.9740
-  % Merged Edges: 0.0000
-  ERL: 187.0877
-  Normalized ERL: 0.4006
-  Edge Accuracy: 97.8253
-  Split Rate: 116.9354
-  Merge Rate: nan
-
-Total Results...
-  # Splits: 27.0
-  # Merges: 0.0
-
-Average Results...
-  # Splits: 7.2780
-  # Merges: nan
-  % Split Edges: 1.1997
-  % Omit Edges: 0.9740
-  % Merged Edges: 0.0000
-  ERL: 187.0877
-  Normalized ERL: 0.4006
-  Edge Accuracy: 97.8253
-  Split Rate: 116.9354
-  Merge Rate: nan
-
-Total Results...
-  # Splits: 27.0
-  # Merges: 0.0
-
 Average Results...
   # Splits: 7.2780
   # Merges: nan

src/segmentation_skeleton_metrics/data_handling/graph_loading.py

@@ -304,7 +304,7 @@ def _init_graph(self, swc_dict):
         swc_dict : dict
             Dictionary whose keys and values are the attribute names and
             values from an SWC file.
-    
+
         Returns
         -------
         graph : SkeletonGraph

src/segmentation_skeleton_metrics/evaluate.py

@@ -225,6 +225,19 @@ def save_fragments(self):
         pass
 
     def save_merge_results(self, gt_graphs, fragment_graphs, output_dir):
+        """
+        Saves all detected merge results, including skeletons, merge sites,
+        and metadata.
+
+        Parameters
+        ----------
+        gt_graphs : Dict[str, LabeledGraph]
+            Graphs built from ground truth SWC files.
+        fragment_graphs : Dict[str, FragmentsGraph]
+            Graphs built from skeletons obtained from a predicted segmentation.
+        output_dir : str
+            Directory that results are written to.
+        """
         # Initialize a writer
         zip_path = os.path.join(output_dir, "merged_fragments.zip")
         util.rm_file(zip_path)
@@ -240,6 +253,14 @@ def save_merge_results(self, gt_graphs, fragment_graphs, output_dir):
         self.merge_sites.to_csv(path, index=True)
 
     def save_merge_sites(self, zip_writer):
+        """
+        Saves merge site coordinates into a ZIP archive.
+
+        Parameters
+        ----------
+        zip_writer : zipfile.ZipFile
+            Open ZIP file handle used to store merge site data.
+        """
         merge_sites = self.metrics["# Merges"].merge_sites
         for i in range(len(merge_sites)):
             filename = merge_sites.index[i]
@@ -249,6 +270,19 @@ def save_merge_sites(self, zip_writer):
     def save_skeletons_with_merge(
         self, gt_graphs, fragment_graphs, zip_writer
     ):
+        """
+        Saves ground truth and fragment skeletons containing merge sites into
+        a ZIP archive.
+
+        Parameters
+        ----------
+        gt_graphs : Dict[str, LabeledGraph]
+            Graphs built from ground truth SWC files.
+        fragment_graphs : Dict[str, FragmentsGraph]
+            Graphs built from skeletons obtained from a predicted segmentation.
+        zip_writer : zipfile.ZipFile
+            Open ZIP file handle used to write SWC data.
+        """
         # Save ground truth skeletons
         for key in self.merge_sites["GroundTruth_ID"].unique():
             gt_graphs[key].to_zipped_swc(zip_writer)