Skip to content

plot

PlotMixin

Bases: OverrideResolveMixin

Adds a plotting method to a data class.

Source code in src/torch_structure/mixins/plot.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class PlotMixin(OverrideResolveMixin):
    """Adds a plotting method to a data class."""

    def plot(
        self,
        coords=None,
        edge_index=None,
        is_support=None,
        force=None,
        load=None,
        **kwargs
    ):
        """Plot this structure's geometry, supports, forces, and loads.

        See [`torch_structure.plot.plot_data`](../plot/plot.md).
        """
        coords = self._resolve_override("coords", coords)
        edge_index = self._resolve_override("edge_index", edge_index)
        is_support = self._resolve_override("is_support", is_support, required=False)
        force = self._resolve_override("force", force, required=False)
        load = self._resolve_override("load", load, required=False)

        return plot_data(
            coords=coords,
            edge_index=edge_index,
            is_support=is_support,
            force=force,
            load=load,
            **kwargs
        )

plot(coords=None, edge_index=None, is_support=None, force=None, load=None, **kwargs)

Plot this structure's geometry, supports, forces, and loads.

See torch_structure.plot.plot_data.

Source code in src/torch_structure/mixins/plot.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def plot(
    self,
    coords=None,
    edge_index=None,
    is_support=None,
    force=None,
    load=None,
    **kwargs
):
    """Plot this structure's geometry, supports, forces, and loads.

    See [`torch_structure.plot.plot_data`](../plot/plot.md).
    """
    coords = self._resolve_override("coords", coords)
    edge_index = self._resolve_override("edge_index", edge_index)
    is_support = self._resolve_override("is_support", is_support, required=False)
    force = self._resolve_override("force", force, required=False)
    load = self._resolve_override("load", load, required=False)

    return plot_data(
        coords=coords,
        edge_index=edge_index,
        is_support=is_support,
        force=force,
        load=load,
        **kwargs
    )