shoot.eddies.associate.BiMod

shoot.eddies.associate.BiMod#

class shoot.eddies.associate.BiMod(eddies, ref_eddies, dmax)[source]#

Bipartite matching for eddy association with validation metrics

Performs eddy association and computes validation metrics including match proportion, area overlap, and distance between matched eddies.

Parameters:
  • eddies (Eddies2D) – Eddies to associate with reference.

  • ref_eddies (Eddies2D) – Reference eddies for comparison.

  • dmax (float) – Maximum distance (km) for association.

pmatch#

Proportion of eddies that match with reference (property).

Type:

float

parea#

Average intersection area ratio between matched eddies (property).

Type:

float

dist#

Average distance (km) between matched eddy centers (property).

Type:

float

__init__(eddies, ref_eddies, dmax)[source]#

Initialize bipartite matcher

Parameters:
  • eddies (Eddies2D) – Eddies to associate with reference.

  • ref_eddies (Eddies2D) – Reference eddies for comparison.

  • dmax (float) – Maximum distance (km) for association.

Methods

compare(eddies, ref_eddies[, max_distance])

add id to ref eddies and associate eddies to this ids when possible

Attributes

dist

Average distance between matched eddy centers

parea

Average intersection area ratio between matched eddies

pmatch

Proportion of eddies that match with reference eddies