'''
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 math
import tempfile
import pydotplus
from pm4py.util import exec_utils, constants
from pm4py.util.vis_utils import human_readable_stat
from enum import Enum
from pm4py.objects.heuristics_net.obj import HeuristicsNet
from typing import Optional, Dict, Any, Union
from uuid import uuid4
[docs]
class Parameters(Enum):
FORMAT = "format"
BGCOLOR = "bgcolor"
ENABLE_GRAPH_TITLE = "enable_graph_title"
GRAPH_TITLE = "graph_title"
[docs]
def get_corr_hex(num):
"""
Gets correspondence between a number
and an hexadecimal string
Parameters
-------------
num
Number
Returns
-------------
hex_string
Hexadecimal string
"""
if num < 10:
return str(int(num))
elif num < 11:
return "A"
elif num < 12:
return "B"
elif num < 13:
return "C"
elif num < 14:
return "D"
elif num < 15:
return "E"
elif num < 16:
return "F"
[docs]
def get_graph(
heu_net: HeuristicsNet,
parameters: Optional[Dict[Union[str, Parameters], Any]] = None,
) -> pydotplus.graphviz.Dot:
"""
Gets a representation of an Heuristics Net
Parameters
-------------
heu_net
Heuristics net
parameters
Possible parameters of the algorithm, including:
- Parameters.FORMAT
Returns
------------
graph
Pydotplus graph
"""
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, "Heuristics Net"
)
bgcolor = exec_utils.get_param_value(
Parameters.BGCOLOR, parameters, constants.DEFAULT_BGCOLOR
)
graph = pydotplus.Dot(strict=True)
graph.obj_dict["attributes"]["bgcolor"] = bgcolor
graph.set_bgcolor(bgcolor)
if enable_graph_title:
graph.set_label(graph_title)
graph.set_labelloc("top")
graph.set_labeljust("center")
graph.set_fontsize(20)
corr_nodes = {}
corr_nodes_names = {}
is_frequency = False
start_end_nodes_set = set()
for index, sa_list in enumerate(heu_net.start_activities):
start_end_nodes_set = start_end_nodes_set.union(
{n for n in sa_list if n in corr_nodes_names}
)
for index, ea_list in enumerate(heu_net.end_activities):
start_end_nodes_set = start_end_nodes_set.union(
{n for n in ea_list if n in corr_nodes_names}
)
for node_name in heu_net.nodes:
node = heu_net.nodes[node_name]
if (
node_name in start_end_nodes_set
or node.input_connections
or node.output_connections
):
node_occ = node.node_occ
graycolor = transform_to_hex_2(
max(255 - math.log(node_occ) * 9, 0)
)
if node.node_type == "frequency":
is_frequency = True
n = pydotplus.Node(
name=str(uuid4()),
shape="box",
style="filled",
label=node_name + " (" + str(node_occ) + ")",
fillcolor=node.get_fill_color(graycolor),
fontcolor=node.get_font_color(),
)
else:
n = pydotplus.Node(
name=str(uuid4()),
shape="box",
style="filled",
label=(
node_name
+ " ("
+ human_readable_stat(heu_net.sojourn_times[node_name])
+ ")"
if node_name in heu_net.sojourn_times
else node_name + " (0s)"
),
fillcolor=node.get_fill_color(graycolor),
fontcolor=node.get_font_color(),
)
corr_nodes[node] = n
corr_nodes_names[node_name] = n
graph.add_node(n)
# gets max arc value
max_arc_value = -1
for node_name in heu_net.nodes:
node = heu_net.nodes[node_name]
for other_node in node.output_connections:
if other_node in corr_nodes:
for edge in node.output_connections[other_node]:
max_arc_value = max(max_arc_value, edge.repr_value)
for node_name in heu_net.nodes:
node = heu_net.nodes[node_name]
for other_node in node.output_connections:
if other_node in corr_nodes:
for edge in node.output_connections[other_node]:
this_pen_width = 1.0 + math.log(1 + edge.repr_value) / 11.0
repr_value = str(edge.repr_value)
if edge.net_name:
if node.node_type == "frequency":
e = pydotplus.Edge(
src=corr_nodes[node],
dst=corr_nodes[other_node],
label=edge.net_name + " (" + repr_value + ")",
color=edge.get_color(),
fontcolor=edge.get_font_color(),
penwidth=edge.get_penwidth(this_pen_width),
)
else:
e = pydotplus.Edge(
src=corr_nodes[node],
dst=corr_nodes[other_node],
label=edge.net_name
+ " ("
+ human_readable_stat(repr_value)
+ ")",
color=edge.get_color(),
fontcolor=edge.get_font_color(),
penwidth=edge.get_penwidth(this_pen_width),
)
else:
if node.node_type == "frequency":
e = pydotplus.Edge(
src=corr_nodes[node],
dst=corr_nodes[other_node],
label=repr_value,
color=edge.get_color(),
fontcolor=edge.get_font_color(),
penwidth=edge.get_penwidth(this_pen_width),
)
else:
e = pydotplus.Edge(
src=corr_nodes[node],
dst=corr_nodes[other_node],
label=human_readable_stat(repr_value),
color=edge.get_color(),
fontcolor=edge.get_font_color(),
penwidth=edge.get_penwidth(this_pen_width),
)
graph.add_edge(e)
for index, sa_list in enumerate(heu_net.start_activities):
effective_sa_list = [n for n in sa_list if n in corr_nodes_names]
if effective_sa_list:
start_i = pydotplus.Node(
name="start_" + str(index),
label="@@S",
color=heu_net.default_edges_color[index],
fontsize="8",
fontcolor="#32CD32",
fillcolor="#32CD32",
style="filled",
)
graph.add_node(start_i)
for node_name in effective_sa_list:
sa = corr_nodes_names[node_name]
if type(heu_net.start_activities[index]) is dict:
occ = heu_net.start_activities[index][node_name]
if occ >= heu_net.min_dfg_occurrences:
if is_frequency:
this_pen_width = 1.0 + math.log(1 + occ) / 11.0
if heu_net.net_name[index]:
e = pydotplus.Edge(
src=start_i,
dst=sa,
label=heu_net.net_name[index]
+ " ("
+ str(occ)
+ ")",
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[
index
],
penwidth=this_pen_width,
)
else:
e = pydotplus.Edge(
src=start_i,
dst=sa,
label=str(occ),
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[
index
],
penwidth=this_pen_width,
)
else:
e = pydotplus.Edge(
src=start_i,
dst=sa,
label=heu_net.net_name[index],
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[index],
)
else:
e = pydotplus.Edge(
src=start_i,
dst=sa,
label=heu_net.net_name[index],
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[index],
)
graph.add_edge(e)
for index, ea_list in enumerate(heu_net.end_activities):
effective_ea_list = [n for n in ea_list if n in corr_nodes_names]
if effective_ea_list:
end_i = pydotplus.Node(
name="end_" + str(index),
label="@@E",
color="#FFA500",
fillcolor="#FFA500",
fontcolor="#FFA500",
fontsize="8",
style="filled",
)
graph.add_node(end_i)
for node_name in effective_ea_list:
ea = corr_nodes_names[node_name]
if type(heu_net.end_activities[index]) is dict:
occ = heu_net.end_activities[index][node_name]
if occ >= heu_net.min_dfg_occurrences:
if is_frequency:
this_pen_width = 1.0 + math.log(1 + occ) / 11.0
if heu_net.net_name[index]:
e = pydotplus.Edge(
src=ea,
dst=end_i,
label=heu_net.net_name[index]
+ " ("
+ str(occ)
+ ")",
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[
index
],
penwidth=this_pen_width,
)
else:
e = pydotplus.Edge(
src=ea,
dst=end_i,
label=str(occ),
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[
index
],
penwidth=this_pen_width,
)
else:
e = pydotplus.Edge(
src=ea,
dst=end_i,
label=heu_net.net_name[index],
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[index],
)
else:
e = pydotplus.Edge(
src=ea,
dst=end_i,
label=heu_net.net_name[index],
color=heu_net.default_edges_color[index],
fontcolor=heu_net.default_edges_color[index],
)
graph.add_edge(e)
return graph
[docs]
def apply(
heu_net: HeuristicsNet,
parameters: Optional[Dict[Union[str, Parameters], Any]] = None,
) -> str:
"""
Gets a representation of an Heuristics Net
Parameters
-------------
heu_net
Heuristics net
parameters
Possible parameters of the algorithm, including:
- Parameters.FORMAT
Returns
------------
gviz
Representation of the Heuristics Net
"""
if parameters is None:
parameters = {}
image_format = exec_utils.get_param_value(
Parameters.FORMAT, parameters, "png"
)
graph = get_graph(heu_net, parameters=parameters)
file_name = tempfile.NamedTemporaryFile(suffix="." + image_format)
file_name.close()
graph.write(file_name.name, format=image_format)
return file_name
