stilt.observations.group_by_overpass#

stilt.observations.group_by_overpass(times, *, max_gap='30min')[source]#

Label each time with the overpass it belongs to.

Soundings from one satellite pass are seconds apart and passes are hours apart, so a new overpass starts wherever sorted times differ by more than max_gap. This is X-STILT’s overpass grouping.

Parameters:

  • times (TypeAliasType | Series) – Sounding times.

  • max_gap (str | Timedelta) – Largest gap between soundings of one overpass.

Returns:

The first time of each sounding’s overpass, as YYYYMMDDHHMM, aligned with times.

Return type:

Series

Examples

>>> df["overpass"] = group_by_overpass(df["time"])
>>> for label, scene in df.groupby("overpass"):
...     ...