OceanDB.data_access.along_track#

class OceanDB.data_access.along_track.AlongTrack(config=None)#

Bases: BaseReadQuery

Parameters:

config (Config | None)

geographic_nearest_neighbors(fields, latitude, longitude, date, time_window=datetime.timedelta(days=10), missions=['al', 'alg', 'c2', 'c2n', 'e1g', 'e1', 'e2', 'en', 'enn', 'g2', 'h2a', 'h2b', 'j1g', 'j1', 'j1n', 'j2g', 'j2', 'j2n', 'j3', 'j3n', 's3a', 's3b', 's6a', 'tp', 'tpn'])#

Query along-track points within spatial + temporal windows.

Yields one Dataset per query point, or None if empty.

Parameters:

  • fields (list)

  • latitude (float)

  • longitude (float)

  • date (datetime)

  • time_window (timedelta)

  • missions (list[Literal['al', 'alg', 'c2', 'c2n', 'e1g', 'e1', 'e2', 'en', 'enn', 'g2', 'h2a', 'h2b', 'j1g', 'j1', 'j1n', 'j2g', 'j2', 'j2n', 'j3', 'j3n', 's3a', 's3b', 's6a', 'tp', 'tpn']])

Return type:

Dataset[Literal['latitude', 'longitude', 'date_time', 'file_name', 'mission', 'track', 'cycle', 'basin_id', 'sla_unfiltered', 'sla_filtered', 'dac', 'ocean_tide', 'internal_tide', 'lwe', 'mdt', 'tpa_correction'] | Literal['distance', 'delta_t'], Any] | None

geographic_point_in_r_dt(fields, latitude, longitude, date, radius=500000.0, time_window=datetime.timedelta(days=10), missions=['al', 'alg', 'c2', 'c2n', 'e1g', 'e1', 'e2', 'en', 'enn', 'g2', 'h2a', 'h2b', 'j1g', 'j1', 'j1n', 'j2g', 'j2', 'j2n', 'j3', 'j3n', 's3a', 's3b', 's6a', 'tp', 'tpn'])#

Query along-track points within spatial + temporal windows.

Yields one Dataset, or None if empty.

Parameters:

  • fields (list[Literal['latitude', 'longitude', 'date_time', 'file_name', 'mission', 'track', 'cycle', 'basin_id', 'sla_unfiltered', 'sla_filtered', 'dac', 'ocean_tide', 'internal_tide', 'lwe', 'mdt', 'tpa_correction'] | Literal['distance', 'delta_t']]) – List of requested along track fields to return

  • latitude (float) – Central latitude of the window

  • longitude (float) – Central longitude of the window

  • date (datetime) – Central date of the window

  • radius (float) – Radius of the spatial window in meters

  • time_window (timedelta) – Radius of the temporal window (meaning any point from [date - time_window, date + time_window] could be include)

  • missions (list[Literal['al', 'alg', 'c2', 'c2n', 'e1g', 'e1', 'e2', 'en', 'enn', 'g2', 'h2a', 'h2b', 'j1g', 'j1', 'j1n', 'j2g', 'j2', 'j2n', 'j3', 'j3n', 's3a', 's3b', 's6a', 'tp', 'tpn']]) – List of satellite missions to include in the query (defaults to all available, see AlongTrack.all_missions)

Return type:

Dataset[Literal['latitude', 'longitude', 'date_time', 'file_name', 'mission', 'track', 'cycle', 'basin_id', 'sla_unfiltered', 'sla_filtered', 'dac', 'ocean_tide', 'internal_tide', 'lwe', 'mdt', 'tpa_correction'] | Literal['distance', 'delta_t'], Any] | None

Returns:

If no points found in the window, None is returned. If points are found, then a Dataset of requested fields is returned.

all_missions = ['al', 'alg', 'c2', 'c2n', 'e1g', 'e1', 'e2', 'en', 'enn', 'g2', 'h2a', 'h2b', 'j1g', 'j1', 'j1n', 'j2g', 'j2', 'j2n', 'j3', 'j3n', 's3a', 's3b', 's6a', 'tp', 'tpn']#