easy_vic_build.tools.nc_func.mask_nc

Apply spatial masks to variables in NetCDF datasets.

Classes

mask_nc()

Mask selected NetCDF variables by shapefile or bounding region.

class easy_vic_build.tools.nc_func.mask_nc.mask_nc[source]

Bases: object

Mask selected NetCDF variables by shapefile or bounding region.

Initialize a mask_nc helper instance.

__init__()[source]

Initialize a mask_nc helper instance.

get_masked_val(lon, lat, src_val, mask_shp, mask_region, lon_valname, lat_valname, src_dataset)[source]

Compute masked values for a source variable.

Parameters:
  • lon (ndarray) – Longitude coordinates.

  • lat (ndarray) – Latitude coordinates.

  • src_val (netCDF4.Variable) – Source variable to be masked.

  • mask_shp (str or None) – Shapefile path used to define the mask.

  • mask_region (list of float or None) – Region bounds [lat_min, lat_max, lon_min, lon_max].

  • lon_valname (str) – Longitude variable name.

  • lat_valname (str) – Latitude variable name.

  • src_dataset (Dataset) – Source NetCDF dataset.

Returns:

Masked variable values.

Return type:

np.ma.array

Raises:
  • ValueError – If neither mask_shp nor mask_region is provided.

  • ImportError – If regionmask is not available.