pm4py.objects.ocel.util package¶

Submodules¶

pm4py.objects.ocel.util.attributes_names 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.util.attributes_names.get_attribute_names(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → List[str][source]¶

Gets the list of attributes at the event and the object level of an object-centric event log (e.g. [“cost”, “amount”, “name”])

Parameters:	ocel – Object-centric event log parameters – Parameters of the algorithm
Returns:	List of attributes at the event and object level (e.g. [“cost”, “amount”, “name”])
Return type:	attributes_list

pm4py.objects.ocel.util.extended_table 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.util.extended_table.Parameters[source]¶

Bases: enum.Enum

An enumeration.

EVENT_ACTIVITY = 'param:event:activity'¶

EVENT_ID = 'param:event:id'¶

EVENT_TIMESTAMP = 'param:event:timestamp'¶

INTERNAL_INDEX = 'param:internal:index'¶

OBJECT_ID = 'param:object:id'¶

OBJECT_TYPE = 'param:object:type'¶

OBJECT_TYPE_PREFIX = 'param:object:type:prefix:extended'¶

pm4py.objects.ocel.util.extended_table.get_ocel_from_extended_table(df: pandas.core.frame.DataFrame, objects_df: Optional[Dict[Any, Any]] = None, parameters: Optional[Dict[Any, Any]] = None) → pm4py.objects.ocel.obj.OCEL[source]¶

pm4py.objects.ocel.util.extended_table.parse_list(value)[source]¶

pm4py.objects.ocel.util.filtering_utils 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.util.filtering_utils.Parameters[source]¶

Bases: enum.Enum

An enumeration.

EVENT_ID = 'param:event:id'¶

OBJECT_ID = 'param:object:id'¶

OBJECT_TYPE = 'param:object:type'¶

pm4py.objects.ocel.util.filtering_utils.propagate_event_filtering(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → pm4py.objects.ocel.obj.OCEL[source]¶

Propagates the filtering at the event level to the remaining parts of the OCEL structure (objects, relations)

Parameters:	ocel – Object-centric event log parameters – Parameters of the algorithm, including: - Parameters.EVENT_ID => the column to be used as case identifier - Parameters.OBJECT_ID => the column to be used as object identifier - Parameters.OBJECT_TYPE => the column to be used as object type
Returns:	Object-centric event log with propagated filter
Return type:	ocel

pm4py.objects.ocel.util.filtering_utils.propagate_object_filtering(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → pm4py.objects.ocel.obj.OCEL[source]¶

Propagates the filtering at the object level to the remaining parts of the OCEL structure (events, relations)

Parameters:	ocel – Object-centric event log parameters – Parameters of the algorithm, including: - Parameters.EVENT_ID => the column to be used as case identifier - Parameters.OBJECT_ID => the column to be used as object identifier - Parameters.OBJECT_TYPE => the column to be used as object type
Returns:	Object-centric event log with propagated filter
Return type:	ocel

pm4py.objects.ocel.util.filtering_utils.propagate_relations_filtering(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → pm4py.objects.ocel.obj.OCEL[source]¶

Propagates the filtering at the relations level to the remaining parts of the OCEL structure (events, objects)

Parameters:	ocel – Object-centric event log parameters – Parameters of the algorithm, including: - Parameters.EVENT_ID => the column to be used as case identifier - Parameters.OBJECT_ID => the column to be used as object identifier - Parameters.OBJECT_TYPE => the column to be used as object type
Returns:	Object-centric event log with propagated filter
Return type:	ocel

pm4py.objects.ocel.util.flattening 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.util.flattening.Parameters[source]¶

Bases: enum.Enum

An enumeration.

EVENT_ACTIVITY = 'param:event:activity'¶

EVENT_TIMESTAMP = 'param:event:timestamp'¶

pm4py.objects.ocel.util.flattening.flatten(ocel: pm4py.objects.ocel.obj.OCEL, ot: str, parameters: Optional[Dict[Any, Any]] = None) → pandas.core.frame.DataFrame[source]¶

Flattens the object-centric event log to a traditional event log with the choice of an object type. In the flattened log, the objects of a given object type are the cases, and each case contains the set of events related to the object.

Parameters:	ocel – Object-centric event log ot – Object type parameters – Parameters of the algorithm, including: - Parameters.EVENT_ACTIVITY - Parameters.EVENT_TIMESTAMP
Returns:	Flattened log in the form of a Pandas dataframe
Return type:	dataframe

pm4py.objects.ocel.util.related_events 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.util.related_events.related_events_dct(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → Dict[str, Dict[str, List[str]]][source]¶

pm4py.objects.ocel.util.related_objects 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.util.related_objects.related_objects_dct_overall(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → Dict[str, List[str]][source]¶

pm4py.objects.ocel.util.related_objects.related_objects_dct_per_type(ocel: pm4py.objects.ocel.obj.OCEL, parameters: Optional[Dict[Any, Any]] = None) → Dict[str, Dict[str, List[str]]][source]¶

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