cf.Field.domain_mask

Field.domain_mask(**kwargs)

Return a boolean field that is True where criteria are met.

New in version 1.1.

See also

indices, mask, subspace

Parameters

kwargs: optional

A dictionary of keyword arguments to pass to the indices method to define the criteria to meet for a element to be set as True.

Returns

Field

The domain mask.

Examples

Create a domain mask which is masked at all between between -30 and 30 degrees of latitude:

>>> m = f.domain_mask(latitude=cf.wi(-30, 30))