TimeFrame.register_flag_column

TimeFrame.register_flag_column(column_name, flag_system_name)[source]

Mark the specified existing column as a flag column.

All non-null values in the column must be valid flag values for the given flag system.

Parameters:

  • column_name (str) – A column name to mark as a flag column.

  • flag_system_name (str) – The name of the registered flag system.

Raises:

  • BitwiseFlagUnknownError – If the column contains values with bits not in the bitwise flag system.

  • CategoricalFlagUnknownError – If the column contains values not in the categorical flag system.

Return type:

None