'''
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
'''
import importlib.resources
import tempfile
from enum import Enum
from graphviz import Digraph
from pm4py.objects.process_tree.obj import Operator
from pm4py.util import exec_utils, constants
from typing import Optional, Dict, Any
from pm4py.objects.powl.obj import (
POWL,
Transition,
SilentTransition,
StrictPartialOrder,
OperatorPOWL,
FrequentTransition,
)
OPERATOR_BOXES = True
FREQUENCY_TAG_IMAGES = True
min_width = "1.5" # Set the minimum width in inches
min_height = "0.5"
fillcolor = "#fcfcfc"
opacity_change_ratio = 0.02
[docs]
class Parameters(Enum):
FORMAT = "format"
COLOR_MAP = "color_map"
ENABLE_DEEPCOPY = "enable_deepcopy"
FONT_SIZE = "font_size"
BGCOLOR = "bgcolor"
ENABLE_GRAPH_TITLE = "enable_graph_title"
GRAPH_TITLE = "graph_title"
[docs]
def apply(powl: POWL, parameters: Optional[Dict[Any, Any]] = None) -> Digraph:
"""
Obtain a POWL model representation through GraphViz
Parameters
-----------
powl
POWL model
Returns
-----------
gviz
GraphViz Digraph
"""
if parameters is None:
parameters = {}
enable_graph_title = exec_utils.get_param_value(
Parameters.ENABLE_GRAPH_TITLE,
parameters,
constants.DEFAULT_ENABLE_GRAPH_TITLES,
)
graph_title = exec_utils.get_param_value(
Parameters.GRAPH_TITLE, parameters, "POWL model"
)
filename = tempfile.NamedTemporaryFile(suffix=".gv")
viz = Digraph("powl", filename=filename.name, engine="dot")
viz.attr("node", shape="ellipse", fixedsize="false")
viz.attr(nodesep="1")
viz.attr(ranksep="1")
viz.attr(compound="true")
viz.attr(overlap="scale")
viz.attr(splines="true")
viz.attr(rankdir="TB")
viz.attr(style="filled")
viz.attr(fillcolor=fillcolor)
color_map = exec_utils.get_param_value(Parameters.COLOR_MAP, {}, {})
repr_powl(powl, viz, color_map, level=0)
viz.format = "svg"
return viz
[docs]
def get_color(node, color_map):
"""
Gets a color for a node from the color map
Parameters
--------------
node
Node
color_map
Color map
"""
if node in color_map:
return color_map[node]
return "black"
[docs]
def get_id_base(powl):
if isinstance(powl, Transition):
return str(id(powl))
if isinstance(powl, OperatorPOWL):
return str(id(powl))
if isinstance(powl, StrictPartialOrder):
for node in powl.children:
return get_id_base(node)
[docs]
def get_id(powl):
if isinstance(powl, Transition):
return str(id(powl))
if isinstance(powl, OperatorPOWL):
if OPERATOR_BOXES:
return "cluster_" + str(id(powl))
else:
return "clusterINVIS_" + str(id(powl))
if isinstance(powl, StrictPartialOrder):
return "cluster_" + str(id(powl))
[docs]
def add_operator_edge(vis, current_node_id, child, directory="none", style=""):
child_id = get_id(child)
if child_id.startswith("cluster_"):
vis.edge(
current_node_id,
get_id_base(child),
dir=directory,
lhead=child_id,
style=style,
minlen="2",
)
else:
vis.edge(
current_node_id, get_id_base(child), dir=directory, style=style
)
[docs]
def add_order_edge(
block, child_1, child_2, directory="forward", color="black", style=""
):
child_id_1 = get_id(child_1)
child_id_2 = get_id(child_2)
if child_id_1.startswith("cluster_"):
if child_id_2.startswith("cluster_"):
block.edge(
get_id_base(child_1),
get_id_base(child_2),
dir=directory,
color=color,
style=style,
ltail=child_id_1,
lhead=child_id_2,
minlen="2",
)
else:
block.edge(
get_id_base(child_1),
get_id_base(child_2),
dir=directory,
color=color,
style=style,
ltail=child_id_1,
minlen="2",
)
else:
if child_id_2.startswith("cluster_"):
block.edge(
get_id_base(child_1),
get_id_base(child_2),
dir=directory,
color=color,
style=style,
lhead=child_id_2,
minlen="2",
)
else:
block.edge(
get_id_base(child_1),
get_id_base(child_2),
dir=directory,
color=color,
style=style,
)
[docs]
def repr_powl(powl, viz, color_map, level):
font_size = "18"
this_node_id = str(id(powl))
current_color = darken_color(
fillcolor, amount=opacity_change_ratio * level
)
if isinstance(powl, FrequentTransition):
label = powl.activity
if powl.skippable:
if powl.selfloop:
with importlib.resources.path(
"pm4py.visualization.powl.variants.icons",
"skip-loop-tag.svg",
) as gimg:
image = str(gimg)
viz.node(
this_node_id,
label="\n" + label,
imagepos="tr",
image=image,
shape="box",
width=min_width,
fontsize=font_size,
style="filled",
fillcolor=current_color,
)
else:
with importlib.resources.path(
"pm4py.visualization.powl.variants.icons", "skip-tag.svg"
) as gimg:
image = str(gimg)
viz.node(
this_node_id,
label="\n" + label,
imagepos="tr",
image=image,
shape="box",
width=min_width,
fontsize=font_size,
style="filled",
fillcolor=current_color,
)
else:
if powl.selfloop:
with importlib.resources.path(
"pm4py.visualization.powl.variants.icons", "loop-tag.svg"
) as gimg:
image = str(gimg)
viz.node(
this_node_id,
label="\n" + label,
imagepos="tr",
image=image,
shape="box",
width=min_width,
fontsize=font_size,
style="filled",
fillcolor=current_color,
)
else:
viz.node(
this_node_id,
label=label,
shape="box",
width=min_width,
fontsize=font_size,
style="filled",
fillcolor=current_color,
)
elif isinstance(powl, Transition):
if isinstance(powl, SilentTransition):
viz.node(
this_node_id,
label="",
style="filled",
fillcolor="black",
shape="square",
width="0.3",
height="0.3",
fixedsize="true",
)
else:
viz.node(
this_node_id,
str(powl.label),
shape="box",
fontsize=font_size,
width=min_width,
style="filled",
fillcolor=current_color,
)
elif isinstance(powl, StrictPartialOrder):
transitive_reduction = powl.order.get_transitive_reduction()
with viz.subgraph(name=get_id(powl)) as block:
block.attr(margin="20,20")
block.attr(style="filled")
block.attr(fillcolor=current_color)
for child in powl.children:
repr_powl(child, block, color_map, level=level + 1)
for child in powl.children:
for child2 in powl.children:
if transitive_reduction.is_edge(child, child2):
add_order_edge(block, child, child2)
elif isinstance(powl, OperatorPOWL):
with viz.subgraph(name=get_id(powl)) as block:
block.attr(margin="20,20")
block.attr(style="filled")
block.attr(fillcolor=current_color)
if powl.operator == Operator.LOOP:
with importlib.resources.path(
"pm4py.visualization.powl.variants.icons", "loop.svg"
) as gimg:
image = str(gimg)
block.node(
this_node_id,
image=image,
label="",
fontsize=font_size,
width="0.4",
height="0.4",
fixedsize="true",
)
do = powl.children[0]
redo = powl.children[1]
repr_powl(do, block, color_map, level=level + 1)
add_operator_edge(block, this_node_id, do)
repr_powl(redo, block, color_map, level=level + 1)
add_operator_edge(block, this_node_id, redo, style="dashed")
elif powl.operator == Operator.XOR:
with importlib.resources.path(
"pm4py.visualization.powl.variants.icons", "xor.svg"
) as gimg:
image = str(gimg)
block.node(
this_node_id,
image=image,
label="",
fontsize=font_size,
width="0.4",
height="0.4",
fixedsize="true",
)
for child in powl.children:
repr_powl(child, block, color_map, level=level + 1)
add_operator_edge(block, this_node_id, child)
[docs]
def darken_color(color, amount):
"""Darkens the given color by the specified amount"""
import matplotlib.colors as mcolors
amount = min(0.3, amount)
rgb = mcolors.to_rgb(color)
darker = [x * (1 - amount) for x in rgb]
return mcolors.to_hex(darker)
