pandas.DataFrame.mask

DataFrame.mask(cond, other=nan, inplace=False, axis=None, level=None, errors='raise', try_cast=_NoDefault.no_default)[source]

Замена значений, где условие истинно.

Параметры

cond:bool Series/DataFrame, массив-подобный объект или вызываемая функция

Где cond ложно, сохраняется исходное значение. Где истинно, заменяется соответствующим значением из other. Если cond является вызываемой функцией, она вычисляется для Series/DataFrame и должна возвращать булеву Series/DataFrame или массив. Вызываемая функция не должна изменять входные Series/DataFrame (хотя pandas этого не проверяет).

other:скаляр, Series/DataFrame или вызываемая функция

Элементы, где cond истинно, заменяются соответствующим значением из other. Если other является вызываемой функцией, она вычисляется для Series/DataFrame и должна возвращать скаляр или Series/DataFrame. Вызываемая функция не должна изменять входные Series/DataFrame (хотя pandas этого не проверяет).

inplace:bool, по умолчанию False

Выполнять ли операцию непосредственно над данными.

axis:int, по умолчанию None

Ось выравнивания при необходимости. Для Series этот параметр не используется и по умолчанию равен 0.

level:int, по умолчанию None

Уровень выравнивания при необходимости.

errors:str, {‘raise’, ‘ignore’}, по умолчанию ‘raise’

Обратите внимание, что в настоящее время этот параметр не повлияет на результаты и всегда будет приводиться к подходящему типу данных.

• ‘raise’ : разрешить исключения.

• ‘ignore’ : подавить исключения. В случае ошибки вернуть исходный объект.

Устарело начиная с версии 1.5.0: Этот аргумент не имел эффекта.

try_cast:bool, по умолчанию None

Попытаться привести результат обратно к исходному типу (если это возможно).

Устарело начиная с версии 1.3.0: Вручную привести к исходному типу при необходимости.

Возвращает

Тип такой же, как у вызываемого объекта, или None, если inplace=True.

См. также

DataFrame.where()

Возвращает объект такой же формы, как self.

Примечания

Метод mask — это применение конструкции if-then. Для каждого элемента вызываемого DataFrame, если cond является False, используется этот элемент; в противном случае используется соответствующий элемент из DataFrame other. Если ось other не совпадает с осью cond Series/DataFrame, несовпадающие позиции индексов будут заполнены True.

Подпись для DataFrame.where() отличается от numpy.where(). Примерно df1.where(m, df2) эквивалентно np.where(m, df1, df2).

Для получения более подробной информации и примеров см. документацию mask в индексировании.

Тип объекта имеет приоритет. Значение заполнения приводится к типу объекта, если это можно сделать без потерь.

Примеры

>>> s = pd.Series(range(5))
>>> s.where(s > 0)
0    NaN
1    1.0
2    2.0
3    3.0
4    4.0
dtype: float64
>>> s.mask(s > 0)
0    0.0
1    NaN
2    NaN
3    NaN
4    NaN
dtype: float64

>>> s = pd.Series(range(5))
>>> t = pd.Series([True, False])
>>> s.where(t, 99)
0     0
1    99
2    99
3    99
4    99
dtype: int64
>>> s.mask(t, 99)
0    99
1     1
2    99
3    99
4    99
dtype: int64

>>> s.where(s > 1, 10)
0    10
1    10
2    2
3    3
4    4
dtype: int64
>>> s.mask(s > 1, 10)
0     0
1     1
2    10
3    10
4    10
dtype: int64

>>> df = pd.DataFrame(np.arange(10).reshape(-1, 2), columns=['A', 'B'])
>>> df
   A  B
0  0  1
1  2  3
2  4  5
3  6  7
4  8  9
>>> m = df % 3 == 0
>>> df.where(m, -df)
   A  B
0  0 -1
1 -2  3
2 -4 -5
3  6 -7
4 -8  9
>>> df.where(m, -df) == np.where(m, df, -df)
      A     B
0  True  True
1  True  True
2  True  True
3  True  True
4  True  True
>>> df.where(m, -df) == df.mask(~m, -df)
      A     B
0  True  True
1  True  True
2  True  True
3  True  True
4  True  True