Skip to content

panchi.visualizations

The visualization module provides Animator2D, the single entry point for all 2D visualizations.

from panchi.visualizations import Animator2D

Animator2D

panchi.visualizations.Animator2D

2D visualization of vectors, matrices, and linear transformations.

Parameters:

Name Type Description Default
backend str

Visualization backend: "matplotlib" (default) or "manim".

 'matplotlib'
save_path str or Path

Directory for saving output. If None, matplotlib displays interactively and manim saves to ./media.

 None
quality str

Render quality: "low", "medium" (default), "high", or "production" (manim only).

 'medium'
figsize tuple[int, int]

Figure size in inches (matplotlib only). Default (8, 8).

 (8, 8)

Examples:

>>> from panchi import Vector, Matrix
>>> from panchi.visualizations import Animator2D
>>>
>>> animator = Animator2D()
>>> animator.plot_vectors(Vector([3, 2]), Vector([1, 3]))
>>> animator.animate_transform(Matrix([[0, -1], [1, 0]]))
Source code in panchi/visualizations/animator.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
class Animator2D:
    """2D visualization of vectors, matrices, and linear transformations.

    Parameters
    ----------
    backend : str
        Visualization backend: ``"matplotlib"`` (default) or ``"manim"``.
    save_path : str or Path, optional
        Directory for saving output. If ``None``, matplotlib displays
        interactively and manim saves to ``./media``.
    quality : str
        Render quality: ``"low"``, ``"medium"`` (default), ``"high"``,
        or ``"production"`` (manim only).
    figsize : tuple[int, int]
        Figure size in inches (matplotlib only). Default ``(8, 8)``.

    Examples
    --------
    >>> from panchi import Vector, Matrix
    >>> from panchi.visualizations import Animator2D
    >>>
    >>> animator = Animator2D()
    >>> animator.plot_vectors(Vector([3, 2]), Vector([1, 3]))
    >>> animator.animate_transform(Matrix([[0, -1], [1, 0]]))
    """

    def __init__(
        self,
        backend: str = "matplotlib",
        save_path: str | Path | None = None,
        quality: str = "medium",
        figsize: tuple[int, int] = (8, 8),
    ) -> None:
        resolved_path = Path(save_path) if save_path else None

        if backend == "matplotlib":
            from panchi.visualizations.matplotlib import _MatplotlibBackend

            self._backend: _BaseBackend = _MatplotlibBackend(
                save_path=resolved_path,
                quality=quality,
                figsize=figsize,
            )
        elif backend == "manim":
            from panchi.visualizations.manim import _ManimBackend

            self._backend = _ManimBackend(
                save_path=resolved_path or Path("./media"),
                quality=quality,
            )
        else:
            raise ValueError(
                f"Unknown backend '{backend}'. Choose 'matplotlib' or 'manim'."
            )

        self.backend = backend

    def plot_vectors(
        self,
        *vectors: Vector,
        colors: list[str] | None = None,
        labels: list[str] | None = None,
        grid: bool = True,
        name: str | None = None,
    ) -> None:
        """Plot one or more 2D vectors.

        Parameters
        ----------
        *vectors : Vector
            2D vectors to plot.
        colors : list[str], optional
            Colors for each vector.
        labels : list[str], optional
            Labels for each vector.
        grid : bool
            Whether to show grid lines. Default ``True``.
        name : str, optional
            Output filename (without extension) when saving.
        """
        self._validate_2d(*vectors)
        self._backend.plot_vectors(
            *vectors,
            colors=colors,
            labels=labels,
            grid=grid,
            name=name or "plot_vectors",
        )

    def animate_addition(
        self,
        v1: Vector,
        v2: Vector,
        frames: int = 60,
        interval: int = 30,
        name: str | None = None,
        colors: list[str] | None = None,
    ) -> None:
        """Animate the addition of two 2D vectors.

        Parameters
        ----------
        v1 : Vector
            First vector.
        v2 : Vector
            Second vector.
        frames : int
            Number of animation frames. Default ``60``.
        interval : int
            Milliseconds between frames. Default ``30``.
        name : str, optional
            Output filename (without extension) when saving.
        colors : list[str], optional
            Up to three colors for ``[v1, v2, v1 + v2]``. Any omitted role
            keeps its default. ``None`` uses the default palette.
        """
        self._validate_2d(v1, v2)
        self._backend.animate_addition(
            v1,
            v2,
            frames=frames,
            interval=interval,
            name=name or "animate_addition",
            colors=colors,
        )

    def animate_scaling(
        self,
        vector: Vector,
        scale_factor: float,
        frames: int = 60,
        interval: int = 30,
        name: str | None = None,
        colors: list[str] | None = None,
    ) -> None:
        """Animate scalar multiplication of a 2D vector.

        Parameters
        ----------
        vector : Vector
            Vector to scale.
        scale_factor : float
            Scaling factor.
        frames : int
            Number of animation frames. Default ``60``.
        interval : int
            Milliseconds between frames. Default ``30``.
        name : str, optional
            Output filename (without extension) when saving.
        colors : list[str], optional
            Up to two colors for ``[original, scaled]``. Any omitted role
            keeps its default. ``None`` uses the default palette.
        """
        self._validate_2d(vector)
        self._backend.animate_scaling(
            vector,
            scale_factor,
            frames=frames,
            interval=interval,
            name=name or "animate_scaling",
            colors=colors,
        )

    def animate_transform(
        self,
        matrix: Matrix,
        frames: int = 60,
        interval: int = 30,
        name: str | None = None,
        colors: list[str] | None = None,
    ) -> None:
        """Animate a 2x2 linear transformation with full grid deformation.

        Shows the standard basis vectors and coordinate grid morphing
        smoothly from the identity to the given matrix.

        Parameters
        ----------
        matrix : Matrix
            A 2x2 transformation matrix.
        frames : int
            Number of animation frames. Default ``60``.
        interval : int
            Milliseconds between frames. Default ``30``.
        name : str, optional
            Output filename (without extension) when saving.
        colors : list[str], optional
            Up to two colors for the basis arrows ``[e1, e2]``. Any omitted
            role keeps its default. ``None`` uses the default palette.
        """
        self._validate_2x2(matrix)
        self._backend.animate_transform(
            matrix,
            frames=frames,
            interval=interval,
            name=name or "animate_transform",
            colors=colors,
        )

    def plot_span(
        self,
        *vectors_or_space: Vector | VectorSpace,
        colors: list[str] | None = None,
        labels: list[str] | None = None,
        grid: bool = True,
        name: str | None = None,
        span_color: str | None = None,
    ) -> None:
        """Visualize the span of vectors with a shaded region and basis arrows.

        Accepts either a ``VectorSpace`` or one or more ``Vector`` objects.
        A 1D subspace is drawn as a line through the origin; a 2D subspace
        shades the entire plane.

        Parameters
        ----------
        *vectors_or_space : Vector or VectorSpace
            A single ``VectorSpace``, or one or more 2D ``Vector`` objects.
        colors : list[str], optional
            Colors for the basis vectors.
        labels : list[str], optional
            Labels for the basis vectors.
        grid : bool
            Whether to show grid lines. Default ``True``.
        name : str, optional
            Output filename (without extension) when saving.
        span_color : str, optional
            Color of the shaded span region. ``None`` uses the default.
        """
        vectors, space = self._resolve_span_input(vectors_or_space)
        self._validate_2d(*vectors)
        self._backend.plot_span(
            vectors,
            space,
            colors=colors,
            labels=labels,
            grid=grid,
            name=name or "plot_span",
            span_color=span_color,
        )

    @staticmethod
    def _validate_2d(*vectors: Vector) -> None:
        for v in vectors:
            if v.dims != 2:
                raise ValueError(
                    f"Only 2D vectors are supported for visualization. "
                    f"Got {v.dims}D vector: {v}"
                )

    @staticmethod
    def _validate_2x2(matrix: Matrix) -> None:
        if matrix.shape != (2, 2):
            raise ValueError(
                f"Only 2x2 matrices are supported for transformation "
                f"visualization. Got shape {matrix.rows}x{matrix.cols}."
            )

    @staticmethod
    def _resolve_span_input(
        args: tuple[Vector | VectorSpace, ...],
    ) -> tuple[list[Vector], VectorSpace]:
        if len(args) == 1 and isinstance(args[0], VectorSpace):
            space = args[0]
            return list(space.data), space

        vectors = []
        for arg in args:
            if not isinstance(arg, Vector):
                raise TypeError(
                    f"Expected Vector or VectorSpace, got {type(arg).__name__}."
                )
            vectors.append(arg)

        if not vectors:
            raise ValueError("At least one Vector or VectorSpace is required.")

        return vectors, VectorSpace(vectors)

