scitex 2.0.0__py2.py3-none-any.whl

scitex/plt/ax/_style/_set_xyt.py

@@ -0,0 +1,121 @@
+#!./env/bin/python3
+# -*- coding: utf-8 -*-
+# Time-stamp: "2024-07-13 08:14:19 (ywatanabe)"
+# Author: Yusuke Watanabe (ywata1989@gmail.com)
+
+"""
+This script does XYZ.
+"""
+
+# Imports
+import matplotlib.pyplot as plt
+
+from ._format_label import format_label
+
+
+# Functions
+def set_xyt(ax, x=False, y=False, t=False, format_labels=True):
+    """Sets xlabel, ylabel and title"""
+
+    if x is not False:
+        x = format_label(x) if format_labels else x
+        ax.set_xlabel(x)
+
+    if y is not False:
+        y = format_label(y) if format_labels else y
+        ax.set_ylabel(y)
+
+    if t is not False:
+        t = format_label(t) if format_labels else t
+        ax.set_title(t)
+
+    return ax
+
+
+def set_xytc(ax, x=False, y=False, t=False, c=False, methods=False, stats=False, format_labels=True):
+    """Sets xlabel, ylabel, title, and caption with SciTeX-Paper integration
+    
+    Parameters
+    ----------
+    ax : matplotlib.axes.Axes or scitex AxisWrapper
+        The axes to modify
+    x : str or False, optional
+        X-axis label, by default False
+    y : str or False, optional 
+        Y-axis label, by default False
+    t : str or False, optional
+        Title, by default False
+    c : str or False, optional
+        Caption to store for later use with scitex.io.save(), by default False
+    methods : str or False, optional
+        Methods description for SciTeX-Paper integration, by default False
+    stats : str or False, optional
+        Statistical analysis details for SciTeX-Paper integration, by default False
+    format_labels : bool, optional
+        Whether to apply automatic formatting, by default True
+        
+    Returns
+    -------
+    ax : matplotlib.axes.Axes or scitex AxisWrapper
+        The modified axes
+        
+    Examples
+    --------
+    >>> fig, ax = scitex.plt.subplots()
+    >>> ax.plot(x, y)
+    >>> ax.set_xytc(x='Time (s)', y='Voltage (mV)', 
+    ...             t='Neural Signal', 
+    ...             c='Example neural recording showing action potentials.',
+    ...             methods='Intracellular recordings performed using patch-clamp technique.',
+    ...             stats='Data analyzed using t-test with p<0.05 significance.')
+    >>> scitex.io.save(fig, 'neural_signal.png')  # Caption automatically saved
+    """
+    # Set labels and title using existing function
+    set_xyt(ax, x=x, y=y, t=t, format_labels=format_labels)
+    
+    # Store caption and extended metadata for later use by scitex.io.save()
+    if c is not False or methods is not False or stats is not False:
+        # Store comprehensive metadata as axis attribute for retrieval by save function
+        metadata = {
+            'caption': c if c is not False else None,
+            'methods': methods if methods is not False else None,
+            'stats': stats if stats is not False else None
+        }
+        
+        if hasattr(ax, '_scitex_metadata'):
+            ax._scitex_metadata.update(metadata)
+        else:
+            # For matplotlib axes, store in figure metadata
+            fig = ax.get_figure()
+            if not hasattr(fig, '_scitex_metadata'):
+                fig._scitex_metadata = {}
+            # Use axis position as identifier
+            fig._scitex_metadata[ax] = metadata
+            
+        # Backward compatibility - also store simple caption
+        if c is not False:
+            if hasattr(ax, '_scitex_caption'):
+                ax._scitex_caption = c
+            else:
+                fig = ax.get_figure()
+                if not hasattr(fig, '_scitex_captions'):
+                    fig._scitex_captions = {}
+                fig._scitex_captions[ax] = c
+    
+    return ax
+
+
+if __name__ == "__main__":
+    # Start
+    CONFIG, sys.stdout, sys.stderr, plt, CC = scitex.gen.start(sys, plt)
+
+    # (YOUR AWESOME CODE)
+
+    # Close
+    scitex.gen.close(CONFIG)
+
+# EOF
+
+"""
+/ssh:ywatanabe@444:/home/ywatanabe/proj/entrance/scitex/plt/ax/_set_lt.py
+"""

scitex/plt/ax/_style/_share_axes.py

