shoot.eddies.eddies3d.Eddies3D

shoot.eddies.eddies3d.Eddies3D#

class shoot.eddies.eddies3d.Eddies3D(u, v, depths, eddies, eddies_byslice)[source]#

Collection of 3D eddies detected across depth levels

Associates 2D eddy detections vertically to build coherent 3D structures. Use detect_eddies_3d() for detection.

Parameters:
__init__(u, v, depths, eddies, eddies_byslice)[source]#

Methods

detect_eddies_3d(u, v, window_center[, ...])

plot2d([depth, boundary, vmax, quiver, ns])

plot the 2D vorticity field superimposed with eddies detection at the nearest layer depth