animate_addition(v1, v2, frames=60, interval=30, name=None, colors=None)

Animate the addition of two 2D vectors.

Parameters:

Name Type Description Default
v1 Vector

First vector.

 required
v2 Vector

Second vector.

 required
frames int

Number of animation frames. Default 60.

 60
interval int

Milliseconds between frames. Default 30.

 30
name str

Output filename (without extension) when saving.

 None
colors list[str]

Up to three colors for [v1, v2, v1 + v2]. Any omitted role keeps its default. None uses the default palette.

 None
Source code in panchi/visualizations/animator.py 
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
def animate_addition(
    self,
    v1: Vector,
    v2: Vector,
    frames: int = 60,
    interval: int = 30,
    name: str | None = None,
    colors: list[str] | None = None,
) -> None:
    """Animate the addition of two 2D vectors.

    Parameters
    ----------
    v1 : Vector
        First vector.
    v2 : Vector
        Second vector.
    frames : int
        Number of animation frames. Default ``60``.
    interval : int
        Milliseconds between frames. Default ``30``.
    name : str, optional
        Output filename (without extension) when saving.
    colors : list[str], optional
        Up to three colors for ``[v1, v2, v1 + v2]``. Any omitted role
        keeps its default. ``None`` uses the default palette.
    """
    self._validate_2d(v1, v2)
    self._backend.animate_addition(
        v1,
        v2,
        frames=frames,
        interval=interval,
        name=name or "animate_addition",
        colors=colors,
    )

