'''
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/>.
'''
import shutil
from enum import Enum
from typing import List, Any, Dict, Optional, Union
import pandas as pd
from pm4py.objects.conversion.log import converter as log_converter
from pm4py.objects.log.obj import EventLog
from pm4py.util import exec_utils, vis_utils
from pm4py.visualization.dotted_chart.variants import classic
[docs]class Variants(Enum):
CLASSIC = classic
[docs]def apply(log_obj: Union[pd.DataFrame, EventLog], attributes: List[str], variant=Variants.CLASSIC,
parameters: Optional[Dict[Any, Any]] = None) -> str:
"""
Creates the dotted chart with the log objects and the provided attributes
Parameters
---------------
log_obj
Log object
attributes
List of attributes that should be included in the dotted chart
parameters
Variant-specific parameters
Returns
---------------
file_path
Path to the dotted chart visualization
"""
if parameters is None:
parameters = {}
if isinstance(log_obj, pd.DataFrame):
log_obj = log_obj[list(set(attributes))]
parameters["deepcopy"] = False
stream = log_converter.apply(log_obj, variant=log_converter.Variants.TO_EVENT_STREAM, parameters=parameters)
stream = [tuple(y[a] for a in attributes) for y in stream]
return exec_utils.get_variant(variant).apply(stream, attributes, parameters=parameters)
[docs]def view(figure: str):
"""
Views the dotted chart on the screen
Parameters
---------------
figure
Path to the dotted chart
"""
if vis_utils.check_visualization_inside_jupyter():
vis_utils.view_image_in_jupyter(figure)
else:
vis_utils.open_opsystem_image_viewer(figure)
[docs]def save(figure: str, output_file_path: str):
"""
Saves the dotted chart to a specified path
Parameters
----------------
figure
Current path to the dotted chart
output_file_path
Destination path
"""
shutil.copyfile(figure, output_file_path)
[docs]def serialize(figure: str):
"""
Performs the serialization of the dotted chart visualization
Parameters
-----------------
figure
Current path to the dotted chart
"""
with open(figure, "rb") as f:
return f.read()
[docs]def matplotlib_view(figure: str):
"""
Views the dotted chart on the screen using Matplotlib
Parameters
---------------
figure
Path to the dotted chart
"""
import matplotlib.pyplot as plt
import matplotlib.image as mpimg
img = mpimg.imread(figure)
plt.imshow(img)
plt.show()