pm4py.visualization.petri_net package

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

Subpackages

• pm4py.visualization.petri_net.common package
  • Submodules
  • pm4py.visualization.petri_net.common.visualize module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
      • Parameters.BGCOLOR
      • Parameters.DECORATIONS
    • apply()
    • graphviz_visualization()
• pm4py.visualization.petri_net.util package
  • Submodules
  • pm4py.visualization.petri_net.util.alignments_decoration module
    • get_alignments_decoration()
  • pm4py.visualization.petri_net.util.performance_map module
  • pm4py.visualization.petri_net.util.vis_trans_shortest_paths module
    • get_shortest_paths_from_trans()
    • get_shortest_paths()
    • get_decorations_from_dfg_spaths_acticount()
• pm4py.visualization.petri_net.variants package
  • Submodules
  • pm4py.visualization.petri_net.variants.alignments module
    • apply()
  • pm4py.visualization.petri_net.variants.greedy_decoration_frequency module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
    • get_decorated_net()
    • apply()
  • pm4py.visualization.petri_net.variants.greedy_decoration_performance module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
      • Parameters.STAT_LOCALE
    • get_decorated_net()
    • apply()
  • pm4py.visualization.petri_net.variants.token_decoration_frequency module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
    • get_decorations()
    • apply()
  • pm4py.visualization.petri_net.variants.token_decoration_performance module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
      • Parameters.STAT_LOCALE
    • get_decorations()
    • apply()
  • pm4py.visualization.petri_net.variants.wo_decoration module
    • Parameters
      • Parameters.FORMAT
      • Parameters.DEBUG
      • Parameters.RANKDIR
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.AGGREGATION_MEASURE
      • Parameters.FONT_SIZE
    • apply()

Submodules

pm4py.visualization.petri_net.visualizer module

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

class pm4py.visualization.petri_net.visualizer.Variants(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

WO_DECORATION = <module 'pm4py.visualization.petri_net.variants.wo_decoration' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\wo_decoration.py'>

FREQUENCY = <module 'pm4py.visualization.petri_net.variants.token_decoration_frequency' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\token_decoration_frequency.py'>

PERFORMANCE = <module 'pm4py.visualization.petri_net.variants.token_decoration_performance' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\token_decoration_performance.py'>

FREQUENCY_GREEDY = <module 'pm4py.visualization.petri_net.variants.greedy_decoration_frequency' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\greedy_decoration_frequency.py'>

PERFORMANCE_GREEDY = <module 'pm4py.visualization.petri_net.variants.greedy_decoration_performance' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\greedy_decoration_performance.py'>

ALIGNMENTS = <module 'pm4py.visualization.petri_net.variants.alignments' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\petri_net\\variants\\alignments.py'>

pm4py.visualization.petri_net.visualizer.apply(net: PetriNet, initial_marking: Marking = None, final_marking: Marking = None, log: EventLog | EventStream | DataFrame = None, aggregated_statistics=None, parameters: Dict[Any, Any] | None = None, variant=Variants.WO_DECORATION) → Digraph

pm4py.visualization.petri_net.visualizer.save(gviz: Digraph, output_file_path: str, parameters=None)

Save the diagram

Parameters

gviz

GraphViz diagram

output_file_path

Path where the GraphViz output should be saved

pm4py.visualization.petri_net.visualizer.view(gviz: Digraph, parameters=None)

View the diagram

Parameters

gviz

GraphViz diagram

pm4py.visualization.petri_net.visualizer.matplotlib_view(gviz: Digraph, parameters=None)

Views the diagram using Matplotlib

Parameters

gviz

Graphviz