polaris.mesh.spherical.unified.effective_ocean.hysteresis_grow

polaris.mesh.spherical.unified.effective_ocean.hysteresis_grow(filled, frac, grow_threshold)

Grow a flood-filled ocean mask into connected regions whose fraction is at least grow_threshold.

Only components of the lower-threshold mask that touch the strict flood-filled ocean are added, so isolated inland regions are not promoted.

Parameters:

• filled (numpy.ndarray) – The strict flood-filled ocean mask, with dimensions (lat, lon)

• frac (numpy.ndarray) – The mesh-scale candidate fraction on the same grid

• grow_threshold (float) – The lower bound on the fraction for growth

Returns:

grown (numpy.ndarray) – The grown mask