Константы модуля numpy.ma

Помимо класса MaskedArray, модуль numpy.ma определяет несколько констант.

numpy.ma.masked

Константа masked является особым случаем MaskedArray с типом данных float и нулевой формой. Она используется для проверки, замаскирован ли конкретный элемент массива, или для маскирования одного или нескольких элементов массива:

>>> x = ma.array([1, 2, 3], mask=[0, 1, 0])
>>> x[1] is ma.masked
True
>>> x[-1] = ma.masked
>>> x
masked_array(data=[1, --, --],
             mask=[False,  True,  True],
       fill_value=999999)

numpy.ma.nomask: Значение, указывающее, что в массиве нет недопустимых элементов. nomask используется внутри для ускорения вычислений, когда маска не нужна. Внутри она представлена как np.False_.

numpy.ma.masked_print_options: Строка, используемая вместо отсутствующих данных при выводе массива. По умолчанию эта строка равна '--'.

Класс MaskedArray

class numpy.ma.MaskedArray[source]

Подкласс ndarray, предназначенный для работы с числовыми массивами, содержащими пропущенные данные.

Экземпляр MaskedArray можно рассматривать как комбинацию нескольких элементов:

Данные data, как обычный numpy.ndarray любой формы или типа данных (сами данные).
Булева маска mask той же формы, что и данные, где значение True указывает, что соответствующий элемент данных недействителен. Специальное значение nomask также приемлемо для массивов без именованных полей и указывает, что данные не являются недействительными.
Значение заполнения fill_value, значение, которое может быть использовано для замены недействительных записей, чтобы получить стандартный numpy.ndarray.

Атрибуты и свойства массив

См. также

Атрибуты массива

MaskedArray.data

Возвращает основанные данные как вид массива.

Если базовые данные являются подклассом numpy.ndarray, они возвращаются как таковые.

>>> x = np.ma.array(np.matrix([[1, 2], [3, 4]]), mask=[[0, 1], [1, 0]])
>>> x.data
matrix([[1, 2],
        [3, 4]])

Тип данных можно получить через атрибут baseclass.

MaskedArray.mask: Текущая маска.

MaskedArray.recordmask

Получение или установка маски массива, если у него нет именованных полей. Для структурированных массивов возвращает массив булевых значений, где элементы имеют значение True , если **все** поля замаскированы, False в противном случае:

>>> x = np.ma.array([(1, 1), (2, 2), (3, 3), (4, 4), (5, 5)],
...         mask=[(0, 0), (1, 0), (1, 1), (0, 1), (0, 0)],
...        dtype=[('a', int), ('b', int)])
>>> x.recordmask
array([False, False,  True, False, False])

MaskedArray.fill_value

Значение заполнения массива — скаляр. При установке None будет установлено по умолчанию в зависимости от типа данных.

Примеры

>>> for dt in [np.int32, np.int64, np.float64, np.complex128]:
...     np.ma.array([0, 1], dtype=dt).get_fill_value()
...
999999
999999
1e+20
(1e+20+0j)

>>> x = np.ma.array([0, 1.], fill_value=-np.inf)
>>> x.fill_value
-inf
>>> x.fill_value = np.pi
>>> x.fill_value
3.1415926535897931 # may vary

Сброс к значению по умолчанию:

>>> x.fill_value = None
>>> x.fill_value
1e+20

MaskedArray.baseclass: Класс базовых данных (только чтение).

MaskedArray.sharedmask: Статус совместного использования маски (только чтение).

MaskedArray.hardmask: Жесткость маски

Так как MaskedArray является подклассом ndarray, массив также наследует все атрибуты и свойства экземпляра ndarray.

`MaskedArray.base`	Базовый объект, если память взята из другого объекта.
`MaskedArray.ctypes`	Объект для упрощения взаимодействия массива с модулем ctypes.
`MaskedArray.dtype`	Тип данных элементов массива.
`MaskedArray.flags`	Информация о структуре памяти массива.
`MaskedArray.itemsize`	Длина одного элемента массива в байтах.
`MaskedArray.nbytes`	Общее количество байтов, занимаемых элементами массива.
`MaskedArray.ndim`	Количество измерений массива.
`MaskedArray.shape`	Кортеж измерений массива.
`MaskedArray.size`	Количество элементов в массиве.
`MaskedArray.strides`	Кортеж байтов, которые нужно пропустить в каждом измерении при проходе по массиву.
`MaskedArray.imag`	Мнимая часть массива.
`MaskedArray.real`	Действительная часть массива.
`MaskedArray.flat`	Возвращает итератор, или устанавливает сглаженный массив.
`MaskedArray.__array_priority__`

Методы MaskedArray

См. также

