Константы модуля 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 используется во внутренней работе для ускорения вычислений, когда маска не требуется.

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`	Возвращает итератор по плоскому массиву, или устанавливает плоскую версию self в значение.
`MaskedArray.__array_priority__`

Методы MaskedArray

См. также

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

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

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

Обработка формы

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

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

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

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

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

Сериализация и копирование

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

Вычисления

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

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

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

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

Логическое значение массива (`bool`):

MaskedArray.__bool__(self, /)

self != 0

Арифметика:

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

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

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

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

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

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

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

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

Основные настройки:

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

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

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

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

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

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

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

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

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

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

MaskedArray.count(self[, axis, keepdims])

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

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

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

Класс MaskedArray

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

Примеры

Методы MaskedArray

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

Обработка формы

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

Сериализация и копирование

Вычисления

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

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

Логическое значение массива (bool):

Арифметика:

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

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

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

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

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

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

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

Логическое значение массива (`bool`):