shoot.hydrology.Anomaly

shoot.hydrology.Anomaly#

class shoot.hydrology.Anomaly(eddy, eddies, dens, depth=None, r_factor=1.2, nz=100, eddy_type=True)[source]#

Compute 3D anomalies inside and outside an eddy

Compares vertical profiles of a tracer (density, temperature, etc.) inside and outside an eddy to compute anomalies.

Parameters:
  • eddy (RawEddy2D) – Eddy object with location and contour information.

  • eddies (Eddies2D) – Collection of all eddies (to exclude from background).

  • dens (xarray.DataArray) – 3D tracer field (e.g., density, temperature).

  • depth (xarray.DataArray, optional) – 3D depth field. Inferred from dens if not provided.

  • r_factor (float, default 1.2) – Radius factor for selecting outside profiles.

  • nz (int, default 100) – Number of vertical levels for interpolation.

__init__(eddy, eddies, dens, depth=None, r_factor=1.2, nz=100, eddy_type=True)[source]#

Methods

anomaly_at_depth(depth_level[, signed])

Get the anomaly value at a specific depth

is_inside(x, y)

Test if grid points are inside the eddy maximum velocity contour

is_valid(x, y)

Test if grid points are outside all eddy boundary contours

Attributes