scitex 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

scitex/plt/_subplots/_export_as_csv_formatters/verify_formatters.py

@@ -38,7 +38,7 @@ def test_all_formatters():
 
 def test_plot_kde():
     """Test KDE plotting and CSV export."""
-    print("Testing plot_kde...")
+    print("Testing stx_kde...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -48,7 +48,7 @@ def test_plot_kde():
     data = np.concatenate([np.random.normal(0, 1, 500), np.random.normal(5, 1, 300)])
     
     # Plot with ID for tracking
-    ax.plot_kde(data, label="Bimodal Distribution", id="kde_test")
+    ax.stx_kde(data, label="Bimodal Distribution", id="kde_test")
     
     # Style the plot
     ax.set_xyt("Value", "Density", "KDE Test")
@@ -69,11 +69,11 @@ def test_plot_kde():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_kde test successful")
+    print("✓ stx_kde test successful")
 
 def test_plot_image():
     """Test image plotting and CSV export."""
-    print("Testing plot_image...")
+    print("Testing stx_image...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -83,7 +83,7 @@ def test_plot_image():
     data = np.random.rand(20, 20)
     
     # Plot with ID for tracking
-    ax.plot_image(data, cmap="viridis", id="image_test")
+    ax.stx_image(data, cmap="viridis", id="image_test")
     
     # Style the plot
     ax.set_xyt("X", "Y", "Image Test")
@@ -103,11 +103,11 @@ def test_plot_image():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_image test successful")
+    print("✓ stx_image test successful")
 
 def test_plot_shaded_line():
     """Test shaded line plotting and CSV export."""
-    print("Testing plot_shaded_line...")
+    print("Testing stx_shaded_line...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -120,7 +120,7 @@ def test_plot_shaded_line():
     y_upper = y_middle + 0.2
     
     # Plot with ID for tracking
-    ax.plot_shaded_line(x, y_lower, y_middle, y_upper, label="Sine with error", id="shaded_line_test")
+    ax.stx_shaded_line(x, y_lower, y_middle, y_upper, label="Sine with error", id="shaded_line_test")
     
     # Style the plot
     ax.set_xyt("X", "Y", "Shaded Line Test")
@@ -140,11 +140,11 @@ def test_plot_shaded_line():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_shaded_line test successful")
+    print("✓ stx_shaded_line test successful")
 
 def test_plot_scatter_hist():
     """Test scatter histogram plotting and CSV export."""
-    print("Testing plot_scatter_hist...")
+    print("Testing stx_scatter_hist...")
     
     # Create figure
     fig, ax = scitex.plt.subplots(figsize=(8, 8))
@@ -155,7 +155,7 @@ def test_plot_scatter_hist():
     y = x + np.random.normal(0, 0.5, 500)
     
     # Plot with ID for tracking
-    ax.plot_scatter_hist(x, y, hist_bins=30, scatter_alpha=0.7, id="scatter_hist_test")
+    ax.stx_scatter_hist(x, y, hist_bins=30, scatter_alpha=0.7, id="scatter_hist_test")
     
     # Style the plot
     ax.set_xyt("X Values", "Y Values", "Scatter Histogram Test")
@@ -174,11 +174,11 @@ def test_plot_scatter_hist():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_scatter_hist test successful")
+    print("✓ stx_scatter_hist test successful")
 
 def test_plot_violin():
     """Test violin plotting and CSV export."""
-    print("Testing plot_violin...")
+    print("Testing stx_violin...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -193,7 +193,7 @@ def test_plot_violin():
     labels = ["Group A", "Group B", "Group C"]
     
     # Plot with ID for tracking
-    ax.plot_violin(data, labels=labels, colors=["red", "blue", "green"], id="violin_test")
+    ax.stx_violin(data, labels=labels, colors=["red", "blue", "green"], id="violin_test")
     
     # Style the plot
     ax.set_xyt("Groups", "Values", "Violin Plot Test")
@@ -212,11 +212,11 @@ def test_plot_violin():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_violin test successful")
+    print("✓ stx_violin test successful")
 
 def test_plot_heatmap():
     """Test heatmap plotting and CSV export."""
-    print("Testing plot_heatmap...")
+    print("Testing stx_heatmap...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -228,7 +228,7 @@ def test_plot_heatmap():
     y_labels = [f"Y{ii+1}" for ii in range(10)]
     
     # Plot with ID for tracking
-    ax.plot_heatmap(
+    ax.stx_heatmap(
         data,
         x_labels=x_labels,
         y_labels=y_labels,
@@ -256,11 +256,11 @@ def test_plot_heatmap():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_heatmap test successful")
+    print("✓ stx_heatmap test successful")
 
 def test_plot_ecdf():
     """Test ECDF plotting and CSV export."""
-    print("Testing plot_ecdf...")
+    print("Testing stx_ecdf...")
     
     # Create figure
     fig, ax = scitex.plt.subplots()
@@ -270,7 +270,7 @@ def test_plot_ecdf():
     data = np.random.normal(0, 1, 1000)
     
     # Plot with ID for tracking
-    ax.plot_ecdf(data, label="Normal Distribution", id="ecdf_test")
+    ax.stx_ecdf(data, label="Normal Distribution", id="ecdf_test")
     
     # Style the plot
     ax.set_xyt("Value", "Cumulative Probability", "ECDF Test")
@@ -290,7 +290,7 @@ def test_plot_ecdf():
     
     # Close figure
     scitex.plt.close(fig)
-    print("✓ plot_ecdf test successful")
+    print("✓ stx_ecdf test successful")
 
 def test_multiple_plots():
     """Test multiple plots on the same axis."""
@@ -306,8 +306,8 @@ def test_multiple_plots():
     y2 = np.cos(x)
     
     # Create multiple plots with different IDs
-    ax.plot_line(y1, label="Sine", id="multi_test_sine")
-    ax.plot_line(y2, label="Cosine", id="multi_test_cosine")
+    ax.stx_line(y1, label="Sine", id="multi_test_sine")
+    ax.stx_line(y2, label="Cosine", id="multi_test_cosine")
     
     # Style the plot
     ax.set_xyt("X", "Y", "Multiple Plots Test")

scitex/plt/ax/__init__.py

@@ -55,26 +55,27 @@ from ._style._style_errorbar import style_errorbar
 from ._style._style_barplot import style_barplot
 from ._style._style_scatter import style_scatter
 from ._style._style_suptitles import style_suptitles
+from ._style._style_violinplot import style_violinplot
 
 # Plot
-from ._plot._plot_heatmap import plot_heatmap
+from ._plot._stx_heatmap import stx_heatmap
 from ._plot._plot_circular_hist import plot_circular_hist
-from ._plot._plot_conf_mat import plot_conf_mat
+from ._plot._stx_conf_mat import stx_conf_mat
 from ._plot._plot_cube import plot_cube
-from ._plot._plot_ecdf import plot_ecdf
-from ._plot._plot_fillv import plot_fillv
-from ._plot._plot_violin import plot_violin
-from ._plot._plot_image import plot_image
-from ._plot._plot_joyplot import plot_joyplot
-from ._plot._plot_raster import plot_raster
-from ._plot._plot_rectangle import plot_rectangle
-from ._plot._plot_scatter_hist import plot_scatter_hist
-from ._plot._plot_shaded_line import plot_shaded_line
+from ._plot._stx_ecdf import stx_ecdf
+from ._plot._stx_fillv import stx_fillv
+from ._plot._stx_violin import stx_violin
+from ._plot._stx_image import stx_image
+from ._plot._stx_joyplot import stx_joyplot
+from ._plot._stx_raster import stx_raster
+from ._plot._stx_rectangle import stx_rectangle
+from ._plot._stx_scatter_hist import stx_scatter_hist
+from ._plot._stx_shaded_line import stx_shaded_line
 from ._plot._plot_statistical_shaded_line import (
-    plot_line,
-    plot_mean_std,
-    plot_mean_ci,
-    plot_median_iqr,
+    stx_line,
+    stx_mean_std,
+    stx_mean_ci,
+    stx_median_iqr,
 )
 from ._plot._add_fitted_line import add_fitted_line
 

scitex/plt/ax/_plot/__init__.py

@@ -8,47 +8,47 @@ import os
 __FILE__ = "./src/scitex/plt/ax/_plot/__init__.py"
 __DIR__ = os.path.dirname(__FILE__)
 
-from ._plot_scatter_hist import plot_scatter_hist
-from ._plot_heatmap import plot_heatmap
+from ._stx_scatter_hist import stx_scatter_hist
+from ._stx_heatmap import stx_heatmap
 from ._plot_circular_hist import plot_circular_hist
-from ._plot_conf_mat import plot_conf_mat
+from ._stx_conf_mat import stx_conf_mat
 from ._plot_cube import plot_cube
-from ._plot_ecdf import plot_ecdf
-from ._plot_fillv import plot_fillv
-from ._plot_violin import plot_violin, sns_plot_violin
-from ._plot_image import plot_image
-from ._plot_joyplot import plot_joyplot
-from ._plot_raster import plot_raster
-from ._plot_rectangle import plot_rectangle
-from ._plot_shaded_line import plot_shaded_line, _plot_single_shaded_line
+from ._stx_ecdf import stx_ecdf
+from ._stx_fillv import stx_fillv
+from ._stx_violin import stx_violin, sns_plot_violin
+from ._stx_image import stx_image
+from ._stx_joyplot import stx_joyplot
+from ._stx_raster import stx_raster
+from ._stx_rectangle import stx_rectangle
+from ._stx_shaded_line import stx_shaded_line, _plot_single_shaded_line
 from ._plot_statistical_shaded_line import (
-    plot_line,
-    plot_mean_std,
-    plot_mean_ci,
-    plot_median_iqr,
+    stx_line,
+    stx_mean_std,
+    stx_mean_ci,
+    stx_median_iqr,
 )
 from ._add_fitted_line import add_fitted_line
 
 __all__ = [
-    "plot_scatter_hist",
-    "plot_heatmap",
+    "stx_scatter_hist",
+    "stx_heatmap",
     "plot_circular_hist",
-    "plot_conf_mat",
+    "stx_conf_mat",
     "plot_cube",
-    "plot_ecdf",
-    "plot_fillv",
-    "plot_violin",
+    "stx_ecdf",
+    "stx_fillv",
+    "stx_violin",
     "sns_plot_violin",
-    "plot_image",
-    "plot_joyplot",
-    "plot_raster",
-    "plot_rectangle",
-    "plot_shaded_line",
+    "stx_image",
+    "stx_joyplot",
+    "stx_raster",
+    "stx_rectangle",
+    "stx_shaded_line",
     "_plot_single_shaded_line",
-    "plot_line",
-    "plot_mean_std",
-    "plot_mean_ci",
-    "plot_median_iqr",
+    "stx_line",
+    "stx_mean_std",
+    "stx_mean_ci",
+    "stx_median_iqr",
     "add_fitted_line",
 ]
 

scitex/plt/ax/_plot/_add_fitted_line.py

@@ -8,7 +8,7 @@ Add fitted regression line to scatter plots.
 """
 
 import numpy as np
-from typing import Optional, Tuple
+from typing import Optional, Tuple, Dict
 
 
 def add_fitted_line(
@@ -20,9 +20,12 @@ def add_fitted_line(
     linewidth_mm: float = 0.2,
     label: Optional[str] = None,
     degree: int = 1,
+    show_stats: bool = True,
+    stats_position: float = 0.75,
+    stats_fontsize: int = 6,
 ) -> Tuple:
     """
-    Add a fitted polynomial line to a scatter plot.
+    Add a fitted polynomial line to a scatter plot with optional R² and p-value.
 
     Parameters
     ----------
@@ -42,6 +45,13 @@ def add_fitted_line(
         Label for the fitted line (default: None)
     degree : int, optional
         Polynomial degree for fitting (default: 1 for linear)
+    show_stats : bool, optional
+        Whether to display R² and p-value near the line (default: True)
+        Only applicable for linear fits (degree=1)
+    stats_position : float, optional
+        Position along x-axis (0-1 scale) for stats text (default: 0.75)
+    stats_fontsize : int, optional
+        Font size for statistics text in points (default: 6)
 
     Returns
     -------
@@ -49,19 +59,24 @@ def add_fitted_line(
         The fitted line object
     coeffs : np.ndarray
         Polynomial coefficients from np.polyfit
+    stats : StatResult or None
+        StatResult instance with correlation statistics (only for degree=1).
+        Use .to_dict() for dictionary format.
 
     Examples
     --------
     >>> fig, ax = stx.plt.subplots(**stx.plt.presets.SCITEX_STYLE)
     >>> scatter = ax.scatter(x, y)
-    >>> stx.plt.ax.add_fitted_line(ax, x, y)
-
-    >>> # With custom styling
-    >>> line, coeffs = stx.plt.ax.add_fitted_line(
-    ...     ax, x, y,
-    ...     color='blue',
-    ...     linestyle='-',
-    ...     label='Linear fit'
+    >>> stx.plt.ax.add_fitted_line(ax, x, y)  # Auto-shows R² and p
+
+    >>> # Without statistics
+    >>> line, coeffs, stats = stx.plt.ax.add_fitted_line(
+    ...     ax, x, y, show_stats=False
+    ... )
+
+    >>> # Custom position for stats
+    >>> line, coeffs, stats = stx.plt.ax.add_fitted_line(
+    ...     ax, x, y, stats_position=0.5
     ... )
     """
     from scitex.plt.utils import mm_to_pt
@@ -91,7 +106,46 @@ def add_fitted_line(
         label=label,
     )[0]
 
-    return line, coeffs
+    # Calculate and display statistics for linear regression (degree=1)
+    stats_result = None
+    if degree == 1 and show_stats:
+        # Import scitex.stats correlation test
+        from scitex.stats.tests.correlation import test_pearson
+
+        # Calculate correlation statistics using scitex.stats
+        stats_result = test_pearson(x, y)
+
+        # Position for text annotation
+        x_pos = x.min() + stats_position * (x.max() - x.min())
+        y_pos = poly_fn(x_pos)
+
+        # Format statistics text with R² and significance stars
+        r_squared = stats_result.effect_size['value']  # r_squared from effect_size
+        stars = stats_result.stars
+
+        if stars and stars != 'ns':  # Only show if significant
+            stats_text = f"$R^2$ = {r_squared:.3f}{stars}"
+        else:  # Not significant
+            stats_text = f"$R^2$ = {r_squared:.3f} (ns)"
+
+        # Add text annotation near the line
+        ax.text(
+            x_pos, y_pos,
+            stats_text,
+            verticalalignment='bottom',
+            fontsize=stats_fontsize
+        )
+
+        # Store stats in axes metadata for embedding in saved figures
+        if not hasattr(ax, '_scitex_metadata'):
+            ax._scitex_metadata = {}
+        if 'stats' not in ax._scitex_metadata:
+            ax._scitex_metadata['stats'] = []
+
+        # Add this StatResult to the stats list
+        ax._scitex_metadata['stats'].append(stats_result.to_dict())
+
+    return line, coeffs, stats_result
 
 
 # EOF