finam.data.to_masked

finam.data.to_masked(data, **kwargs)

Return a masked version of the data.

Parameters:

• data (pint.Quantity or numpy.ndarray or numpy.ma.MaskedArray) – The reference object input.

• **kwargs – keyword arguments forwarded to numpy.ma.array

Returns:

New object with the same shape and type but as a masked array. Units will be taken from the input if present.

Return type:

pint.Quantity or numpy.ma.MaskedArray