starepandas.STAREDataFrame.to_stare_level

STAREDataFrame.to_stare_level(level, inplace=False, clear_to_level=False)

Changes level of STARE index values to level; optionally clears location bits up to level. Caution: This method is not intended for use on feautures represented by sets of sids.

Parameters

inplace: bool

If True, modifies the DataFrame in place (do not create a new object).

level: int

STARE level to change to.

clear_to_level: bool

Toggle if the location bits below level should be cleared

Returns

if not inplace, returns stare index values, otherwise None

Examples

>>> sids = [2299437706637111721, 2299435211084507593, 2299566194809236969]
>>> sdf = starepandas.STAREDataFrame(sids=sids)
>>> sdf.to_stare_level(level=6, clear_to_level=False)
                  sids
0  2299437706637111718
1  2299435211084507590
2  2299566194809236966