pm4py.visualization.performance_spectrum package

Subpackages

• pm4py.visualization.performance_spectrum.variants package
  • Submodules
  • pm4py.visualization.performance_spectrum.variants.neato module
  • Module contents

Submodules

pm4py.visualization.performance_spectrum.visualizer module

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/>.

class pm4py.visualization.performance_spectrum.visualizer.Variants

Bases: enum.Enum

An enumeration.

NEATO = <module 'pm4py.visualization.performance_spectrum.variants.neato' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/visualization/performance_spectrum/variants/neato.py'>

pm4py.visualization.performance_spectrum.visualizer.apply(perf_spectrum: Dict[str, Any], variant=<Variants.NEATO: <module 'pm4py.visualization.performance_spectrum.variants.neato' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/visualization/performance_spectrum/variants/neato.py'>>, parameters: Optional[Dict[Any, Any]] = None) → str

Construct the performance spectrum visualization

Parameters:

• perf_spectrum – Performance spectrum
• variant – Variant of the visualization to use: - NEATO: using the Graphviz Neato layouter
• parameters – Variant-specific parameters

Returns:

Path containing the visualization

Return type:

file_path

pm4py.visualization.performance_spectrum.visualizer.matplotlib_view(figure: str)

Views the performance spectrum using Matplotlib

Parameters:figure – Path containing the visualization

pm4py.visualization.performance_spectrum.visualizer.save(figure: str, output_file_path: str)

Saves the performance spectrum at the specified path

Parameters:

• figure – Path containing the visualization
• output_file_path – Path into which the image should be saved

pm4py.visualization.performance_spectrum.visualizer.serialize(figure: str)

Serializes the performance spectrum visualization

Parameters:figure – Path containing the visualization

pm4py.visualization.performance_spectrum.visualizer.view(figure: str)

Views the performance spectrum

Parameters:figure – Path containing the visualization

Module contents

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/>.