pm4py.objects.log.util.basic_filter module#

PM4Py – A Process Mining Library for Python Copyright (C) 2026 Process Intelligence Solutions GmbH

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.objects.log.util.basic_filter.Parameters(*values)[source]#

Bases: Enum

ATTRIBUTE_KEY = 'pm4py:param:attribute_key'#
POSITIVE = 'positive'#
pm4py.objects.log.util.basic_filter.filter_log_events_attr(log, values, parameters=None)[source]#

Filter log by keeping only events with an attribute value that belongs to the provided values list

Parameters:
  • log – log

  • values – Allowed attributes

  • parameters –

    Parameters of the algorithm, including:

    activity_key -> Attribute identifying the activity in the log positive -> Indicate if events should be kept/removed

Returns:

Filtered log

Return type:

filtered_log

pm4py.objects.log.util.basic_filter.filter_log_traces_attr(log, values, parameters=None)[source]#

Filter log by keeping only traces that has/has not events with an attribute value that belongs to the provided values list

Parameters:
  • log – Trace log

  • values – Allowed attributes

  • parameters –

    Parameters of the algorithm, including:

    activity_key -> Attribute identifying the activity in the log positive -> Indicate if events should be kept/removed

Returns:

Filtered log

Return type:

filtered_log