animate_scaling(vector, scale_factor, frames=60, interval=30, name=None, colors=None)

Animate scalar multiplication of a 2D vector.

Parameters:

Name Type Description Default
vector Vector

Vector to scale.

 required
scale_factor float

Scaling factor.

 required
frames int

Number of animation frames. Default 60.

 60
interval int

Milliseconds between frames. Default 30.

 30
name str

Output filename (without extension) when saving.

 None
colors list[str]

Up to two colors for [original, scaled]. Any omitted role keeps its default. None uses the default palette.

 None
Source code in panchi/visualizations/animator.py 
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
def animate_scaling(
    self,
    vector: Vector,
    scale_factor: float,
    frames: int = 60,
    interval: int = 30,
    name: str | None = None,
    colors: list[str] | None = None,
) -> None:
    """Animate scalar multiplication of a 2D vector.

    Parameters
    ----------
    vector : Vector
        Vector to scale.
    scale_factor : float
        Scaling factor.
    frames : int
        Number of animation frames. Default ``60``.
    interval : int
        Milliseconds between frames. Default ``30``.
    name : str, optional
        Output filename (without extension) when saving.
    colors : list[str], optional
        Up to two colors for ``[original, scaled]``. Any omitted role
        keeps its default. ``None`` uses the default palette.
    """
    self._validate_2d(vector)
    self._backend.animate_scaling(
        vector,
        scale_factor,
        frames=frames,
        interval=interval,
        name=name or "animate_scaling",
        colors=colors,
    )

animate_transform(matrix, frames=60, interval=30, name=None, colors=None)

Animate a 2x2 linear transformation with full grid deformation.

Shows the standard basis vectors and coordinate grid morphing smoothly from the identity to the given matrix.

Parameters:

Name Type Description Default
matrix Matrix

A 2x2 transformation matrix.

 required
frames int

Number of animation frames. Default 60.

 60
interval int

Milliseconds between frames. Default 30.

 30
name str

Output filename (without extension) when saving.

 None
colors list[str]

Up to two colors for the basis arrows [e1, e2]. Any omitted role keeps its default. None uses the default palette.

 None
