pm4py.visualization.sna package

Submodules

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

Bases: enum.Enum

An enumeration.

NETWORKX = <module 'pm4py.visualization.sna.variants.networkx' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/sna/variants/networkx.py'>
PYVIS = <module 'pm4py.visualization.sna.variants.pyvis' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/sna/variants/pyvis.py'>
pm4py.visualization.sna.visualizer.apply(metric_values, parameters=None, variant=<Variants.NETWORKX: <module 'pm4py.visualization.sna.variants.networkx' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/sna/variants/networkx.py'>>)[source]

Perform SNA visualization starting from the Matrix Container object and the Resource-Resource matrix

Parameters:

  • metric_values – Value of the metrics

  • parameters – Possible parameters of the algorithm

  • variant –

    Variant of the algorithm to use, possible values:
    • Variants.NETWORKX
    • Variants.PYVIS
Returns:

Name of a temporary file where the visualization is placed
Return type:

temp_file_name
pm4py.visualization.sna.visualizer.save(temp_file_name, dest_file, parameters=None, variant=<Variants.NETWORKX: <module 'pm4py.visualization.sna.variants.networkx' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/sna/variants/networkx.py'>>)[source]

Save the SNA visualization from a temporary file to a well-defined destination file

Parameters:
  • temp_file_name – Temporary file name
  • dest_file – Destination file
  • parameters – Possible parameters of the algorithm
pm4py.visualization.sna.visualizer.view(temp_file_name, parameters=None, variant=<Variants.NETWORKX: <module 'pm4py.visualization.sna.variants.networkx' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/sna/variants/networkx.py'>>)[source]

View the SNA visualization on the screen

Parameters:
  • temp_file_name – Temporary file name
  • parameters – Possible parameters of the algorithm

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