pandas.DataFrame.mask

DataFrame.mask(cond, other=_NoDefault.no_default, *, inplace=False, axis=None, level=None)[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 этого не проверяет). Если не указано, элементы будут заполнены соответствующим NULL-значением (np.nan для типов данных numpy, pd.NA для типов данных расширений).

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

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

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

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

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

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

Возвращает:

Тип такой же, как у вызывающего объекта, или 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