cf.AncillaryVariables.mask_invalid

AncillaryVariables.mask_invalid(i=False)[source]

Mask the data array of each field where invalid values occur (NaNs or infs).

Note that:

  • Invalid values in the results of arithmetic operations may only occur if the raising of FloatingPointError exceptions has been suppressed by cf.Data.seterr.
  • If the raising of FloatingPointError exceptions has been allowed then invalid values in the results of arithmetic operations may be automatically converted to masked values, depending on the setting of cf.Data.mask_fpe. In this case, such automatic conversion might be faster than calling mask_invalid.
Parameters :
i : bool, optional

If True then update the field list and its fields in place. By default a new field list containing new fields is created.

Returns :

out : cf.FieldList

Examples

Previous topic

cf.AncillaryVariables.iter

Next topic

cf.AncillaryVariables.match

This Page