figrecipe 0.6.0__py3-none-any.whl → 0.7.4__py3-none-any.whl

figrecipe/_editor/_bbox/_extract.py

@@ -0,0 +1,256 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""
+Main bounding box extraction function.
+
+This module contains the main extract_bboxes function that coordinates
+all element-specific bbox extractors.
+"""
+
+from typing import Any, Dict
+
+from matplotlib.figure import Figure
+from matplotlib.transforms import Bbox
+
+from ._elements import get_element_bbox
+from ._extract_axes import (
+    extract_collections,
+    extract_images,
+    extract_lines,
+    extract_patches,
+)
+from ._extract_text import (
+    extract_figure_text,
+    extract_legend,
+    extract_spines,
+    extract_text_elements,
+)
+
+
+def extract_bboxes(
+    fig: Figure,
+    img_width: int,
+    img_height: int,
+    include_points: bool = True,
+) -> Dict[str, Dict[str, Any]]:
+    """
+    Extract bounding boxes for all figure elements.
+
+    Parameters
+    ----------
+    fig : matplotlib.figure.Figure
+        Figure to extract bboxes from.
+    img_width : int
+        Width of the output image in pixels.
+    img_height : int
+        Height of the output image in pixels.
+    include_points : bool, optional
+        Whether to include point arrays for lines/scatter (default: True).
+
+    Returns
+    -------
+    dict
+        Mapping from element key to bbox info.
+    """
+    bboxes = {}
+
+    # Get renderer for bbox calculations
+    fig.canvas.draw()
+    renderer = fig.canvas.get_renderer()
+
+    # Get tight bbox for coordinate transformation
+    tight_bbox = fig.get_tightbbox(renderer)
+    if tight_bbox is None:
+        tight_bbox = Bbox.from_bounds(0, 0, fig.get_figwidth(), fig.get_figheight())
+
+    # bbox_inches='tight' adds pad_inches (default 0.1) around the tight bbox
+    pad_inches = 0.1
+    saved_width_inches = tight_bbox.width + 2 * pad_inches
+    saved_height_inches = tight_bbox.height + 2 * pad_inches
+
+    # Calculate scale factors from saved image size to pixel size
+    scale_x = img_width / saved_width_inches if saved_width_inches > 0 else 1
+    scale_y = img_height / saved_height_inches if saved_height_inches > 0 else 1
+
+    # Process each axes
+    for ax_idx, ax in enumerate(fig.get_axes()):
+        _extract_axes_bboxes(
+            ax,
+            ax_idx,
+            fig,
+            renderer,
+            tight_bbox,
+            img_width,
+            img_height,
+            scale_x,
+            scale_y,
+            pad_inches,
+            saved_height_inches,
+            include_points,
+            bboxes,
+        )
+
+    # Process figure-level text elements
+    extract_figure_text(
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+
+    # Add metadata
+    bboxes["_meta"] = {
+        "img_width": img_width,
+        "img_height": img_height,
+        "fig_width_inches": fig.get_figwidth(),
+        "fig_height_inches": fig.get_figheight(),
+        "dpi": fig.dpi,
+    }
+
+    return bboxes
+
+
+def _extract_axes_bboxes(
+    ax,
+    ax_idx,
+    fig,
+    renderer,
+    tight_bbox,
+    img_width,
+    img_height,
+    scale_x,
+    scale_y,
+    pad_inches,
+    saved_height_inches,
+    include_points,
+    bboxes,
+):
+    """Extract bboxes for all elements within an axes."""
+    # Axes bounding box
+    ax_bbox = get_element_bbox(
+        ax,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+    )
+    if ax_bbox:
+        bboxes[f"ax{ax_idx}_axes"] = {**ax_bbox, "type": "axes", "ax_index": ax_idx}
+
+    # Extract all element types
+    extract_lines(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        include_points,
+        bboxes,
+    )
+    extract_collections(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        include_points,
+        bboxes,
+    )
+    extract_patches(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+    extract_images(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+    extract_text_elements(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+    extract_legend(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+    extract_spines(
+        ax,
+        ax_idx,
+        fig,
+        renderer,
+        tight_bbox,
+        img_width,
+        img_height,
+        scale_x,
+        scale_y,
+        pad_inches,
+        saved_height_inches,
+        bboxes,
+    )
+
+
+__all__ = ["extract_bboxes"]
+
+# EOF

figrecipe/_editor/_bbox/_extract_axes.py

@@ -0,0 +1,370 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Axes element bbox extraction (lines, collections, patches, images)."""
+
+from matplotlib.collections import PathCollection, PolyCollection
+from matplotlib.patches import Rectangle
+
+from ._collections import get_collection_bbox, get_patch_bbox
+from ._elements import get_element_bbox
+from ._lines import get_line_bbox, get_quiver_bbox
+
+
+def extract_lines(
+    ax,
+    ax_idx,
+    fig,
+    renderer,
+    tight_bbox,
+    img_width,
+    img_height,
+    scale_x,
+    scale_y,
+    pad_inches,
+    saved_height_inches,
+    include_points,
+    bboxes,
+):
+    """Extract bboxes for line elements."""
+    for i, line in enumerate(ax.get_lines()):
+        if not line.get_visible():
+            continue
+        xdata = line.get_xdata()
+        ydata = line.get_ydata()
+        if len(xdata) == 0 or len(ydata) == 0:
+            continue
+        if line.axes != ax:
+            continue
+
+        bbox = get_line_bbox(
+            line,
+            ax,
+            fig,
+            renderer,
+            tight_bbox,
+            img_width,
+            img_height,
+            scale_x,
+            scale_y,
+            pad_inches,
+            saved_height_inches,
+            include_points,
+        )
+        if bbox:
+            bboxes[f"ax{ax_idx}_line{i}"] = {
+                **bbox,
+                "type": "line",
+                "label": line.get_label() or f"line_{i}",
+                "ax_index": ax_idx,
+            }
+
+
+def extract_collections(
+    ax,
+    ax_idx,
+    fig,
+    renderer,
+    tight_bbox,
+    img_width,
+    img_height,
+    scale_x,
+    scale_y,
+    pad_inches,
+    saved_height_inches,
+    include_points,
+    bboxes,
+):
+    """Extract bboxes for collection elements (scatter, fill, quiver, etc.)."""
+    from matplotlib.collections import LineCollection, QuadMesh
+    from matplotlib.contour import QuadContourSet
+    from matplotlib.quiver import Quiver
+
+    scatter_idx = 0
+    for i, coll in enumerate(ax.collections):
+        if isinstance(coll, Quiver):
+            if not coll.get_visible():
+                continue
+            bbox = get_quiver_bbox(
+                coll,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_quiver{i}"] = {
+                    **bbox,
+                    "type": "quiver",
+                    "label": coll.get_label() or f"quiver_{i}",
+                    "ax_index": ax_idx,
+                }
+
+        elif isinstance(coll, PathCollection):
+            if not coll.get_visible():
+                continue
+            bbox = get_collection_bbox(
+                coll,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+                include_points,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_scatter{scatter_idx}"] = {
+                    **bbox,
+                    "type": "scatter",
+                    "label": coll.get_label() or f"scatter_{scatter_idx}",
+                    "ax_index": ax_idx,
+                }
+            scatter_idx += 1
+
+        elif isinstance(coll, PolyCollection):
+            if not coll.get_visible():
+                continue
+            bbox = get_collection_bbox(
+                coll,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+                False,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_fill{i}"] = {
+                    **bbox,
+                    "type": "fill",
+                    "label": coll.get_label() or f"fill_{i}",
+                    "ax_index": ax_idx,
+                }
+
+        elif isinstance(coll, LineCollection):
+            if not coll.get_visible():
+                continue
+            bbox = get_collection_bbox(
+                coll,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+                False,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_linecoll{i}"] = {
+                    **bbox,
+                    "type": "linecollection",
+                    "label": coll.get_label() or f"linecoll_{i}",
+                    "ax_index": ax_idx,
+                }
+
+        elif isinstance(coll, QuadMesh):
+            if not coll.get_visible():
+                continue
+            bbox = get_collection_bbox(
+                coll,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+                False,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_quadmesh{i}"] = {
+                    **bbox,
+                    "type": "quadmesh",
+                    "label": f"quadmesh_{i}",
+                    "ax_index": ax_idx,
+                }
+
+        elif isinstance(coll, QuadContourSet):
+            bbox = get_element_bbox(
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_contour{i}"] = {
+                    **bbox,
+                    "type": "contour",
+                    "label": f"contour_{i}",
+                    "ax_index": ax_idx,
+                }
+
+
+def extract_patches(
+    ax,
+    ax_idx,
+    fig,
+    renderer,
+    tight_bbox,
+    img_width,
+    img_height,
+    scale_x,
+    scale_y,
+    pad_inches,
+    saved_height_inches,
+    bboxes,
+):
+    """Extract bboxes for patch elements (bars, wedges, polygons)."""
+    from matplotlib.patches import Polygon, Wedge
+
+    bar_idx = 0
+    for i, patch in enumerate(ax.patches):
+        if isinstance(patch, Rectangle):
+            if not patch.get_visible():
+                continue
+            if patch.get_width() == 1.0 and patch.get_height() == 1.0:
+                continue
+            bbox = get_patch_bbox(
+                patch,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_bar{bar_idx}"] = {
+                    **bbox,
+                    "type": "bar",
+                    "label": patch.get_label() or f"bar_{bar_idx}",
+                    "ax_index": ax_idx,
+                }
+            bar_idx += 1
+
+        elif isinstance(patch, Wedge):
+            if not patch.get_visible():
+                continue
+            bbox = get_patch_bbox(
+                patch,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_wedge{i}"] = {
+                    **bbox,
+                    "type": "pie",
+                    "label": patch.get_label() or f"wedge_{i}",
+                    "ax_index": ax_idx,
+                }
+
+        elif isinstance(patch, Polygon):
+            if not patch.get_visible():
+                continue
+            bbox = get_patch_bbox(
+                patch,
+                ax,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_polygon{i}"] = {
+                    **bbox,
+                    "type": "fill",
+                    "label": patch.get_label() or f"fill_{i}",
+                    "ax_index": ax_idx,
+                }
+
+
+def extract_images(
+    ax,
+    ax_idx,
+    fig,
+    renderer,
+    tight_bbox,
+    img_width,
+    img_height,
+    scale_x,
+    scale_y,
+    pad_inches,
+    saved_height_inches,
+    bboxes,
+):
+    """Extract bboxes for image elements."""
+    from matplotlib.image import AxesImage
+
+    for i, img in enumerate(ax.images):
+        if isinstance(img, AxesImage):
+            if not img.get_visible():
+                continue
+            bbox = get_element_bbox(
+                img,
+                fig,
+                renderer,
+                tight_bbox,
+                img_width,
+                img_height,
+                scale_x,
+                scale_y,
+                pad_inches,
+                saved_height_inches,
+            )
+            if bbox:
+                bboxes[f"ax{ax_idx}_image{i}"] = {
+                    **bbox,
+                    "type": "image",
+                    "label": img.get_label() or f"image_{i}",
+                    "ax_index": ax_idx,
+                }
+
+
+__all__ = ["extract_lines", "extract_collections", "extract_patches", "extract_images"]
+
+# EOF