cf.DomainAncillary.hardmask

DomainAncillary.hardmask

Whether the mask is hard (True) or soft (False).

When the mask is hard, masked elements of the data array can not be unmasked by assignment, but unmasked elements may be still be masked.

When the mask is soft, masked entries of the data array may be unmasked by assignment and unmasked entries may be masked.

By default, the mask is hard.

See also

where, subspace, __setitem__

Examples

>>> f.hardmask = False
>>> f.hardmask
False