filter_df_mask#

caf.toolkit.pandas_utils.filter_df_mask(df, df_filter)[source]#

Generate a mask for filtering a pandas DataFrame by a filter.

Parameters:
  • df (DataFrame) – The pandas.Dataframe to filter.

  • df_filter (dict[str, Any]) – Dictionary of {column: valid_values} pairs to define the filter to be applied. valid_values can be a single value or a list of values. Will return only where all column conditions are met.

Returns:

A mask, which when applied, will filter df down to df_filter.

Return type:

filter_mask