pm4py.visualization.ocel.ocdfg.variants package#

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/>.

Submodules#

pm4py.visualization.ocel.ocdfg.variants.classic 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.ocel.ocdfg.variants.classic.Parameters(value)[source]#

Bases: Enum

An enumeration.

FORMAT = 'format'#
BGCOLOR = 'bgcolor'#
RANKDIR = 'rankdir'#
ACT_METRIC = 'act_metric'#
EDGE_METRIC = 'edge_metric'#
ACT_THRESHOLD = 'act_threshold'#
EDGE_THRESHOLD = 'edge_threshold'#
ANNOTATION = 'annotation'#
PERFORMANCE_AGGREGATION_MEASURE = 'aggregationMeasure'#
pm4py.visualization.ocel.ocdfg.variants.classic.ot_to_color(ot: str) str[source]#
pm4py.visualization.ocel.ocdfg.variants.classic.add_activity(G: Digraph, act, freq, act_prefix, nodes, annotation, min_freq, max_freq)[source]#

Adds an activity node to the graph

pm4py.visualization.ocel.ocdfg.variants.classic.add_frequency_edge(G: Digraph, ot, act1, act2, freq, edge_prefix, nodes, min_freq, max_freq)[source]#

Adds a edge (frequency annotation)

pm4py.visualization.ocel.ocdfg.variants.classic.add_performance_edge(G: Digraph, ot, act1, act2, perf, edge_prefix, nodes, aggregation_measure)[source]#

Adds an edge (performance annotation)

pm4py.visualization.ocel.ocdfg.variants.classic.add_start_node(G: Digraph, ot, act, freq, edge_prefix, nodes, annotation, min_freq, max_freq)[source]#

Adds a start node to the graph

pm4py.visualization.ocel.ocdfg.variants.classic.add_end_node(G: Digraph, ot, act, freq, edge_prefix, nodes, annotation, min_freq, max_freq)[source]#

Adds an end node to the graph

pm4py.visualization.ocel.ocdfg.variants.classic.apply(ocdfg: Dict[str, Any], parameters: Optional[Dict[Any, Any]] = None) Digraph[source]#

Visualizes an OC-DFG as a Graphviz di-graph

Parameters#

ocdfg

OC-DFG

parameters

Parameters of the algorithm: - Parameters.FORMAT => the format of the output visualization (default: “png”) - Parameters.BGCOLOR => the default background color (default: “bgcolor”) - Parameters.RANKDIR => direction of the graph (“LR” for left-to-right; “TB” for top-to-bottom) - Parameters.ACT_METRIC => the metric to use for the activities. Available values:

  • “events” => number of events (default)

  • “unique_objects” => number of unique objects

  • “total_objects” => number of total objects

  • Parameters.EDGE_METRIC => the metric to use for the edges. Available values:
    • “event_couples” => number of event couples (default)

    • “unique_objects” => number of unique objects

    • “total_objects” => number of total objects

  • Parameters.ACT_THRESHOLD => the threshold to apply on the activities frequency (default: 0). Only activities

having a frequency >= than this are kept in the graph. - Parameters.EDGE_THRESHOLD => the threshold to apply on the edges frequency (default 0). Only edges having a frequency >= than this are kept in the graph. - Parameters.ANNOTATION => the annotation to use for the visualization. Values:

  • “frequency”: frequency annotation

  • “performance”: performance annotation

  • Parameters.PERFORMANCE_AGGREGATION_MEASURE => the aggregation measure to use for the performance:
    • mean

    • median

    • min

    • max

    • sum

Returns#

viz

Graphviz DiGraph