pm4py.algo.filtering.pandas.traces.trace_filter module#

class pm4py.algo.filtering.pandas.traces.trace_filter.Parameters(*values)[source]#

Bases: Enum

CASE_ID_KEY = 'pm4py:param:case_id_key'#
ACTIVITY_KEY = 'pm4py:param:activity_key'#
DECREASING_FACTOR = 'decreasingFactor'#
POSITIVE = 'positive'#
pm4py.algo.filtering.pandas.traces.trace_filter.apply(df: DataFrame, admitted_traces: List[List[str]], parameters: Dict[str | Parameters, Any] | None = None) → DataFrame[source]#

Apply a filter on variants

Parameters:

  • df – Dataframe

  • admitted_traces – List of admitted traces (to include/exclude)

  • parameters –

    Parameters of the algorithm, including:

    Parameters.CASE_ID_KEY -> Column that contains the Case ID Parameters.ACTIVITY_KEY -> Column that contains the activity Parameters.POSITIVE -> Specifies if the filter should be applied including traces (positive=True) or excluding traces (positive=False) variants_df -> If provided, avoid recalculation of the variants dataframe

Returns:

Filtered dataframe

Return type:

df