pm4py.filtering.filter_variants#
- pm4py.filtering.filter_variants(log: EventLog | DataFrame, variants: Set[str] | List[str] | List[Tuple[str]], retain: bool = True, activity_key: str = 'concept:name', timestamp_key: str = 'time:timestamp', case_id_key: str = 'case:concept:name') EventLog | DataFrame [source]#
Filters a log based on a specified set of variants.
- Parameters:
log – Event log or Pandas DataFrame.
variants – Collection of variants to filter. A variant should be specified as a list of tuples of activity names, e.g., [(‘a’, ‘b’, ‘c’)].
retain (
bool
) – Boolean indicating whether to retain (if True) or remove (if False) traces conforming to the specified variants.activity_key (
str
) – Attribute to be used for the activity.timestamp_key (
str
) – Attribute to be used for the timestamp.case_id_key (
str
) – Attribute to be used as case identifier.
- Returns:
Filtered event log or Pandas DataFrame.
import pm4py filtered_dataframe = pm4py.filter_variants( dataframe, [('Act. A', 'Act. B', 'Act. Z'), ('Act. A', 'Act. C', 'Act. Z')], activity_key='concept:name', case_id_key='case:concept:name', timestamp_key='time:timestamp' )