TimeFrame.remove_flag¶

TimeFrame.remove_flag(column_name, flag_value, expr=<Expr ['true']>)[source]¶

Remove a flag value from a flag column, where expression is True.

For bitwise flag columns, clears the flag bit via bitwise AND NOT.

For categorical flag columns in scalar mode, sets the column value to null.

For categorical flag columns in list mode, removes all occurrences of the value from the list.

Parameters:

column_name (str) – The name of the flag column.
flag_value (int | str) – The flag value to remove.
expr (Expr | Series) – Polars expression for which rows to remove the flag from.

Return type:

None