pm4py.objects.ocel 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/>.

Subpackages

• pm4py.objects.ocel.exporter package
  • Subpackages
    • pm4py.objects.ocel.exporter.csv package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.exporter.csv.exporter module
    • pm4py.objects.ocel.exporter.jsonocel package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.exporter.jsonocel.exporter module
    • pm4py.objects.ocel.exporter.sqlite package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.exporter.sqlite.exporter module
    • pm4py.objects.ocel.exporter.util package
      • Submodules
      • pm4py.objects.ocel.exporter.util.clean_dataframes module
    • pm4py.objects.ocel.exporter.xmlocel package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.exporter.xmlocel.exporter module
• pm4py.objects.ocel.importer package
  • Subpackages
    • pm4py.objects.ocel.importer.csv package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.importer.csv.importer module
    • pm4py.objects.ocel.importer.jsonocel package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.importer.jsonocel.importer module
    • pm4py.objects.ocel.importer.sqlite package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.importer.sqlite.importer module
    • pm4py.objects.ocel.importer.xmlocel package
      • Subpackages
      • Submodules
      • pm4py.objects.ocel.importer.xmlocel.importer module
• pm4py.objects.ocel.util package
  • Submodules
  • pm4py.objects.ocel.util.attributes_names module
    • get_attribute_names()
  • pm4py.objects.ocel.util.convergence_divergence_diagnostics module
    • apply()
  • pm4py.objects.ocel.util.ev_att_to_obj_type module
    • Parameters
      • Parameters.EVENT_ID
      • Parameters.EVENT_ACTIVITY
      • Parameters.EVENT_TIMESTAMP
      • Parameters.OBJECT_ID
      • Parameters.OBJECT_TYPE
      • Parameters.INTERNAL_INDEX
    • apply()
  • pm4py.objects.ocel.util.event_prefix_suffix_per_obj module
    • Parameters
      • Parameters.PREFIX_OR_SUFFIX
      • Parameters.INDEX_ATTRIBUTE
      • Parameters.LEFT_SUFFIX
      • Parameters.RIGHT_SUFFIX
    • apply()
  • pm4py.objects.ocel.util.events_per_object_type module
    • Parameters
      • Parameters.EVENT_ID
      • Parameters.OBJECT_TYPE
    • apply()
  • pm4py.objects.ocel.util.events_per_type_per_activity module
    • Parameters
      • Parameters.EVENT_ID
      • Parameters.EVENT_ACTIVITY
      • Parameters.OBJECT_ID
      • Parameters.OBJECT_TYPE
    • apply()
  • pm4py.objects.ocel.util.explode module
    • apply()
  • pm4py.objects.ocel.util.extended_table module
    • Parameters
      • Parameters.OBJECT_TYPE_PREFIX
      • Parameters.EVENT_ID
      • Parameters.EVENT_ACTIVITY
      • Parameters.EVENT_TIMESTAMP
      • Parameters.OBJECT_ID
      • Parameters.OBJECT_TYPE
      • Parameters.INTERNAL_INDEX
    • parse_list()
    • get_ocel_from_extended_table()
  • pm4py.objects.ocel.util.filtering_utils module
    • Parameters
      • Parameters.EVENT_ID
      • Parameters.OBJECT_ID
      • Parameters.OBJECT_TYPE
    • propagate_event_filtering()
    • propagate_object_filtering()
    • propagate_relations_filtering()
  • pm4py.objects.ocel.util.flattening module
    • Parameters
      • Parameters.EVENT_ACTIVITY
      • Parameters.EVENT_TIMESTAMP
    • flatten()
  • pm4py.objects.ocel.util.log_ocel module
    • Parameters
      • Parameters.CASE_ID_KEY
      • Parameters.CASE_ATTRIBUTE_PREFIX
      • Parameters.ACTIVITY_KEY
      • Parameters.TIMESTAMP_KEY
      • Parameters.TARGET_OBJECT_TYPE
      • Parameters.TARGET_OBJECT_TYPE_2
      • Parameters.LEFT_INDEX
      • Parameters.RIGHT_INDEX
      • Parameters.DIRECTION
    • from_traditional_log()
    • from_traditional_pandas()
    • from_interleavings()
    • log_to_ocel_multiple_obj_types()
  • pm4py.objects.ocel.util.names_stripping module
    • apply()
  • pm4py.objects.ocel.util.objects_per_type_per_activity module
    • Parameters
      • Parameters.EVENT_ID
      • Parameters.EVENT_ACTIVITY
      • Parameters.OBJECT_ID
      • Parameters.OBJECT_TYPE
    • apply()
  • pm4py.objects.ocel.util.ocel_iterator module
    • Parameters
      • Parameters.OCEL_TYPE_PREFIX
    • apply()
  • pm4py.objects.ocel.util.parent_children_ref module
    • apply()
  • pm4py.objects.ocel.util.related_events module
    • related_events_dct()
  • pm4py.objects.ocel.util.related_objects module
    • related_objects_dct_per_type()
    • related_objects_dct_overall()
  • pm4py.objects.ocel.util.sampling module
    • Parameters
      • Parameters.OBJECT_ID
      • Parameters.EVENT_ID
      • Parameters.NUM_ENTITIES
    • sample_ocel_events()
    • sample_ocel_objects()
• pm4py.objects.ocel.validation package
  • Submodules
  • pm4py.objects.ocel.validation.jsonocel module
    • apply()
  • pm4py.objects.ocel.validation.xmlocel module
    • apply()

Submodules

pm4py.objects.ocel.constants 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/>.

pm4py.objects.ocel.obj 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.objects.ocel.obj.Parameters(value)

Bases: Enum

An enumeration.

EVENT_ID = 'param:event:id'

EVENT_ACTIVITY = 'param:event:activity'

EVENT_TIMESTAMP = 'param:event:timestamp'

OBJECT_ID = 'param:object:id'

OBJECT_TYPE = 'param:object:type'

QUALIFIER = 'param:qualifier'

CHANGED_FIELD = 'param:chngfield'

class pm4py.objects.ocel.obj.OCEL(events=None, objects=None, relations=None, globals=None, parameters=None, o2o=None, e2e=None, object_changes=None)

Bases: object

get_extended_table(ot_prefix='ocel:type:') → DataFrame

Transforms the current OCEL data structure into a Pandas dataframe containing the events with their attributes and the related objects per object type.

get_summary() → str

Gets a string summary of the object-centric event log