Skip to content

network_plots

Network plots with matplotlib.

NetworkPlot

Bases: pathpyG.visualisations._matplotlib.core.MatplotlibPlot

Network plot class for a static network.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
 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
class NetworkPlot(MatplotlibPlot):
    """Network plot class for a static network."""

    _kind = "network"

    def __init__(self, data: dict, **kwargs: Any) -> None:
        """Initialize network plot class."""
        super().__init__()
        self.data = data
        self.config = kwargs
        self.generate()

    def generate(self) -> None:
        """Clen up data."""
        self._compute_node_data()
        self._compute_edge_data()

    def _compute_node_data(self) -> None:
        """Generate the data structure for the nodes."""
        default = {
            "uid": None,
            "x": 0,
            "y": 0,
            "size": 30,
            "color": "blue",
            "opacity": 1.0,
        }

        nodes: dict = {key: [] for key in default}

        for node in self.data["nodes"]:
            for key, value in default.items():
                nodes[key].append(node.get(key, value))

        self.data["nodes"] = nodes

    def _compute_edge_data(self) -> None:
        """Generate the data structure for the edges."""
        default = {
            "uid": None,
            "size": 5,
            "color": "red",
            "opacity": 1.0,
        }

        edges: dict = {**{key: [] for key in default}, **{"line": []}}

        for edge in self.data["edges"]:
            source = self.data["nodes"]["uid"].index(edge.get("source"))
            target = self.data["nodes"]["uid"].index(edge.get("target"))
            edges["line"].append(
                [
                    (self.data["nodes"]["x"][source], self.data["nodes"]["x"][target]),
                    (self.data["nodes"]["y"][source], self.data["nodes"]["y"][target]),
                ]
            )

            for key, value in default.items():
                edges[key].append(edge.get(key, value))

        self.data["edges"] = edges

    def to_fig(self) -> Any:
        """Convert data to figure."""
        import matplotlib.pyplot as plt

        fig, ax = plt.subplots()
        ax.set_axis_off()

        # plot edges
        for i in range(len(self.data["edges"]["uid"])):
            ax.plot(
                *self.data["edges"]["line"][i],
                color=self.data["edges"]["color"][i],
                alpha=self.data["edges"]["opacity"][i],
                zorder=1,
            )

        # plot nodes
        ax.scatter(
            self.data["nodes"]["x"],
            self.data["nodes"]["y"],
            s=self.data["nodes"]["size"],
            c=self.data["nodes"]["color"],
            alpha=self.data["nodes"]["opacity"],
            zorder=2,
        )
        return plt

__init__

Initialize network plot class.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
23
24
25
26
27
28
def __init__(self, data: dict, **kwargs: Any) -> None:
    """Initialize network plot class."""
    super().__init__()
    self.data = data
    self.config = kwargs
    self.generate()

generate

Clen up data.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
30
31
32
33
def generate(self) -> None:
    """Clen up data."""
    self._compute_node_data()
    self._compute_edge_data()

to_fig

Convert data to figure.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
 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
def to_fig(self) -> Any:
    """Convert data to figure."""
    import matplotlib.pyplot as plt

    fig, ax = plt.subplots()
    ax.set_axis_off()

    # plot edges
    for i in range(len(self.data["edges"]["uid"])):
        ax.plot(
            *self.data["edges"]["line"][i],
            color=self.data["edges"]["color"][i],
            alpha=self.data["edges"]["opacity"][i],
            zorder=1,
        )

    # plot nodes
    ax.scatter(
        self.data["nodes"]["x"],
        self.data["nodes"]["y"],
        s=self.data["nodes"]["size"],
        c=self.data["nodes"]["color"],
        alpha=self.data["nodes"]["opacity"],
        zorder=2,
    )
    return plt

StaticNetworkPlot

Bases: pathpyG.visualisations._matplotlib.network_plots.NetworkPlot

Network plot class for a static network.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
108
109
110
111
class StaticNetworkPlot(NetworkPlot):
    """Network plot class for a static network."""

    _kind = "static"

TemporalNetworkPlot

Bases: pathpyG.visualisations._matplotlib.network_plots.NetworkPlot

Network plot class for a static network.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
114
115
116
117
118
119
120
121
class TemporalNetworkPlot(NetworkPlot):
    """Network plot class for a static network."""

    _kind = "temporal"

    def __init__(self, data: dict, **kwargs: Any) -> None:
        """Initialize network plot class."""
        raise NotImplementedError

__init__

Initialize network plot class.

Source code in src/pathpyG/visualisations/_matplotlib/network_plots.py 
119
120
121
def __init__(self, data: dict, **kwargs: Any) -> None:
    """Initialize network plot class."""
    raise NotImplementedError