Skip to content

plotting

pleat.plotting

Matplotlib helpers for quick visualization of 2D line drawings.

plot_lines 

plot_lines(
    lines: NDArray, ax: Axes | None = None, **kwargs
) -> None

Add a :class:LineCollection of lines (shape (n, 2, 2)) to ax.

Extra keyword arguments are forwarded to :class:matplotlib.collections.LineCollection.

Source code in pleat/plotting.py 
12
13
14
15
16
17
18
19
def plot_lines(lines: NDArray, ax: Axes | None = None, **kwargs) -> None:
    """Add a :class:`LineCollection` of *lines* (shape ``(n, 2, 2)``) to *ax*.

    Extra keyword arguments are forwarded to :class:`matplotlib.collections.LineCollection`.
    """
    lc = mc.LineCollection(lines, **kwargs)
    ax = plt.gca() if ax is None else ax
    ax.add_collection(lc)

plot_polygon 

plot_polygon(points: NDArray, **kwargs) -> None

Plot the closed polygon defined by points (shape (n, 2)).

Source code in pleat/plotting.py 
22
23
24
25
26
27
28
29
30
31
32
def plot_polygon(points: NDArray, **kwargs) -> None:
    """Plot the closed polygon defined by *points* (shape ``(n, 2)``)."""
    plot_lines(
        np.stack(
            [
                points,
                np.concatenate([points[1:], points[:1]]),
            ]
        ),
        **kwargs,
    )

set_equal_aspect 

set_equal_aspect(ax: Axes | None = None) -> None

Set equal aspect ratio with a small margin on the current or given axes.

Source code in pleat/plotting.py 
35
36
37
38
39
def set_equal_aspect(ax: Axes | None = None) -> None:
    """Set equal aspect ratio with a small margin on the current or given axes."""
    ax = plt.gca() if ax is None else ax
    ax.set_aspect("equal", adjustable="box")
    ax.margins(0.05)