regionate.regions.GriddedRegions

class regionate.regions.GriddedRegions(region_dict, grid, name=None)[source]

Bases: Regions

A dictionary of named polygonal regions that exactly conform to the velocity faces of a C-grid ocean model.

Methods

copy([remove_duplicate_points])

Returns a copy of the Regions.

find_all_overlaps([closeness_threshold, ...])

Finds indices of self.overlaps between region boundaries

to_grs(path)

TO DO
copy(remove_duplicate_points=False)

Returns a copy of the Regions.

Parameters:

remove_duplicate_points (bool) – Default: False. If True, prunes any duplicate points from the input arrays (lons, lats).

Returns:

region_copy – Copy of the region.

Return type:

regionate.regions.Regions type

find_all_overlaps(closeness_threshold=5000.0, face_indices=False)

Finds indices of self.overlaps between region boundaries

Combined with sectionate, this can be used to determine transports across shared boundaries between two adjacent regions.

to_grs(path)[source]

TO DO