starepandas.STAREDataFrame.set_sids#

STAREDataFrame.set_sids(col, inplace=False)#

Set the StareDataFrame spatial indices using either an existing column or the specified input. By default, yields a new object. The original tid column is replaced with the input.

Parameters:
col: array-like

f stare sids or column name

inplace: boolean

Modify the StareDataFrame in place (do not create a new object)

Returns:
df: STAREDataFrame

the df with sids

Examples

>>> import starepandas
>>> sdf = starepandas.STAREDataFrame()
>>> sids = [4611686018427387903, 2299435211084507590, 2299566194809236966]
>>> sdf.set_sids(sids, inplace=True)