uxarray.Grid.to_linecollection

uxarray.Grid.to_linecollection#

Grid.to_linecollection(periodic_elements='exclude', projection=None, cache=True, override=False, **kwargs)#

Constructs a matplotlib.collections.LineCollection` consisting of lines representing the edges of the current Grid

Parameters:

  • periodic_elements (str, optional) – Method for handling periodic elements. One of [‘exclude’, ‘split’, or ‘ignore’]: - ‘exclude’: Periodic elements will be identified and excluded from the GeoDataFrame - ‘split’: Periodic elements will be identified and split using the antimeridian package - ‘ignore’: No processing will be applied to periodic elements.

  • projection (ccrs.Projection) – Cartopy geographic projection to use

  • cache (bool) – Flag to indicate whether to cache the computed PolyCollection

  • override (bool) – Flag to indicate whether to override a cached PolyCollection, if it exists

  • **kwargs (dict) – Key word arguments to pass into the construction of a PolyCollection

Contents