Source code for pm4py.visualization.network_analysis.visualizer

'''
    PM4Py – A Process Mining Library for Python
Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see this software project's root or
visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions
Contact: info@processintelligence.solutions
'''
from pm4py.visualization.common import gview
from pm4py.visualization.common import save as gsave
from enum import Enum
from pm4py.visualization.network_analysis.variants import frequency, performance
from pm4py.util import exec_utils
from graphviz import Digraph
from typing import Dict, Optional, Any, Tuple


[docs] class Variants(Enum): FREQUENCY = frequency PERFORMANCE = performance
[docs] def apply(network_analysis_edges: Dict[Tuple[str, str], Dict[str, Any]], variant=Variants.FREQUENCY, parameters: Optional[Dict[Any, Any]] = None) -> Digraph: """ Creates a visualization of the network analysis Parameters ---------------- network_analysis_edges Edges of the network analysis parameters Version-specific parameters Returns ---------------- digraph Graphviz graph """ return exec_utils.get_variant(variant).apply(network_analysis_edges, parameters=parameters)
[docs] def save(gviz: Digraph, output_file_path: str, parameters=None): """ Save the diagram Parameters ----------- gviz GraphViz diagram output_file_path Path where the GraphViz output should be saved """ gsave.save(gviz, output_file_path, parameters=parameters) return ""
[docs] def view(gviz: Digraph, parameters=None): """ View the diagram Parameters ----------- gviz GraphViz diagram """ return gview.view(gviz, parameters=parameters)
[docs] def matplotlib_view(gviz: Digraph, parameters=None): """ Views the diagram using Matplotlib Parameters --------------- gviz Graphviz """ return gview.matplotlib_view(gviz, parameters=parameters)