pm4py.visualization.petri_net.common package#

PM4Py – A Process Mining Library for Python

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

Submodules#

pm4py.visualization.petri_net.common.visualize module#

PM4Py – A Process Mining Library for Python

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.common.visualize.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

FORMAT = 'format'#

DEBUG = 'debug'#

RANKDIR = 'set_rankdir'#

ACTIVITY_KEY = 'pm4py:param:activity_key'#

TIMESTAMP_KEY = 'pm4py:param:timestamp_key'#

AGGREGATION_MEASURE = 'aggregationMeasure'#

FONT_SIZE = 'font_size'#

BGCOLOR = 'bgcolor'#

DECORATIONS = 'decorations'#

ENABLE_GRAPH_TITLE = 'enable_graph_title'#

GRAPH_TITLE = 'graph_title'#

pm4py.visualization.petri_net.common.visualize.sort_petri_net(transitions: List[Transition], places: List[Place], arcs: List[Arc], initial_marking: Dict[Place, int], final_marking: Dict[Place, int]) → Tuple[List[Transition], List[Place], List[Arc]][source]#

Sorts the Petri net elements based on reachability from/to the initial/final marking

Parameters#

transitions: List of Petri net transitions
places: List of Petri net places
arcs: List of Petri net arcs
initial_marking: Initial marking
final_marking: Final marking

Returns#

sorted_transitions: Sorted list of Petri net transitions
sorted_places: Sorted list of Petri net places
sorted_arcs: Sorted list of Petri net arcs

pm4py.visualization.petri_net.common.visualize.apply(net, initial_marking, final_marking, decorations=None, parameters=None)[source]#

Apply method for Petri net visualization (it calls the graphviz_visualization method)

Parameters#

net: Petri net
initial_marking: Initial marking
final_marking: Final marking
decorations: Decorations for elements in the Petri net
parameters: Algorithm parameters

Returns#

viz: Graph object

pm4py.visualization.petri_net.common.visualize.graphviz_visualization(net, image_format='png', initial_marking=None, final_marking=None, decorations=None, debug=False, set_rankdir=None, font_size='12', bgcolor='white', enable_graph_title: bool = False, graph_title: str = 'Petri Net')[source]#

Provides visualization for the petrinet

Parameters#

net: pm4py.entities.petri.petrinet.PetriNet: Petri net
image_format: Format that should be associated to the image
initial_marking: Initial marking of the Petri net
final_marking: Final marking of the Petri net
decorations: Decorations of the Petri net (says how element must be presented)
debug: Enables debug mode
set_rankdir: Sets the rankdir to LR (horizontal layout)
enable_graph_title: Enables the visualization of a graph’s title
graph_title: Graph title to display (if enable_graph_title)

Returns#

viz :: Returns a graph object