@@ -0,0 +1,264 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: "2025-05-01 08:47:27 (ywatanabe)"
+# File: /home/ywatanabe/proj/scitex_repo/src/scitex/plt/ax/_style/_share_axes.py
+# ----------------------------------------
+import os
+
+__FILE__ = "./src/scitex/plt/ax/_style/_share_axes.py"
+__DIR__ = os.path.dirname(__FILE__)
+# ----------------------------------------
+
+import matplotlib.pyplot as plt
+import scitex
+import numpy as np
+
+
+def sharexy(*multiple_axes):
+    """Share both x and y axis limits across multiple axes.
+
+    Synchronizes both x and y axis limits across all provided axes objects,
+    ensuring they all display the same data range. Useful for comparing
+    multiple plots on the same scale.
+
+    Parameters
+    ----------
+    *multiple_axes : matplotlib.axes.Axes or array of Axes
+        Variable number of axes objects to synchronize.
+
+    Examples
+    --------
+    >>> fig, (ax1, ax2, ax3) = plt.subplots(1, 3)
+    >>> ax1.plot([1, 2, 3], [1, 4, 9])
+    >>> ax2.plot([1, 2, 3], [2, 5, 8])
+    >>> ax3.plot([1, 2, 3], [3, 6, 10])
+    >>> sharexy(ax1, ax2, ax3)  # All axes now show same range
+
+    See Also
+    --------
+    sharex : Share only x-axis limits
+    sharey : Share only y-axis limits
+    """
+    sharex(*multiple_axes)
+    sharey(*multiple_axes)
+
+
+def sharex(*multiple_axes):
+    """Share x-axis limits across multiple axes.
+
+    Finds the global x-axis limits across all axes and applies them
+    to each axis, ensuring horizontal alignment of data.
+
+    Parameters
+    ----------
+    *multiple_axes : matplotlib.axes.Axes or array of Axes
+        Variable number of axes objects to synchronize.
+
+    Returns
+    -------
+    axes : axes object(s)
+        The modified axes with shared x-limits.
+    xlim : tuple
+        The (xmin, xmax) limits applied.
+
+    Examples
+    --------
+    >>> fig, axes = plt.subplots(2, 1)
+    >>> axes[0].plot([1, 5], [1, 2])
+    >>> axes[1].plot([2, 4], [3, 4])
+    >>> sharex(axes[0], axes[1])  # Both show x-range [1, 5]
+    """
+    xlim = get_global_xlim(*multiple_axes)
+    return set_xlims(*multiple_axes, xlim=xlim)
+
+
+def sharey(*multiple_axes):
+    """Share y-axis limits across multiple axes.
+
+    Finds the global y-axis limits across all axes and applies them
+    to each axis, ensuring vertical alignment of data.
+
+    Parameters
+    ----------
+    *multiple_axes : matplotlib.axes.Axes or array of Axes
+        Variable number of axes objects to synchronize.
+
+    Returns
+    -------
+    axes : axes object(s)
+        The modified axes with shared y-limits.
+    ylim : tuple
+        The (ymin, ymax) limits applied.
+
+    Examples
+    --------
+    >>> fig, axes = plt.subplots(1, 2)
+    >>> axes[0].plot([1, 2], [1, 5])
+    >>> axes[1].plot([1, 2], [2, 4])
+    >>> sharey(axes[0], axes[1])  # Both show y-range [1, 5]
+    """
+    ylim = get_global_ylim(*multiple_axes)
+    return set_ylims(*multiple_axes, ylim=ylim)
+
+
+def get_global_xlim(*multiple_axes):
+    """Get the global x-axis limits across multiple axes.
+
+    Scans all provided axes to find the minimum and maximum x-values
+    across all of them. Handles both single axes and arrays of axes.
+
+    Parameters
+    ----------
+    *multiple_axes : matplotlib.axes.Axes or array of Axes
+        Variable number of axes objects to scan.
+
+    Returns
+    -------
+    tuple
+        (xmin, xmax) representing the global x-axis limits.
+
+    Examples
+    --------
+    >>> fig, (ax1, ax2) = plt.subplots(1, 2)
+    >>> ax1.plot([1, 3], [1, 2])  # x-range: [1, 3]
+    >>> ax2.plot([2, 5], [1, 2])  # x-range: [2, 5]
+    >>> xlim = get_global_xlim(ax1, ax2)
+    >>> print(xlim)  # (1, 5)
+
+    Notes
+    -----
+    There appears to be a bug in the current implementation where
+    get_ylim() is called instead of get_xlim(). This should be fixed.
+    """
+    xmin, xmax = np.inf, -np.inf
+    for axes in multiple_axes:
+        # axes
+        if isinstance(axes, (np.ndarray, scitex.plt._subplots._AxesWrapper.AxesWrapper)):
+            for ax in axes.flat:
+                _xmin, _xmax = ax.get_xlim()  # Fixed: was get_ylim()
+                xmin = min(xmin, _xmin)
+                xmax = max(xmax, _xmax)
+        # axis
+        else:
+            ax = axes
+            _xmin, _xmax = ax.get_xlim()  # Fixed: was get_ylim()
+            xmin = min(xmin, _xmin)
+            xmax = max(xmax, _xmax)
+
+    return (xmin, xmax)
+
+
+# def get_global_xlim(*multiple_axes):
+#     xmin, xmax = np.inf, -np.inf
+#     for axes in multiple_axes:
+#         for ax in axes.flat:
+#             _xmin, _xmax = ax.get_xlim()
+#             xmin = min(xmin, _xmin)
+#             xmax = max(xmax, _xmax)
+#     return (xmin, xmax)
+
+
+def get_global_ylim(*multiple_axes):
+    """Get the global y-axis limits across multiple axes.
+
+    Scans all provided axes to find the minimum and maximum y-values
+    across all of them. Handles both single axes and arrays of axes.
+
+    Parameters
+    ----------
+    *multiple_axes : matplotlib.axes.Axes or array of Axes
+        Variable number of axes objects to scan.
+
+    Returns
+    -------
+    tuple
+        (ymin, ymax) representing the global y-axis limits.
+
+    Examples
+    --------
+    >>> fig, (ax1, ax2) = plt.subplots(1, 2)
+    >>> ax1.plot([1, 2], [1, 3])  # y-range: [1, 3]
+    >>> ax2.plot([1, 2], [2, 5])  # y-range: [2, 5]
+    >>> ylim = get_global_ylim(ax1, ax2)
+    >>> print(ylim)  # (1, 5)
+    """
+    ymin, ymax = np.inf, -np.inf
+    for axes in multiple_axes:
+        # axes
+        if isinstance(axes, (np.ndarray, scitex.plt._subplots._AxesWrapper.AxesWrapper)):
+            for ax in axes.flat:
+                _ymin, _ymax = ax.get_ylim()
+                ymin = min(ymin, _ymin)
+                ymax = max(ymax, _ymax)
+        # axis
+        else:
+            ax = axes
+            _ymin, _ymax = ax.get_ylim()
+            ymin = min(ymin, _ymin)
+            ymax = max(ymax, _ymax)
+
+    return (ymin, ymax)
+
+
+def set_xlims(*multiple_axes, xlim=None):
+    if xlim is None:
+        raise ValueError("Please set xlim. get_global_xlim() might be useful.")
+
+    for axes in multiple_axes:
+        # axes
+        if isinstance(axes, (np.ndarray, scitex.plt._subplots._AxesWrapper.AxesWrapper)):
+            for ax in axes.flat:
+                ax.set_xlim(xlim)
+        # axis
+        else:
+            ax = axes
+            ax.set_xlim(xlim)
+
+    # Return
+    if len(multiple_axes) == 1:
+        return multiple_axes[0], xlim
+    else:
+        return multiple_axes, xlim
+
+
+def set_ylims(*multiple_axes, ylim=None):
+    if ylim is None:
+        raise ValueError("Please set ylim. get_global_xlim() might be useful.")
+
+    for axes in multiple_axes:
+        # axes
+        if isinstance(axes, (np.ndarray, scitex.plt._subplots._AxesWrapper.AxesWrapper)):
+            for ax in axes.flat:
+                ax.set_ylim(ylim)
+
+        # axis
+        else:
+            ax = axes
+            ax.set_ylim(ylim)
+
+    # Return
+    if len(multiple_axes) == 1:
+        return multiple_axes[0], ylim
+    else:
+        return multiple_axes, ylim
+
+
+def main():
+    pass
+
+
+if __name__ == "__main__":
+    # # Argument Parser
+    # import argparse
+    import sys
+
+    # parser = argparse.ArgumentParser(description='')
+    # parser.add_argument('--var', '-v', type=int, default=1, help='')
+    # parser.add_argument('--flag', '-f', action='store_true', default=False, help='')
+    # args = parser.parse_args()
+    # Main
+    CONFIG, sys.stdout, sys.stderr, plt, CC = scitex.gen.start(sys, plt, verbose=False)
+    main()
+    scitex.gen.close(CONFIG, verbose=False, notify=False)
+
+# EOF

