pm4py.visualization.dfg package

Submodules

pm4py.visualization.dfg.parameters 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.dfg.parameters.Parameters[source]

Bases: enum.Enum

An enumeration.

ACTIVITY_KEY = 'pm4py:param:activity_key'
END_ACTIVITIES = 'end_activities'
FONT_SIZE = 'font_size'
FORMAT = 'format'
MAX_NO_EDGES_IN_DIAGRAM = 'maxNoOfEdgesInDiagram'
START_ACTIVITIES = 'start_activities'
START_TIMESTAMP_KEY = 'pm4py:param:start_timestamp_key'
TIMESTAMP_KEY = 'pm4py:param:timestamp_key'

pm4py.visualization.dfg.visualizer 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.dfg.visualizer.Variants[source]

Bases: enum.Enum

An enumeration.

FREQUENCY = <module 'pm4py.visualization.dfg.variants.frequency' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/dfg/variants/frequency.py'>
PERFORMANCE = <module 'pm4py.visualization.dfg.variants.performance' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/dfg/variants/performance.py'>
pm4py.visualization.dfg.visualizer.apply(dfg0: Dict[Tuple[str, str], float], log: pm4py.objects.log.obj.EventLog = None, activities_count: Dict[str, int] = None, soj_time: Dict[str, float] = None, parameters: Optional[Dict[Any, Any]] = None, variant=<Variants.FREQUENCY: <module 'pm4py.visualization.dfg.variants.frequency' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/dfg/variants/frequency.py'>>) → graphviz.graphs.Digraph[source]

Visualize a frequency/performance directly-follows graph

Parameters:
  • dfg0 – Directly-follows graph
  • log – (if provided) Event log for the calculation of statistics
  • activities_count – (if provided) Dictionary associating to each activity the number of occurrences in the log.
  • soj_time – (if provided) Dictionary associating to each activity the average sojourn time
  • parameters – Variant-specific parameters
  • variant – Variant: - Frequency DFG representation - Performance DFG representation
Returns:

Graphviz digraph
Return type:

gviz
pm4py.visualization.dfg.visualizer.matplotlib_view(gviz)[source]

Views the diagram using Matplotlib

Parameters:gviz – Graphviz
pm4py.visualization.dfg.visualizer.save(gviz, output_file_path)[source]

Save the diagram

Parameters:
  • gviz – GraphViz diagram
  • output_file_path – Path where the GraphViz output should be saved
pm4py.visualization.dfg.visualizer.view(gviz)[source]

View the diagram

Parameters:gviz – GraphViz diagram

Module contents

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