pm4py.visualization.process_tree package

Submodules

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

Bases: enum.Enum

An enumeration.

FREQUENCY_ANNOTATION = <module 'pm4py.visualization.process_tree.variants.frequency_annotation' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/process_tree/variants/frequency_annotation.py'>
SYMBOLIC = <module 'pm4py.visualization.process_tree.variants.symbolic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/process_tree/variants/symbolic.py'>
WO_DECORATION = <module 'pm4py.visualization.process_tree.variants.wo_decoration' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/process_tree/variants/wo_decoration.py'>
pm4py.visualization.process_tree.visualizer.apply(tree0: pm4py.objects.process_tree.obj.ProcessTree, parameters: Optional[Dict[Any, Any]] = None, variant=<Variants.WO_DECORATION: <module 'pm4py.visualization.process_tree.variants.wo_decoration' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/process_tree/variants/wo_decoration.py'>>) → graphviz.graphs.Graph[source]

Method for Process Tree representation

Parameters:

  • tree – Process tree

  • parameters –

    Possible parameters of the algorithm:

    Parameters.FORMAT -> Format of the image (PDF, PNG, SVG; default PNG)

  • variant –

    Variant of the algorithm to use:
    • Variants.WO_DECORATION
Returns:

GraphViz object
Return type:

gviz
pm4py.visualization.process_tree.visualizer.matplotlib_view(gviz: graphviz.graphs.Graph)[source]

Views the diagram using Matplotlib

Parameters:gviz – Graphviz
pm4py.visualization.process_tree.visualizer.save(gviz: graphviz.graphs.Graph, 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.process_tree.visualizer.view(gviz: graphviz.graphs.Graph)[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/>.