TimeFrame.with_flag_system

TimeFrame.with_flag_system(name, flag_system, flag_type='bitwise')

Return a new TimeFrame, with a flag system registered.

Parameters:

• name (str) – Short name for the flag system.

• flag_system (Mapping[str, int | str] | list[str] | None) – The flag system definition. See register_flag_system for accepted types.

• flag_type (Literal['bitwise', 'categorical', 'categorical_list']) – Whether to create a "bitwise" or "categorical" flag system. Only relevant when flag_system is a dict[str, int] or list[str].

Return type:

TimeFrame

Returns:

A new TimeFrame with the flag system registered.