mpas_tools.mesh.mask.compute_mpas_region_masks

mpas_tools.mesh.mask.compute_mpas_region_masks(dsMesh, fcMask, maskTypes=('cell', 'vertex'), logger=None, pool=None, chunkSize=1000, showProgress=False, subdivisionThreshold=30.0)[source]

Create region masks (polygons) on an MPAS mesh.

Parameters:

  • dsMesh (xarray.Dataset) – MPAS mesh dataset.

  • fcMask (geometric_features.FeatureCollection) – Feature collection containing polygon regions.

  • maskTypes (tuple of {'cell', 'edge', 'vertex'}, optional) – Which types of masks to create.

  • logger (logging.Logger, optional) – Logger for progress output.

  • pool (multiprocessing.Pool, optional) – Pool for parallel computation. Strongly recommended for large meshes.

  • chunkSize (int, optional) – Number of points to process per chunk.

  • showProgress (bool, optional) – Show a progress bar.

  • subdivisionThreshold (float, optional) – Subdivide large polygons for efficiency (degrees).

Returns:

dsMasks (xarray.Dataset) – Dataset containing region masks and region names.