risk-network 0.0.11__py3-none-any.whl → 0.0.12__py3-none-any.whl

risk/network/plotter/canvas.py

@@ -76,7 +76,7 @@ class Canvas:
         fig = self.ax.figure
         # Use a tight layout to ensure that title and subtitle do not overlap with the original plot
         fig.tight_layout(
-            rect=[0, 0, 1, 1 - title_space_offset]
+            rect=(0, 0, 1, 1 - title_space_offset)
         )  # Leave space above the plot for title
 
         # Plot title if provided
@@ -158,7 +158,7 @@ class Canvas:
         # Calculate the center and radius of the bounding box around the network
         center, radius = calculate_bounding_box(node_coordinates)
         # Adjust the center based on user-defined offsets
-        adjusted_center = _calculate_adjusted_center(
+        adjusted_center = self._calculate_adjusted_center(
             center, radius, center_offset_x, center_offset_y
         )
         # Scale the radius by the scale factor
@@ -250,42 +250,42 @@ class Canvas:
             fill_alpha=fill_alpha,
         )
 
+    def _calculate_adjusted_center(
+        self,
+        center: Tuple[float, float],
+        radius: float,
+        center_offset_x: float = 0.0,
+        center_offset_y: float = 0.0,
+    ) -> Tuple[float, float]:
+        """Calculate the adjusted center for the network perimeter circle based on user-defined offsets.
 
-def _calculate_adjusted_center(
-    center: Tuple[float, float],
-    radius: float,
-    center_offset_x: float = 0.0,
-    center_offset_y: float = 0.0,
-) -> Tuple[float, float]:
-    """Calculate the adjusted center for the network perimeter circle based on user-defined offsets.
-
-    Args:
-        center (Tuple[float, float]): Original center coordinates of the network graph.
-        radius (float): Radius of the bounding box around the network.
-        center_offset_x (float, optional): Horizontal offset as a fraction of the diameter.
-            Negative values shift the center left, positive values shift it right. Allowed
-            values are in the range [-1, 1]. Defaults to 0.0.
-        center_offset_y (float, optional): Vertical offset as a fraction of the diameter.
-            Negative values shift the center down, positive values shift it up. Allowed
-            values are in the range [-1, 1]. Defaults to 0.0.
+        Args:
+            center (Tuple[float, float]): Original center coordinates of the network graph.
+            radius (float): Radius of the bounding box around the network.
+            center_offset_x (float, optional): Horizontal offset as a fraction of the diameter.
+                Negative values shift the center left, positive values shift it right. Allowed
+                values are in the range [-1, 1]. Defaults to 0.0.
+            center_offset_y (float, optional): Vertical offset as a fraction of the diameter.
+                Negative values shift the center down, positive values shift it up. Allowed
+                values are in the range [-1, 1]. Defaults to 0.0.
 
-    Returns:
-        Tuple[float, float]: Adjusted center coordinates after applying the offsets.
+        Returns:
+            Tuple[float, float]: Adjusted center coordinates after applying the offsets.
 
-    Raises:
-        ValueError: If the center offsets are outside the valid range [-1, 1].
-    """
-    # Flip the y-axis to match the plot orientation
-    flipped_center_offset_y = -center_offset_y
-    # Validate the center offsets
-    if not -1 <= center_offset_x <= 1:
-        raise ValueError("Horizontal center offset must be in the range [-1, 1].")
-    if not -1 <= center_offset_y <= 1:
-        raise ValueError("Vertical center offset must be in the range [-1, 1].")
+        Raises:
+            ValueError: If the center offsets are outside the valid range [-1, 1].
+        """
+        # Flip the y-axis to match the plot orientation
+        flipped_center_offset_y = -center_offset_y
+        # Validate the center offsets
+        if not -1 <= center_offset_x <= 1:
+            raise ValueError("Horizontal center offset must be in the range [-1, 1].")
+        if not -1 <= center_offset_y <= 1:
+            raise ValueError("Vertical center offset must be in the range [-1, 1].")
 
-    # Calculate adjusted center by applying offset fractions of the diameter
-    adjusted_center_x = center[0] + (center_offset_x * radius * 2)
-    adjusted_center_y = center[1] + (flipped_center_offset_y * radius * 2)
+        # Calculate adjusted center by applying offset fractions of the diameter
+        adjusted_center_x = center[0] + (center_offset_x * radius * 2)
+        adjusted_center_y = center[1] + (flipped_center_offset_y * radius * 2)
 
-    # Return the adjusted center coordinates
-    return adjusted_center_x, adjusted_center_y
+        # Return the adjusted center coordinates
+        return adjusted_center_x, adjusted_center_y

risk/network/plotter/contour.py

@@ -11,7 +11,7 @@ from scipy import linalg
 from scipy.ndimage import label
 from scipy.stats import gaussian_kde
 
-from risk.log import params, logger
+from risk.log import logger, params
 from risk.network.graph.graph import Graph
 from risk.network.plotter.utils.colors import get_annotated_domain_colors, to_rgba
 
@@ -213,7 +213,7 @@ class Contour:
                 ]
                 z = kde(np.vstack([x.ravel(), y.ravel()])).reshape(x.shape)
                 # Check if the KDE forms a single connected component
-                connected = _is_connected(z)
+                connected = self._is_connected(z)
                 if not connected:
                     bandwidth += 0.05  # Increase bandwidth slightly and retry
             except linalg.LinAlgError:
@@ -282,8 +282,8 @@ class Contour:
         scale_factor: float = 1.0,
         ids_to_colors: Union[Dict[int, Any], None] = None,
         random_seed: int = 888,
-    ) -> np.ndarray:
-        """Get colors for the contours based on node annotations or a specified colormap.
+    ) -> List[Tuple]:
+        """Get colors for the contours based on node annotation or a specified colormap.
 
         Args:
             cmap (str, optional): Name of the colormap to use for generating contour colors. Defaults to "gist_rainbow".
@@ -301,7 +301,7 @@ class Contour:
             random_seed (int, optional): Seed for random number generation to ensure reproducibility. Defaults to 888.
 
         Returns:
-            np.ndarray: Array of RGBA colors for contour annotations.
+            List[Tuple]: List of RGBA colors for the contours, one for each domain in the network graph.
         """
         return get_annotated_domain_colors(
             graph=self.graph,
@@ -316,15 +316,14 @@ class Contour:
             random_seed=random_seed,
         )
 
+    def _is_connected(self, z: np.ndarray) -> bool:
+        """Determine if a thresholded grid represents a single, connected component.
 
-def _is_connected(z: np.ndarray) -> bool:
-    """Determine if a thresholded grid represents a single, connected component.
-
-    Args:
-        z (np.ndarray): A binary grid where the component connectivity is evaluated.
+        Args:
+            z (np.ndarray): A binary grid where the component connectivity is evaluated.
 
-    Returns:
-        bool: True if the grid represents a single connected component, False otherwise.
-    """
-    _, num_features = label(z)
-    return num_features == 1  # Return True if only one connected component is found
+        Returns:
+            bool: True if the grid represents a single connected component, False otherwise.
+        """
+        _, num_features = label(z)
+        return num_features == 1  # Return True if only one connected component is found