OceanDB.data_access.eddy#

class OceanDB.data_access.eddy.Eddy(config=None)#

Bases: BaseReadQuery

Parameters:

config (Config | None)

along_track_points_near_eddy(*, track_id, fields=None)#

Retrieve along-track altimetry points spatially and temporally associated with a given eddy track.

If no eddy of the given id exists, will raise a ValueError

The eddy envelope (time range and basin membership) is computed first and used to parameterize the along-track query.

Parameters:

  • track_id (int) – Query eddy track id ( - = cyclonic, + = anticyclonic )

  • fields (Iterable[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']] | None) – Requested along track fields to output. If none are specified, defaults to default_along_track_fields

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 along track data is found surrounding the eddy, None is returned. Otherwise, a Dataset of along track data with requested fields is returned.

eddy_envelope_query(track_id)#

Compute the spatiotemporal envelope for a single eddy track. Specifically, extracts

  • the minimum and maximum observation timestamps surrounding the eddy

  • the set of basins intersecting the eddy over its lifetime.

Parameters:

track_id (int) – Query eddy track id ( - = cyclonic, + = anticyclonic )

Return type:

Dataset[Literal['max_date', 'min_date', 'basin_ids'], Any] | None

Returns:

Single-row dataset used to parameterize downstream along-track queries (time window and basin filtering).

eddy_with_track_id(fields, track_id)#

Retrieve observations for a single eddy track.

Parameters:

  • fields (list[Literal['amplitude', 'cost_association', 'effective_area', 'effective_contour_height', 'effective_contour_latitude', 'effective_contour_longitude', 'effective_contour_shape_error', 'effective_radius', 'inner_contour_height', 'latitude', 'latitude_max', 'longitude', 'longitude_max', 'num_contours', 'num_point_e', 'num_point_s', 'observation_flag', 'observation_number', 'speed_area', 'speed_average', 'speed_contour_height', 'speed_contour_shape', 'speed_contour_shape_error', 'speed_radius', 'date_time', 'track', 'cyclonic_type']]) – Requested fields to output

  • track_id (int) – Query eddy track id ( - = cyclonic, + = anticyclonic )

Return type:

Dataset[Literal['amplitude', 'cost_association', 'effective_area', 'effective_contour_height', 'effective_contour_latitude', 'effective_contour_longitude', 'effective_contour_shape_error', 'effective_radius', 'inner_contour_height', 'latitude', 'latitude_max', 'longitude', 'longitude_max', 'num_contours', 'num_point_e', 'num_point_s', 'observation_flag', 'observation_number', 'speed_area', 'speed_average', 'speed_contour_height', 'speed_contour_shape', 'speed_contour_shape_error', 'speed_radius', 'date_time', 'track', 'cyclonic_type'], ndarray[Any, dtype[floating]]] | None

Returns:

If no eddy found with the specified track id, None is returned. Otherwise, a Dataset of eddy data with requested fields is returned.

get_eddy_tracks_from_times(start_date, end_date)#

Retrieve distinct eddy track identifiers observed within a given time range.

Return type:

list[int]

Returns:

Eddy track ids ( - = cyclonic, + = anticyclonic )

Parameters:

  • start_date (datetime)

  • end_date (datetime)

default_along_track_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']] = ['file_name', 'track', 'cycle', 'latitude', 'longitude', 'sla_unfiltered', 'sla_filtered', 'date_time', 'dac', 'ocean_tide', 'internal_tide', 'lwe', 'mdt', 'tpa_correction']#