Implemented 3D connected components as wrapper class for scipy.ndimage.label

Ticket: https://www.notion.so/qim-dtu/3D-connected-components-ca5c410fef49444eac7c6efd0b56ead4?pvs=4

I have made a simple plot functions that takes the ConnectedComponents object and extracts the connected_components volume.

However I don't know if it is necessary as the user could do this manually.

def plot_connected_components(connected_components: ConnectedComponents, **kwargs):
    """ Plots connected components from the ConnectedComponents class as 2d slices.

    Args:
        connected_components (ConnectedComponents): The connected components class from the qim3d.utils.connected_components module.
        **kwargs: Additional keyword arguments to pass to qim3d.viz.img.slice_viz.

    Returns:
        matplotlib.pyplot: the 3D plot of the connected components.
    """
    fig = slice_viz(connected_components.connected_components, **kwargs)
    return fig

qim3d/utils/cc.py

@@ -64,15 +64,15 @@ class CC:
             return find_objects(self._connected_components)
 
 
-def get_3d_cc(image: np.ndarray | torch.Tensor):
-    """Get the connected components of a 3D binary image.
+def get_3d_cc(image: np.ndarray | torch.Tensor) -> CC:
+    """ Get the connected components of a 3D volume.
 
     Args:
         image (np.ndarray | torch.Tensor): An array-like object to be labeled. Any non-zero values in `input` are
             counted as features and zero values are considered the background.
 
     Returns:
-        class: Returns class object of the connected components.
+        CC: A ConnectedComponents object containing the connected components and the number of connected components.
     """
     connected_components, num_connected_components = label(image)
     log.info(f"Total number of connected components found: {num_connected_components}")