finam.data.to_compressed#

finam.data.to_compressed(xdata, order='C', mask=None)[source]#

Return all the non-masked data as a 1-D array respecting the given array order.

Parameters:

data (pint.Quantity or numpy.ndarray or numpy.ma.MaskedArray) – The reference object input.
order (str) – order argument for numpy.ravel
mask (Mask value or valid boolean mask for Masked arrays, optional) – mask to use when data is not masked already

Returns:

New object with the flat shape and only unmasked data but and same type as input. Units will be taken from the input if present.

Return type:

pint.Quantity or numpy.ndarray or numpy.ma.MaskedArray