strip_unit

Contents

strip_unit#

tollan.utils.np.strip_unit(arr: MaskedArray) tuple[MaskedArray, UnitBase | StructuredUnit | None][source]#
tollan.utils.np.strip_unit(arr: Quantity) tuple[npt.ArrayLike, UnitT | None]

Remove unit from array, returning (data, unit).

Parameters:

arr (ArrayLike | Quantity) – Input array (may have astropy units)

Returns:

Tuple of (data array without units, unit or None)

Return type:

tuple[ArrayLike, UnitT | None]

Examples

>>> import numpy as np
>>> import astropy.units as u
>>> q = np.arange(3) * u.m
>>> arr = np.ma.array(q, mask=[0, 1, 0])
>>> data, unit = strip_unit(arr)
>>> data
masked_array(data=[0, --, 2], mask=[False,  True, False], fill_value=1e+20)
>>> unit
Unit("m")