scitex/plt/ax/_style/_shift.py

@@ -0,0 +1,139 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+# Timestamp: "2025-05-02 09:00:54 (ywatanabe)"
+# File: /home/ywatanabe/proj/scitex_repo/src/scitex/plt/ax/_style/_shift.py
+# ----------------------------------------
+import os
+
+__FILE__ = "./src/scitex/plt/ax/_style/_shift.py"
+__DIR__ = os.path.dirname(__FILE__)
+# ----------------------------------------
+
+
+def shift(ax, dx=0, dy=0):
+    """
+    Adjusts the position of an Axes object within a Figure by specified offsets in centimeters.
+
+    This function modifies the position of a given matplotlib.axes.Axes object by shifting it horizontally and vertically within its parent figure. The shift amounts are specified in centimeters, and the function converts these values into the figure's coordinate system to perform the adjustment.
+
+    Parameters:
+    - ax (matplotlib.axes.Axes): The Axes object to modify. This must be an instance of a Matplotlib Axes.
+    - dx (float): The horizontal offset in centimeters. Positive values shift the Axes to the right, while negative values shift it to the left.
+    - dy (float): The vertical offset in centimeters. Positive values shift the Axes up, while negative values shift it down.
+
+    Returns:
+    - matplotlib.axes.Axes: The modified Axes object with the adjusted position.
+    """
+
+    bbox = ax.get_position()
+
+    # Convert centimeters to inches for consistency with matplotlib dimensions
+    dx_in, dy_in = dx / 2.54, dy / 2.54
+
+    # Calculate delta ratios relative to the figure size
+    fig = ax.get_figure()
+    fig_dx_in, fig_dy_in = fig.get_size_inches()
+    dx_ratio, dy_ratio = dx_in / fig_dx_in, dy_in / fig_dy_in
+
+    # Determine updated bbox position and optionally adjust dimensions
+    left = bbox.x0 + dx_ratio
+    bottom = bbox.y0 + dy_ratio
+    width = bbox.width
+    height = bbox.height
+
+    # Main
+    ax.set_position([left, bottom, width, height])
+
+    return ax
+
+
+# def adjust_axes_position_and_dimension(
+#     ax, dx, dy, adjust_width_for_dx=False, adjust_height_for_dy=False
+# ):
+
+# def set_pos(ax, x_cm, y_cm, extend_x=False, extend_y=False):
+#     """
+#     Adjusts the position of an Axes object within a Figure by a specified offset in centimeters.
+
+#     Parameters:
+#     - ax (matplotlib.axes.Axes): The Axes object to modify.
+#     - x_cm (float): The horizontal offset in centimeters to adjust the Axes position.
+#     - y_cm (float): The vertical offset in centimeters to adjust the Axes position.
+#     - extend_x (bool): If True, reduces the width of the Axes by the horizontal offset.
+#     - extend_y (bool): If True, reduces the height of the Axes by the vertical offset.
+
+#     Returns:
+#     - ax (matplotlib.axes.Axes): The modified Axes object with the adjusted position.
+#     """
+
+#     bbox = ax.get_position()
+
+#     # Inches
+#     x_in, y_in = x_cm / 2.54, y_cm / 2.54
+
+#     # Calculates delta ratios
+#     fig = ax.get_figure()
+#     fig_x_in, fig_y_in = fig.get_size_inches()
+#     x_ratio, y_ratio = x_in / fig_x_in, y_in / fig_y_in
+
+#     # Determines updated bbox position
+#     left = bbox.x0 + x_ratio
+#     bottom = bbox.y0 + y_ratio
+#     width = bbox.width
+#     height = bbox.height
+
+#     if extend_x:
+#         width -= x_ratio
+
+#     if extend_y:
+#         height -= y_ratio
+
+#     ax.set_position([left, bottom, width, height])
+
+#     return ax
+
+
+# def set_pos(
+#     fig,
+#     ax,
+#     x_cm,
+#     y_cm,
+#     dragh=False,
+#     dragv=False,
+# ):
+
+#     bbox = ax.get_position()
+
+#     ## Calculates delta ratios
+#     fig_x_in, fig_y_in = fig.get_size_inches()
+
+#     x_in = float(x_cm) / 2.54
+#     y_in = float(y_cm) / 2.54
+
+#     x_ratio = x_in / fig_x_in
+#     y_ratio = y_in / fig_x_in
+
+#     ## Determines updated bbox position
+#     left = bbox.x0 + x_ratio
+#     bottom = bbox.y0 + y_ratio
+#     width = bbox.x1 - bbox.x0
+#     height = bbox.y1 - bbox.y0
+
+#     if dragh:
+#         width -= x_ratio
+
+#     if dragv:
+#         height -= y_ratio
+
+#     ax.set_pos(
+#         [
+#             left,
+#             bottom,
+#             width,
+#             height,
+#         ]
+#     )
+
+#     return ax
+
+# EOF