Skip to content

hist_plots

Histogram plot classes.

HistogramPlot

Bases: pathpyG.visualisations.plot.PathPyPlot

Histogram plot class for a network property.

Source code in src/pathpyG/visualisations/hist_plots.py 
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
class HistogramPlot(PathPyPlot):
    """Histogram plot class for a network property."""

    _kind = "hist"

    def __init__(self, network: Graph, key: str = "indegrees", bins: int = 10, **kwargs: Any) -> None:
        """Initialize network plot class."""
        super().__init__()
        self.network = network
        self.config = kwargs
        self.config["bins"] = bins
        self.config["key"] = key
        self.generate()

    def generate(self) -> None:
        """Generate the plot."""
        logger.debug("Generate histogram.")

        data: dict = {}

        match self.config["key"]:
            case "indegrees":
                logger.debug("Generate data for in-degrees")
                data["values"] = list(self.network.degrees(mode="in").values())
            case "outdegrees":
                logger.debug("Generate data for out-degrees")
                data["values"] = list(self.network.degrees(mode="out").values())
            case _:
                logger.error(
                    f"The <{self.config['key']}> property",
                    "is currently not supported for hist plots.",
                )
                raise KeyError

        data["title"] = self.config["key"]
        self.data["data"] = data

__init__

Initialize network plot class.

Source code in src/pathpyG/visualisations/hist_plots.py 
27
28
29
30
31
32
33
34
def __init__(self, network: Graph, key: str = "indegrees", bins: int = 10, **kwargs: Any) -> None:
    """Initialize network plot class."""
    super().__init__()
    self.network = network
    self.config = kwargs
    self.config["bins"] = bins
    self.config["key"] = key
    self.generate()

generate

Generate the plot.

Source code in src/pathpyG/visualisations/hist_plots.py 
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def generate(self) -> None:
    """Generate the plot."""
    logger.debug("Generate histogram.")

    data: dict = {}

    match self.config["key"]:
        case "indegrees":
            logger.debug("Generate data for in-degrees")
            data["values"] = list(self.network.degrees(mode="in").values())
        case "outdegrees":
            logger.debug("Generate data for out-degrees")
            data["values"] = list(self.network.degrees(mode="out").values())
        case _:
            logger.error(
                f"The <{self.config['key']}> property",
                "is currently not supported for hist plots.",
            )
            raise KeyError

    data["title"] = self.config["key"]
    self.data["data"] = data

hist

Plot a histogram.

Source code in src/pathpyG/visualisations/hist_plots.py 
17
18
19
def hist(network: Graph, key: str = "indegrees", bins: int = 10, **kwargs: Any) -> HistogramPlot:
    """Plot a histogram."""
    return HistogramPlot(network, key, bins, **kwargs)