pm4py.visualization.graphs package

Submodules

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

Bases: enum.Enum

An enumeration.

FORMAT = 'format'
TITLE = 'title'

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

Bases: enum.Enum

An enumeration.

ATTRIBUTES = <module 'pm4py.visualization.graphs.variants.attributes' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/attributes.py'>
BARPLOT = <module 'pm4py.visualization.graphs.variants.barplot' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/barplot.py'>
CASES = <module 'pm4py.visualization.graphs.variants.cases' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/cases.py'>
DATES = <module 'pm4py.visualization.graphs.variants.dates' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/dates.py'>
pm4py.visualization.graphs.visualizer.apply(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=<Variants.CASES: <module 'pm4py.visualization.graphs.variants.cases' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/cases.py'>>) → str[source]

Method to plot (non-logarithmic way) the graph with axis values contained in x and y

Parameters:

  • x – Values for x-axis

  • y – Values for y-axis

  • parameters –

    Parameters of the algorithm, including:

    Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image

  • variant –

    Variant of the algorithm to apply, including:
    • Variants.CASES
    • Variants.ATTRIBUTES
    • Variants.DATES
    • Variants.BARPLOT
Returns:

Representation temporary file name
Return type:

temp_file_name
pm4py.visualization.graphs.visualizer.apply_plot(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=<Variants.CASES: <module 'pm4py.visualization.graphs.variants.cases' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/cases.py'>>) → str[source]

Method to plot (non-logarithmic way) the graph with axis values contained in x and y

Parameters:

  • x – Values for x-axis

  • y – Values for y-axis

  • parameters –

    Parameters of the algorithm, including:

    Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image

  • variant –

    Variant of the algorithm to apply, including:
    • Variants.CASES
    • Variants.ATTRIBUTES
    • Variants.DATES
    • Variants.BARPLOT
Returns:

Representation temporary file name
Return type:

temp_file_name
pm4py.visualization.graphs.visualizer.apply_semilogx(x: List[float], y: List[float], parameters: Optional[Dict[Any, Any]] = None, variant=<Variants.CASES: <module 'pm4py.visualization.graphs.variants.cases' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/graphs/variants/cases.py'>>) → str[source]

Method to plot (semi-logarithmic way) the graph with axis values contained in x and y

Parameters:

  • x – Values for x-axis

  • y – Values for y-axis

  • parameters –

    Parameters of the algorithm, including:

    Parameters.FORMAT -> Format of the target image Parameters.TITLE -> Title of the image

  • variant –

    Variant of the algorithm to apply, including:
    • Variants.CASES
    • Variants.ATTRIBUTES
    • Variants.DATES
    • Variants.BARPLOT
Returns:

Representation temporary file name
Return type:

temp_file_name

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