Source code for pm4py.visualization.footprints.visualizer

'''
    This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

    PM4Py is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    PM4Py 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with PM4Py.  If not, see <https://www.gnu.org/licenses/>.
'''
from pm4py.visualization.footprints.variants import comparison, single, comparison_symmetric
from enum import Enum
from pm4py.util import exec_utils
from pm4py.visualization.common import gview
from pm4py.visualization.common import save as gsave
from pm4py.visualization.common.gview import serialize, serialize_dot
import graphviz
from typing import Optional, Dict, Any, Union, Tuple


[docs]class Variants(Enum): COMPARISON = comparison SINGLE = single COMPARISON_SYMMETRIC = comparison_symmetric
[docs]def apply(*args, variant=None, parameters: Optional[Dict[Any, Any]] = None) -> graphviz.Source: """ Visualize a footprints table or a comparison between footprints tables Parameters --------------- args Arguments: - A single footprint table - Two footprints table (first one associated to the log, second one associated to the model) parameters Parameters of the algorithm, including: - Parameters.FORMAT => Format of the visualization Returns --------------- gviz Graphviz object """ if parameters is None: parameters = {} if variant is None: if len(args) == 1: variant = Variants.SINGLE else: variant = Variants.COMPARISON if variant in [Variants.SINGLE]: return exec_utils.get_variant(variant).apply(args[0], parameters=parameters) elif variant in [Variants.COMPARISON, Variants.COMPARISON_SYMMETRIC]: return exec_utils.get_variant(variant).apply(args[0], args[1], parameters=parameters)
[docs]def save(gviz, output_file_path): """ Save the diagram Parameters ----------- gviz GraphViz diagram output_file_path Path where the GraphViz output should be saved """ gsave.save(gviz, output_file_path)
[docs]def view(gviz): """ View the diagram Parameters ----------- gviz GraphViz diagram """ return gview.view(gviz)
[docs]def matplotlib_view(gviz): """ Views the diagram using Matplotlib Parameters --------------- gviz Graphviz """ return gview.matplotlib_view(gviz)