OceanColor.inrange.matchup

OceanColor.inrange.matchup(track, ds, dL_tol: float, dt_tol, queue=None)[source]

Search a granule for pixels within range (time/space) of a track

For a given sequence of waypoints (track), it returns all satellite pixels (data) from ds which are at most dL_tol (distance tolerance) and dt_tol (time tolerance) from one of the waypoints. The output includes lat and lon of the found pixel, plus dL (distance), and dt (difference in time) between the matchup pixel - waypoint.

This is the generic function that will choose which procedure to apply according to the processing level of the image, since they are structured in different projections.

Parameters

  • track (pandas.DataFrame) – A collection of waypoints containing {time, lat, lon}. The index on this DataFrame will be used as the reference on for the output.

  • ds (xarray.Dataset) – An L2 granule, which is usually loaded from a netCDF.

  • dL_tol (float) – Maximum distance in meters from a waypoint to be considered a matchup.

  • dt_tol (np.timedelta64) – Maximum accepted time difference to be considered a matchup.

  • queue (Queue.queue, optional) – If given, the results are sent to this queue.

Returns

matchup – All pixels within space and time range from the given track of waypoints. One pixel per row. If queue is given as an input, the returns are instead transmitted to that queue and the function returns None instead.

Return type

pd.DataFrame

See also

matchup_L2

Search an L2 dataset for pixels within a range

matchup_L3m

Search an L3m dataset for pixels within a range