pm4py.visualization.sna.variants package#

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

Submodules#

pm4py.visualization.sna.variants.networkx module#

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

class pm4py.visualization.sna.variants.networkx.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

WEIGHT_THRESHOLD = 'weight_threshold'#
FORMAT = 'format'#
pm4py.visualization.sna.variants.networkx.get_temp_file_name(format)[source]#

Gets a temporary file name for the image

Parameters#

format

Format of the target image

pm4py.visualization.sna.variants.networkx.apply(sna: SNA, parameters=None)[source]#

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

Parameters#

sna

Value of the metrics

parameters
Possible parameters of the algorithm, including:
  • Parameters.WEIGHT_THRESHOLD -> the weight threshold to use in displaying the graph

  • Parameters.FORMAT -> format of the output image (png, svg …)

Returns#

temp_file_name

Name of a temporary file where the visualization is placed

pm4py.visualization.sna.variants.networkx.view(temp_file_name, parameters=None)[source]#

View the SNA visualization on the screen

Parameters#

temp_file_name

Temporary file name

parameters

Possible parameters of the algorithm

pm4py.visualization.sna.variants.networkx.save(temp_file_name, dest_file, parameters=None)[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.variants.pyvis module#

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

class pm4py.visualization.sna.variants.pyvis.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: Enum

WEIGHT_THRESHOLD = 'weight_threshold'#
IFRAME_WIDTH = 'iframe_width'#
IFRAME_HEIGHT = 'iframe_height'#
LOCAL_JUPYTER_FILE_NAME = 'local_jupyter_file_name'#
pm4py.visualization.sna.variants.pyvis.get_temp_file_name(format)[source]#

Gets a temporary file name for the image

Parameters#

format

Format of the target image

pm4py.visualization.sna.variants.pyvis.apply(sna: SNA, parameters=None)[source]#

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

Parameters#

sna

Value of the metrics

parameters
Possible parameters of the algorithm, including:
  • Parameters.WEIGHT_THRESHOLD -> the weight threshold to use in displaying the graph

Returns#

temp_file_name

Name of a temporary file where the visualization is placed

pm4py.visualization.sna.variants.pyvis.view(temp_file_name, parameters=None)[source]#

View the SNA visualization on the screen

Parameters#

temp_file_name

Temporary file name

parameters

Possible parameters of the algorithm

pm4py.visualization.sna.variants.pyvis.save(temp_file_name, dest_file, parameters=None)[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