Source code in panchi/visualizations/animator.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
def animate_transform(
    self,
    matrix: Matrix,
    frames: int = 60,
    interval: int = 30,
    name: str | None = None,
    colors: list[str] | None = None,
) -> None:
    """Animate a 2x2 linear transformation with full grid deformation.

    Shows the standard basis vectors and coordinate grid morphing
    smoothly from the identity to the given matrix.

    Parameters
    ----------
    matrix : Matrix
        A 2x2 transformation matrix.
    frames : int
        Number of animation frames. Default ``60``.
    interval : int
        Milliseconds between frames. Default ``30``.
    name : str, optional
        Output filename (without extension) when saving.
    colors : list[str], optional
        Up to two colors for the basis arrows ``[e1, e2]``. Any omitted
        role keeps its default. ``None`` uses the default palette.
    """
    self._validate_2x2(matrix)
    self._backend.animate_transform(
        matrix,
        frames=frames,
        interval=interval,
        name=name or "animate_transform",
        colors=colors,
    )

plot_span(*vectors_or_space, colors=None, labels=None, grid=True, name=None, span_color=None)

Visualize the span of vectors with a shaded region and basis arrows.

Accepts either a VectorSpace or one or more Vector objects. A 1D subspace is drawn as a line through the origin; a 2D subspace shades the entire plane.

Parameters:

Name Type Description Default
*vectors_or_space Vector or VectorSpace

A single VectorSpace, or one or more 2D Vector objects.

 ()
colors list[str]

Colors for the basis vectors.

 None
labels list[str]

Labels for the basis vectors.

 None
grid bool

Whether to show grid lines. Default True.

 True
name str

Output filename (without extension) when saving.

 None
span_color str

Color of the shaded span region. None uses the default.

 None
Source code in panchi/visualizations/animator.py 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
def plot_span(
    self,
    *vectors_or_space: Vector | VectorSpace,
    colors: list[str] | None = None,
    labels: list[str] | None = None,
    grid: bool = True,
    name: str | None = None,
    span_color: str | None = None,
) -> None:
    """Visualize the span of vectors with a shaded region and basis arrows.

    Accepts either a ``VectorSpace`` or one or more ``Vector`` objects.
    A 1D subspace is drawn as a line through the origin; a 2D subspace
    shades the entire plane.

    Parameters
    ----------
    *vectors_or_space : Vector or VectorSpace
        A single ``VectorSpace``, or one or more 2D ``Vector`` objects.
    colors : list[str], optional
        Colors for the basis vectors.
    labels : list[str], optional
        Labels for the basis vectors.
    grid : bool
        Whether to show grid lines. Default ``True``.
    name : str, optional
        Output filename (without extension) when saving.
    span_color : str, optional
        Color of the shaded span region. ``None`` uses the default.
    """
    vectors, space = self._resolve_span_input(vectors_or_space)
    self._validate_2d(*vectors)
    self._backend.plot_span(
        vectors,
        space,
        colors=colors,
        labels=labels,
        grid=grid,
        name=name or "plot_span",
        span_color=span_color,
    )

plot_vectors(*vectors, colors=None, labels=None, grid=True, name=None)

Plot one or more 2D vectors.

Parameters:

Name Type Description Default
*vectors Vector

2D vectors to plot.

 ()
colors list[str]

Colors for each vector.

 None
labels list[str]

Labels for each vector.

 None
grid bool

Whether to show grid lines. Default True.

 True
name str

Output filename (without extension) when saving.

 None
Source code in panchi/visualizations/animator.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def plot_vectors(
    self,
    *vectors: Vector,
    colors: list[str] | None = None,
    labels: list[str] | None = None,
    grid: bool = True,
    name: str | None = None,
) -> None:
    """Plot one or more 2D vectors.

    Parameters
    ----------
    *vectors : Vector
        2D vectors to plot.
    colors : list[str], optional
        Colors for each vector.
    labels : list[str], optional
        Labels for each vector.
    grid : bool
        Whether to show grid lines. Default ``True``.
    name : str, optional
        Output filename (without extension) when saving.
    """
    self._validate_2d(*vectors)
    self._backend.plot_vectors(
        *vectors,
        colors=colors,
        labels=labels,
        grid=grid,
        name=name or "plot_vectors",
    )