sids_from_xy_df#

sids_from_xy_df(df, level, n_partitions=1, num_workers=None)#

Takes a dataframe and generates an array of STARE index values. Assumes latitude column name is {‘lat’, ‘Latitude’, ‘latitude’, or ‘y’} and longitude column name is {‘lon’, ‘Longitude’, ‘longitude’, or ‘x’}

Parameters:
df: pandas.DataFrame

Dataframe containing x/y coordinates

level: int

STARE spatial level

n_partitions: int

Number of workers used to lookup STARE indices in parallel

Returns:
sids

Array of STARE index values

Examples

>>> import starepandas
>>> import pandas
>>> x = [-119.42, 7.51]
>>> y = [34.25, 47.59]
>>> df = pandas.DataFrame({'lat': y, 'lon': x})
>>> starepandas.sids_from_xy_df(df, level=20)
array([3331752989521980116, 4271829667422230484])