Методы массива

Преобразование

`MaskedArray.__float__`()	Преобразовать в число с плавающей точкой.
`MaskedArray.__int__`()	Преобразовать в целое число.
`MaskedArray.view`([dtype, type, fill_value])	Возвращает представление данных MaskedArray.
`MaskedArray.astype`(dtype[, order, casting, …])	Копия массива, преобразованного к указанному типу.
`MaskedArray.byteswap`([inplace])	Поменять байты элементов массива
`MaskedArray.compressed`()	Возвращает все немаскированные данные в виде одномерного массива.
`MaskedArray.filled`([fill_value])	Возвращает копию self, с замаскированными значениями, заполненными заданным значением.
`MaskedArray.tofile`(fid[, sep, format])	Сохранить маскированный массив в двоичном формате в файл.
`MaskedArray.toflex`()	Преобразует маскированный массив в массив гибкого типа.
`MaskedArray.tolist`([fill_value])	Возвращает часть данных маскированного массива в виде иерархического списка Python.
`MaskedArray.torecords`()	Преобразует маскированный массив в массив гибкого типа.
`MaskedArray.tostring`([fill_value, order])	Псевдоним совместимости для `tobytes`, с абсолютно таким же поведением.
`MaskedArray.tobytes`([fill_value, order])	Возвращает данные массива в виде строки, содержащей сырые байты в массиве.

Изменение формы массива

Для reshape, resize и transpose одиночный кортеж аргументов может быть заменён n целыми числами, которые будут интерпретированы как n-кортеж.

`MaskedArray.flatten`([order])	Возвращает копию массива, сжатого в одну размерность.
`MaskedArray.ravel`([order])	Возвращает одномерную версию self, как представление.
`MaskedArray.reshape`(s, *kwargs)	Дать новый вид массиву, не меняя его данные.
`MaskedArray.resize`(newshape[, refcheck, order])
`MaskedArray.squeeze`([axis])	Удалить оси длины один из `a`.
`MaskedArray.swapaxes`(axis1, axis2)	Возвращает представление массива с осями `axis1` и `axis2` поменявшими местами.
`MaskedArray.transpose`(*axes)	Возвращает представление массива с переставленными осями.
`MaskedArray.T`	Массив, транспонированный.

Выбор и преобразование элементов

Для методов массива, принимающих axis ключевое слово, оно по умолчанию равно None. Если ось равна None, то массив обрабатывается как одномерный. Любое другое значение для axis обозначает размерность, по которой должно выполняться операция.

`MaskedArray.argmax`([axis, fill_value, out])	Возвращает массив индексов максимальных значений по заданной оси.
`MaskedArray.argmin`([axis, fill_value, out])	Возвращает массив индексов минимальных значений по заданной оси.
`MaskedArray.argsort`([axis, kind, order, …])	Возвращает массив индексов, которые сортируют массив по указанной оси.
`MaskedArray.choose`(choices[, out, mode])	Использует массив индексов для построения нового массива из набора вариантов.
`MaskedArray.compress`(condition[, axis, out])	Возвращает `a` где условие `True`.
`MaskedArray.diagonal`([offset, axis1, axis2])	Возвращает заданные диагонали.
`MaskedArray.fill`(value)	Заполняет массив скалярным значением.
`MaskedArray.item`(*args)	Копирует элемент массива в стандартный скаляр Python и возвращает его.
`MaskedArray.nonzero`()	Возвращает индексы незамаскированных элементов, которые не равны нулю.
`MaskedArray.put`(indices, values[, mode])	Устанавливает значения по указанным индексам.
`MaskedArray.repeat`(repeats[, axis])	Повторяет элементы массива.
`MaskedArray.searchsorted`(v[, side, sorter])	Находит индексы, куда элементы v должны быть вставлены, чтобы сохранить порядок.
`MaskedArray.sort`([axis, kind, order, …])	Сортирует массив на месте
`MaskedArray.take`(indices[, axis, out, mode])

Запись в файл и копирование

`MaskedArray.copy`([order])	Возвращает копию массива.
`MaskedArray.dump`(file)	Записывает пикл массива в указанный файл.
`MaskedArray.dumps`()	Возвращает пикл массива в виде строки.

Вычисления

