Source code for pm4py.visualization.graphs.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.graphs.variants import cases, attributes, dates, barplot
from pm4py.visualization.graphs.util.common import save, view, matplotlib_view, serialize
from enum import Enum
from pm4py.util import exec_utils
from typing import Optional, Dict, Any, Union, Tuple, List


[docs]class Variants(Enum): CASES = cases ATTRIBUTES = attributes DATES = dates BARPLOT = barplot
DEFAULT_VARIANT = Variants.CASES
[docs]def apply(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=DEFAULT_VARIANT) -> str: """ Method to plot (non-logarithmic way) the graph with axis values contained in x and y Parameters ------------ x Values for x-axis y Values for y-axis parameters Parameters of the algorithm, including: Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image variant Variant of the algorithm to apply, including: - Variants.CASES - Variants.ATTRIBUTES - Variants.DATES - Variants.BARPLOT Returns ------------ temp_file_name Representation temporary file name """ return exec_utils.get_variant(variant).apply_plot(x, y, parameters=parameters)
[docs]def apply_plot(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=DEFAULT_VARIANT) -> str: """ Method to plot (non-logarithmic way) the graph with axis values contained in x and y Parameters ------------ x Values for x-axis y Values for y-axis parameters Parameters of the algorithm, including: Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image variant Variant of the algorithm to apply, including: - Variants.CASES - Variants.ATTRIBUTES - Variants.DATES - Variants.BARPLOT Returns ------------ temp_file_name Representation temporary file name """ return exec_utils.get_variant(variant).apply_plot(x, y, parameters=parameters)
[docs]def apply_semilogx(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=DEFAULT_VARIANT) -> str: """ Method to plot (semi-logarithmic way) the graph with axis values contained in x and y Parameters ------------ x Values for x-axis y Values for y-axis parameters Parameters of the algorithm, including: Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image variant Variant of the algorithm to apply, including: - Variants.CASES - Variants.ATTRIBUTES - Variants.DATES - Variants.BARPLOT Returns ------------ temp_file_name Representation temporary file name """ return exec_utils.get_variant(variant).apply_semilogx(x, y, parameters=parameters)