uxarray.UxDataArray.to_polycollection

UxDataArray.to_polycollection(override=False, cache=True, correct_antimeridian_polygons=True)

Constructs a matplotlib.collections.PolyCollection object with polygons representing the geometry of the unstructured grid, with polygons that cross the antimeridian split across the antimeridian.

Parameters:

• override (bool) – Flag to recompute the PolyCollection stored under the uxgrid if one is already cached

• cache (bool) – Flag to indicate if the computed PolyCollection stored under the uxgrid accessor should be cached

• correct_antimeridian_polygons (bool, Optional) – Parameter to select whether to correct and split antimeridian polygons

Returns:

poly_collection – The output PolyCollection of polygons representing the geometry of the unstructured grid paired with a data variable.

Return type:

matplotlib.collections.PolyCollection