`MaskedArray.all`([axis, out, keepdims])	Возвращает True, если все элементы равны True.
`MaskedArray.anom`([axis, dtype])	Вычисляет аномалии (отклонения от арифметического среднего) по заданной оси.
`MaskedArray.any`([axis, out, keepdims])	Возвращает True, если любой из элементов `a` равен True.
`MaskedArray.clip`([min, max, out])	Возвращает массив, значения которого ограничены `[min, max]`.
`MaskedArray.conj`()	Вычисляет комплексно-сопряжённые значения всех элементов.
`MaskedArray.conjugate`()	Возвращает комплексно-сопряжённые значения элементов.
`MaskedArray.cumprod`([axis, dtype, out])	Возвращает кумулятивное произведение элементов массива по заданной оси.
`MaskedArray.cumsum`([axis, dtype, out])	Возвращает кумулятивную сумму элементов массива по заданной оси.
`MaskedArray.max`([axis, out, fill_value, …])	Возвращает максимальное значение по заданной оси.
`MaskedArray.mean`([axis, dtype, out, keepdims])	Возвращает среднее значение элементов массива по заданной оси.
`MaskedArray.min`([axis, out, fill_value, …])	Возвращает минимальное значение по заданной оси.
`MaskedArray.prod`([axis, dtype, out, keepdims])	Возвращает произведение элементов массива по заданной оси.
`MaskedArray.product`([axis, dtype, out, keepdims])	Возвращает произведение элементов массива по заданной оси.
`MaskedArray.ptp`([axis, out, fill_value, …])	Возвращает (максимум - минимум) по заданному измерению (т.е.
`MaskedArray.round`([decimals, out])	Возвращает каждый элемент, округлённый до заданного числа десятичных знаков.
`MaskedArray.std`([axis, dtype, out, ddof, …])	Возвращает стандартное отклонение элементов массива по заданной оси.
`MaskedArray.sum`([axis, dtype, out, keepdims])	Возвращает сумму элементов массива по заданной оси.
`MaskedArray.trace`([offset, axis1, axis2, …])	Возвращает сумму по диагоналям массива.
`MaskedArray.var`([axis, dtype, out, ddof, …])	Вычисляет дисперсию по указанной оси.

Арифметические и сравнительные операции

Операторы сравнения:

`MaskedArray.__lt__`(value, /)	Возвращает self<value.
`MaskedArray.__le__`(value, /)	Возвращает self<=value.
`MaskedArray.__gt__`(value, /)	Возвращает self>value.
`MaskedArray.__ge__`(value, /)	Возвращает self>=value.
`MaskedArray.__eq__`(other)	Проверяет, равны ли элементы other и self.
`MaskedArray.__ne__`(other)	Проверяет, не равны ли элементы other и self.

Булево значение массива (`bool()`):

MaskedArray.__bool__(/)

self != 0

Арифметика:

`MaskedArray.__abs__`(self)
`MaskedArray.__add__`(other)	Добавить self к other и вернуть новую маску.
`MaskedArray.__radd__`(other)	Добавить other к self и вернуть новую маску.
`MaskedArray.__sub__`(other)	Вычесть other из self и вернуть новую маску.
`MaskedArray.__rsub__`(other)	Вычесть self из other и вернуть новую маску.
`MaskedArray.__mul__`(other)	Перемножить self на other и вернуть новую маску.
`MaskedArray.__rmul__`(other)	Перемножить other на self и вернуть новую маску.
`MaskedArray.__div__`(other)	Разделить self на other и вернуть новую маску.
`MaskedArray.__truediv__`(other)	Разделить self на other и вернуть новую маску.
`MaskedArray.__rtruediv__`(other)	Разделить other на self и вернуть новую маску.
`MaskedArray.__floordiv__`(other)	Целочисленное деление other на self и возврат новой маски.
`MaskedArray.__rfloordiv__`(other)	Целочисленное деление self на other и возврат новой маски.
`MaskedArray.__mod__`(value, /)	Возвращает остаток от деления self на value.
`MaskedArray.__rmod__`(value, /)	Возвращает остаток от деления value на self.
`MaskedArray.__divmod__`(value, /)	Возвращает результат функции divmod(self, value).
`MaskedArray.__rdivmod__`(value, /)	Возвращает результат функции divmod(value, self).
`MaskedArray.__pow__`(other)	Возводит self в степень other, маскируя потенциальные NaN/Inf.
`MaskedArray.__rpow__`(other)	Возводит other в степень self, маскируя потенциальные NaN/Inf.
`MaskedArray.__lshift__`(value, /)	Возвращает результат self << value.
`MaskedArray.__rlshift__`(value, /)	Возвращает результат value << self.
`MaskedArray.__rshift__`(value, /)	Возвращает результат self >> value.
`MaskedArray.__rrshift__`(value, /)	Возвращает результат value >> self.
`MaskedArray.__and__`(value, /)	Возвращает результат self & value.
`MaskedArray.__rand__`(value, /)	Возвращает результат value & self.
`MaskedArray.__or__`(value, /)	Возвращает результат self \| value.
`MaskedArray.__ror__`(value, /)	Возвращает результат value \| self.
`MaskedArray.__xor__`(value, /)	Возвращает результат self ^ value.
`MaskedArray.__rxor__`(value, /)	Возвращает результат value ^ self.

Арифметические операции на месте:

`MaskedArray.__iadd__`(other)	Добавление other к self на месте.
`MaskedArray.__isub__`(other)	Вычитание other из self на месте.
`MaskedArray.__imul__`(other)	Умножение self на other на месте.
`MaskedArray.__idiv__`(other)	Деление self на other на месте.
`MaskedArray.__itruediv__`(other)	Деление self на other на месте (с плавающей точкой).
`MaskedArray.__ifloordiv__`(other)	Целочисленное деление self на other на месте.
`MaskedArray.__imod__`(value, /)	Возвращает self %= value.
`MaskedArray.__ipow__`(other)	Возведение self в степень other на месте.
`MaskedArray.__ilshift__`(value, /)	Возвращает self <<= value.
`MaskedArray.__irshift__`(value, /)	Возвращает self >>= value.
`MaskedArray.__iand__`(value, /)	Возвращает self &= value.
`MaskedArray.__ior__`(value, /)	Возвращает self \|= value.
`MaskedArray.__ixor__`(value, /)	Возвращает self ^= value.

Представление

`MaskedArray.__repr__`()	Строковое представление.
`MaskedArray.__str__`()	Возвращает str(self).
`MaskedArray.ids`()	Возвращает адреса областей данных и маски.
`MaskedArray.iscontiguous`()	Возвращает булево значение, указывающее, являются ли данные непрерывными.

Специальные методы

Для стандартных функций библиотеки:

`MaskedArray.__copy__`()	Используется, если для массива вызывается `copy.copy`.
`MaskedArray.__deepcopy__`(memo, /)	Используется, если для массива вызывается `copy.deepcopy`.
`MaskedArray.__getstate__`()	Возвращает внутреннее состояние маскированного массива для целей сериализации.
`MaskedArray.__reduce__`()	Возвращает тройку кортежей для сериализации MaskedArray.
`MaskedArray.__setstate__`(state)	Восстанавливает внутреннее состояние маскированного массива для целей сериализации.

Базовая настройка:

`MaskedArray.__new__`(cls[, data, mask, …])	Создаёт новый маскированный массив с нуля.
`MaskedArray.__array__`([dtype], /)	Возвращает новую ссылку на self, если dtype не задан, или новый массив указанного типа данных, если dtype отличается от текущего типа данных массива.
`MaskedArray.__array_wrap__`(obj[, context])	Специальный обработчик для функций ufuncs.

Настройка контейнера: (см. Индексирование)

`MaskedArray.__len__`(/)	Возвращает len(self).
`MaskedArray.__getitem__`(indx)	x.__getitem__(y) <==> x[y]
`MaskedArray.__setitem__`(indx, value)	x.__setitem__(i, y) <==> x[i]=y
`MaskedArray.__delitem__`(key, /)	Удалить self[key].
`MaskedArray.__contains__`(key, /)	Возвращает key in self.

Конкретные методы

Обработка маски

Следующие методы могут быть использованы для доступа к информации о маске или для манипулирования маской.

`MaskedArray.__setmask__`(mask[, copy])	Устанавливает маску.
`MaskedArray.harden_mask`()	Принудительно устанавливает маску как жёсткую.
`MaskedArray.soften_mask`()	Принудительно устанавливает маску как мягкую.
`MaskedArray.unshare_mask`()	Копирует маску и устанавливает флаг sharedmask в значение False.
`MaskedArray.shrink_mask`()	Уменьшает маску до nomask, когда это возможно.

Обработка значения заполнения

`MaskedArray.get_fill_value`()	Значение заполнения маскированного массива — это скаляр.
`MaskedArray.set_fill_value`([value])

Подсчёт пропущенных элементов

MaskedArray.count([axis, keepdims])

Подсчитывает не-маскированные элементы массива вдоль заданной оси.

© 2005–2022 NumPy Developers
Licensed under the 3-clause BSD License.
https://numpy.org/doc/1.21/reference/maskedarray.baseclass.html

Константы модуля numpy.ma

Класс MaskedArray

Атрибуты и свойства массив

Примеры

Методы MaskedArray

Преобразование

Изменение формы массива

Выбор и преобразование элементов

Запись в файл и копирование

Вычисления

Арифметические и сравнительные операции

Операторы сравнения:

Булево значение массива (bool()):

Арифметика:

Арифметические операции на месте:

Представление

Специальные методы

Конкретные методы

Обработка маски

Обработка значения заполнения

Подсчёт пропущенных элементов

Булево значение массива (`bool()`):