speedy_subset#

speedy_subset(df, right_sids)#

Speedy intersects is meant to subset large (long) STAREDataFrame to a subset that intersects the roi.

This method works particularly well if
  1. the df has significantly more SIDs than the roi_sids

  2. The SIDs of the df are at higher level than the roi_sids

Parameters:
df: starepandas.STAREDataFrame

the dataframe that is to be subset

right_sids: array-like

a set of SIDs describing the roi to whch the df is to be subset