pm4py.visualization.ocel.ocpn package

Submodules

pm4py.visualization.ocel.ocpn.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.ocel.ocpn.visualizer.Variants[source]

Bases: enum.Enum

An enumeration.

WO_DECORATION = <module 'pm4py.visualization.ocel.ocpn.variants.wo_decoration' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/ocel/ocpn/variants/wo_decoration.py'>
pm4py.visualization.ocel.ocpn.visualizer.apply(ocpn: Dict[str, Any], variant=<Variants.WO_DECORATION: <module 'pm4py.visualization.ocel.ocpn.variants.wo_decoration' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/ocel/ocpn/variants/wo_decoration.py'>>, parameters: Optional[Dict[Any, Any]] = None) → graphviz.graphs.Digraph[source]

Obtains a visualization of the provided object-centric Petri net

Reference paper: van der Aalst, Wil MP, and Alessandro Berti. “Discovering object-centric Petri nets.” Fundamenta informaticae 175.1-4 (2020): 1-40.

Parameters:
  • ocpn – Object-centric Petri net
  • variant – Variant of the algorithm to be used
  • parameters – Variant-specific parameters
Returns:

Graphviz digraph
Return type:

gviz
pm4py.visualization.ocel.ocpn.visualizer.matplotlib_view(gviz: graphviz.graphs.Digraph)[source]

Views the diagram using Matplotlib

Parameters:gviz – Graphviz
pm4py.visualization.ocel.ocpn.visualizer.save(gviz: graphviz.graphs.Digraph, output_file_path: str)[source]

Save the diagram

Parameters:
  • gviz – GraphViz diagram
  • output_file_path – Path where the GraphViz output should be saved
pm4py.visualization.ocel.ocpn.visualizer.view(gviz: graphviz.graphs.Digraph)[source]

View the diagram

Parameters:gviz – GraphViz diagram

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