Skip to main content
Back to top
Ctrl
+
K
Search
Ctrl
+
K
User Guide
Installation
Quick Start Guide
In-Depth Guide
Eddies
Eddy Detection
Eddy Tracking
Fronts (Coming Soon)
Metadata and CF Conventions
Working with Profiles
Commandline interface
shoot
shoot eddies
shoot eddies detect
shoot eddies track
shoot eddies track-detected
shoot eddies diags
Examples
Detect eddies from satellite sea level
Detect CROCO-GIGATL1 eddies at 1000m
Detect eddies from different files and merge tracking
Diagnostics prior to eddy detection
Detect CROCO-MED1.8 eddies at different depths and link the detections
Detect and Track eddies from satellite sea level
Profile anomalies diags
Open and analyse shoot output netcdf
Reference
Algorithms
Eddies
Library
shoot
shoot.shoot_warn
shoot.ShootError
shoot.ShootWarning
shoot.acoustic
shoot.acoustic.acoustic_points
shoot.acoustic.get_ecs
shoot.acoustic.get_iminc
shoot.acoustic.get_mcp
shoot.acoustic.AcousEddy
shoot.acoustic.AcousEddy.acoustic_impact
shoot.acoustic.AcousEddy.ecs_inside
shoot.acoustic.AcousEddy.ecs_insides
shoot.acoustic.AcousEddy.ecs_outside
shoot.acoustic.AcousEddy.ecs_outsides
shoot.acoustic.AcousEddy.iminc_inside
shoot.acoustic.AcousEddy.iminc_insides
shoot.acoustic.AcousEddy.iminc_outside
shoot.acoustic.AcousEddy.iminc_outsides
shoot.acoustic.AcousEddy.mcp_inside
shoot.acoustic.AcousEddy.mcp_insides
shoot.acoustic.AcousEddy.mcp_outside
shoot.acoustic.AcousEddy.mcp_outsides
shoot.acoustic.ProfileAcous
shoot.acoustic.ProfileAcous.ecs
shoot.acoustic.ProfileAcous.ilmax
shoot.acoustic.ProfileAcous.ilmin
shoot.acoustic.ProfileAcous.iminc
shoot.acoustic.ProfileAcous.mcp
shoot.contours
shoot.contours.add_contour_dx_dy
shoot.contours.add_contour_uv
shoot.contours.area
shoot.contours.get_closed_contours
shoot.contours.get_lnam_peaks
shoot.contours.interp_to_line
shoot.contours.ContourMeanSpeedGetter
shoot.dyn
shoot.dyn.get_coriolis
shoot.dyn.get_div
shoot.dyn.get_geos
shoot.dyn.get_geos_old
shoot.dyn.get_lnam
shoot.dyn.get_okuboweiss
shoot.dyn.get_relvort
shoot.eddies
shoot.eddies.associate
shoot.eddies.associate.Associate
shoot.eddies.associate.Associate.order
shoot.eddies.associate.Associate.cost
shoot.eddies.associate.BiMod
shoot.eddies.associate.BiMod.compare
shoot.eddies.associate.BiMod.dist
shoot.eddies.associate.BiMod.parea
shoot.eddies.associate.BiMod.pmatch
shoot.eddies.eddies2d
shoot.eddies.eddies2d.find_eddy_centers
shoot.eddies.eddies2d.Eddies2D
shoot.eddies.eddies2d.Eddies2D.detect_eddies
shoot.eddies.eddies2d.Eddies2D.reconstruct
shoot.eddies.eddies2d.Eddies2D.test_eddy
shoot.eddies.eddies2d.Eddies2D.to_netcdf
shoot.eddies.eddies2d.Eddies2D.to_pv
shoot.eddies.eddies2d.Eddies2D.transfer_eddy_attr
shoot.eddies.eddies2d.Eddies2D.ds
shoot.eddies.eddies2d.Eddy
shoot.eddies.eddies2d.Eddy.contains_points
shoot.eddies.eddies2d.Eddy.plot
shoot.eddies.eddies2d.Eddy.plot_previ
shoot.eddies.eddies2d.Eddy.reconstruct
shoot.eddies.eddies2d.Eddy.color
shoot.eddies.eddies2d.Ellipse
shoot.eddies.eddies2d.Ellipse.from_coords
shoot.eddies.eddies2d.Ellipse.plot
shoot.eddies.eddies2d.Ellipse.reconstruct
shoot.eddies.eddies2d.Ellipse.to_json
shoot.eddies.eddies2d.Ellipse.color
shoot.eddies.eddies2d.Ellipse.eddy_type
shoot.eddies.eddies2d.Ellipse.sample
shoot.eddies.eddies2d.EvolEddies2D
shoot.eddies.eddies2d.EvolEddies2D.add
shoot.eddies.eddies2d.EvolEddies2D.clean_track
shoot.eddies.eddies2d.EvolEddies2D.detect_eddies
shoot.eddies.eddies2d.EvolEddies2D.merge_ds
shoot.eddies.eddies2d.EvolEddies2D.reconstruct
shoot.eddies.eddies2d.EvolEddies2D.to_netcdf
shoot.eddies.eddies2d.EvolEddies2D.ds
shoot.eddies.eddies2d.EvolEddies2D.ds_track
shoot.eddies.eddies2d.GriddedEddy2D
shoot.eddies.eddies2d.GriddedEddy2D.contains_eddy
shoot.eddies.eddies2d.GriddedEddy2D.contains_points
shoot.eddies.eddies2d.GriddedEddy2D.intersects_eddy
shoot.eddies.eddies2d.GriddedEddy2D.is_eddy
shoot.eddies.eddies2d.GriddedEddy2D.lignes
shoot.eddies.eddies2d.GriddedEddy2D.plot
shoot.eddies.eddies2d.GriddedEddy2D.plot_previ
shoot.eddies.eddies2d.GriddedEddy2D.boundary_contour
shoot.eddies.eddies2d.GriddedEddy2D.color
shoot.eddies.eddies2d.GriddedEddy2D.contours
shoot.eddies.eddies2d.GriddedEddy2D.coriolis
shoot.eddies.eddies2d.GriddedEddy2D.eddy_type
shoot.eddies.eddies2d.GriddedEddy2D.elat
shoot.eddies.eddies2d.GriddedEddy2D.ellipse
shoot.eddies.eddies2d.GriddedEddy2D.elon
shoot.eddies.eddies2d.GriddedEddy2D.lat
shoot.eddies.eddies2d.GriddedEddy2D.length
shoot.eddies.eddies2d.GriddedEddy2D.lon
shoot.eddies.eddies2d.GriddedEddy2D.ncontours
shoot.eddies.eddies2d.GriddedEddy2D.radius
shoot.eddies.eddies2d.GriddedEddy2D.ro
shoot.eddies.eddies2d.GriddedEddy2D.sign
shoot.eddies.eddies2d.GriddedEddy2D.ssh
shoot.eddies.eddies2d.GriddedEddy2D.ugeos
shoot.eddies.eddies2d.GriddedEddy2D.vgeos
shoot.eddies.eddies2d.GriddedEddy2D.vmax_contour
shoot.eddies.eddies3d
shoot.eddies.eddies3d.Associate
shoot.eddies.eddies3d.Associate.order
shoot.eddies.eddies3d.Associate.search_dist
shoot.eddies.eddies3d.Associate.cost
shoot.eddies.eddies3d.Eddies3D
shoot.eddies.eddies3d.Eddies3D.detect_eddies_3d
shoot.eddies.eddies3d.Eddies3D.plot2d
shoot.eddies.eddies3d.EddiesByDepth
shoot.eddies.eddies3d.EddiesByDepth.detect_eddies_3d
shoot.eddies.eddies3d.RawEddy3D
shoot.eddies.eddies3d.RawEddy3D.max_depth
shoot.eddies.eddies3d.RawEddy3D.min_depth
shoot.eddies.eddies3d.RawEddy3D.vmax
shoot.eddies.eddies3d.RawEddy3D.vmax_depth
shoot.eddies.track
shoot.eddies.track.track_eddies
shoot.eddies.track.update_tracks
shoot.eddies.track.Associate
shoot.eddies.track.Associate.order
shoot.eddies.track.Associate.rad_avg
shoot.eddies.track.Associate.ro_avg
shoot.eddies.track.Associate.search_dist
shoot.eddies.track.Associate.cost
shoot.eddies.track.AssociateMulti
shoot.eddies.track.AssociateMulti.indexmatching
shoot.eddies.track.AssociateMulti.order
shoot.eddies.track.AssociateMulti.rad_avg
shoot.eddies.track.AssociateMulti.ro_avg
shoot.eddies.track.AssociateMulti.search_dist
shoot.eddies.track.AssociateMulti.cost
shoot.eddies.track.Track
shoot.eddies.track.Track.reconstruct
shoot.eddies.track.Track.update
shoot.eddies.track.Track.ds
shoot.eddies.track.Tracks
shoot.eddies.track.Tracks.reconstruct
shoot.eddies.track.Tracks.refresh
shoot.eddies.track.Tracks.to_netcdf
shoot.eddies.track.Tracks.track_init
shoot.eddies.track.Tracks.track_step
shoot.eddies.track.Tracks.track_steps
shoot.eddies.track.Tracks.tracking
shoot.eddies.track.Tracks.update
shoot.eddies.track.Tracks.update_multi
shoot.eddies.track.Tracks.ds
shoot.hydrology
shoot.hydrology.compute_anomalies
shoot.hydrology.Anomaly
shoot.hydrology.Anomaly.anomaly_at_depth
shoot.hydrology.Anomaly.is_inside
shoot.hydrology.Anomaly.is_valid
shoot.hydrology.Anomaly.anomaly
shoot.hydrology.Anomaly.center_anomaly
shoot.hydrology.Anomaly.core_depth
shoot.hydrology.Anomaly.depth_vector
shoot.hydrology.Anomaly.intensity
shoot.hydrology.Anomaly.mean_profil_inside
shoot.hydrology.Anomaly.mean_profil_outside
shoot.hydrology.Anomaly.profil_inside
shoot.hydrology.Anomaly.profils_inside
shoot.hydrology.Anomaly.profils_outside
shoot.hydrology.Anomaly.signed_intensity
shoot.hydrology.Anomaly.std_profil_inside
shoot.hydrology.Anomaly.std_profil_outside
shoot.fit
shoot.fit.fit_ellipse_from_coords
shoot.grid
shoot.grid.get_dx_dy
shoot.grid.get_wx_wy
shoot.meta
shoot.meta.get_depth
shoot.meta.get_lat
shoot.meta.get_lon
shoot.meta.get_salt
shoot.meta.get_ssh
shoot.meta.get_temp
shoot.meta.get_time
shoot.meta.get_u
shoot.meta.get_v
shoot.meta.get_xdim
shoot.meta.get_ydim
shoot.meta.get_zdim
shoot.meta.register_meta_specs
shoot.meta.set_meta_specs
shoot.num
shoot.num.find_signed_peaks_2d
shoot.num.find_signed_peaks_2d_jb_old
shoot.num.get_coord_name
shoot.plot
shoot.plot.create_map
shoot.plot.plot_ellipse
shoot.profiles
shoot.profiles.download
shoot.profiles.download.load_from_ds
shoot.profiles.download.Download
shoot.profiles.download.Download.from_ds
shoot.profiles.profiles
shoot.profiles.profiles.Profile
shoot.profiles.profiles.Profiles
shoot.profiles.profiles.Profiles.associate
shoot.profiles.profiles.Profiles.background
shoot.profiles.profiles.Profiles.from_ds
shoot.profiles.profiles.Profiles.to_netcdf
shoot.profiles.profiles.Profiles.ds
Metadata Specification
Contributing to shoot
Github repository
Repository
Show source
Open issue
.rst
.pdf
shoot.eddies.eddies2d.GriddedEddy2D.contains_eddy
Contents
GriddedEddy2D.contains_eddy()
shoot.eddies.eddies2d.GriddedEddy2D.contains_eddy
#
GriddedEddy2D.
contains_eddy
(
eddy
)
[source]
#
Contents
GriddedEddy2D.contains_eddy()
