'''
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
'''
import matplotlib
from copy import copy
from pm4py.visualization.graphs.util import common
from pm4py.util import exec_utils, constants
from enum import Enum
from typing import Optional, Dict, Any, Union, List
[docs]
class Parameters(Enum):
TITLE = "title"
FORMAT = "format"
X_AXIS = "x_axis"
Y_AXIS = "y_axis"
PYPLOT_PLOT_KWARGS = "pylot_plot_kwargs"
TRANSPARENT = "transparent"
TIMESTAMP_LABEL = "Date"
DENSITY_LABEL = "Density"
GRAPH_DEFAULT_TITLE = "Events per Time"
[docs]
def apply_plot(
x: List[float],
y: List[float],
parameters: Optional[Dict[Union[str, Parameters], Any]] = None,
) -> str:
"""
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
Returns
------------
temp_file_name
Representation temporary file name
"""
if parameters is None:
parameters = {}
format = exec_utils.get_param_value(Parameters.FORMAT, parameters, "png")
title = exec_utils.get_param_value(
Parameters.TITLE, parameters, GRAPH_DEFAULT_TITLE
)
x_axis = exec_utils.get_param_value(
Parameters.X_AXIS, parameters, TIMESTAMP_LABEL
)
y_axis = exec_utils.get_param_value(
Parameters.Y_AXIS, parameters, DENSITY_LABEL
)
pyplot_plot_kwargs = exec_utils.get_param_value(
Parameters.PYPLOT_PLOT_KWARGS, parameters, {}
)
is_transp = exec_utils.get_param_value(
Parameters.TRANSPARENT,
parameters,
True if constants.DEFAULT_BGCOLOR == "transparent" else False,
)
filename = common.get_temp_file_name(format)
current_backend = copy(matplotlib.get_backend())
matplotlib.use("Agg")
from matplotlib import pyplot
pyplot.clf()
pyplot.plot(x, y, **pyplot_plot_kwargs)
pyplot.xlabel(x_axis)
pyplot.ylabel(y_axis)
pyplot.title(title)
pyplot.xticks(rotation=90)
pyplot.savefig(filename, bbox_inches="tight", transparent=is_transp)
pyplot.clf()
matplotlib.use(current_backend)
return filename
[docs]
def apply_semilogx(
x: List[float],
y: List[float],
parameters: Optional[Dict[Union[str, Parameters], Any]] = None,
) -> str:
"""
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
Returns
------------
temp_file_name
Representation temporary file name
"""
if parameters is None:
parameters = {}
format = exec_utils.get_param_value(Parameters.FORMAT, parameters, "png")
title = exec_utils.get_param_value(
Parameters.TITLE, parameters, GRAPH_DEFAULT_TITLE
)
pyplot_plot_kwargs = exec_utils.get_param_value(
Parameters.PYPLOT_PLOT_KWARGS, parameters, {}
)
is_transp = exec_utils.get_param_value(
Parameters.TRANSPARENT,
parameters,
True if constants.DEFAULT_BGCOLOR == "transparent" else False,
)
filename = common.get_temp_file_name(format)
current_backend = copy(matplotlib.get_backend())
matplotlib.use("Agg")
from matplotlib import pyplot
pyplot.clf()
pyplot.semilogx(x, y, **pyplot_plot_kwargs)
pyplot.xlabel(TIMESTAMP_LABEL)
pyplot.ylabel(DENSITY_LABEL)
pyplot.title(title)
pyplot.xticks(rotation=90)
pyplot.savefig(filename, bbox_inches="tight", transparent=is_transp)
pyplot.clf()
matplotlib.use(current_backend)
return filename
