pandas.DataFrame.mask

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

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

Параметры:

cond : boolean NDFrame, array-like, or callable Где cond ложно, сохраняется исходное значение. Где истинно, заменяется соответствующим значением из other. Если cond является вызываемым объектом, то он вычисляется для NDFrame и должен возвращать булевый NDFrame или массив. Вызываемый объект не должен изменять входной NDFrame (хотя pandas этого не проверяет). Новое в версии 0.18.1: В качестве cond может использоваться вызываемый объект. other : scalar, NDFrame, or callable Элементы, где cond истинно, заменяются соответствующим значением из other. Если other является вызываемым объектом, то он вычисляется для NDFrame и должен возвращать скаляр или NDFrame. Вызываемый объект не должен изменять входной NDFrame (хотя pandas этого не проверяет). Новое в версии 0.18.1: В качестве other может использоваться вызываемый объект. inplace : boolean, default False Выполнять ли операцию in-place над данными. axis : int, default None Ось выравнивания, если необходимо. level : int, default None Уровень выравнивания, если необходимо. errors : str, {‘raise’, ‘ignore’}, default raise Обратите внимание, что в настоящее время этот параметр не повлияет на результаты и всегда будет приведён к подходящему типу данных. raise : разрешить исключения. ignore : подавить исключения. При ошибке вернуть исходный объект. try_cast : boolean, default False Попытка привести результат обратно к типу входных данных (если возможно). raise_on_error : boolean, default True Вызывать ли исключение при неверном типе данных (например, при попытке применения where к строкам). Устарело начиная с версии 0.21.0: Используйте errors.

Возвращает:

wh : same type as caller

См. также

DataFrame.where()

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

Примечания

Метод mask реализует условное выражение. Для каждого элемента вызываемого DataFrame, если cond равно False, используется этот элемент; в противном случае используется соответствующий элемент из DataFrame other.

Подпись для 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.where(s > 1, 10)
0    10
1    10
2    2
3    3
4    4
dtype: int64

>>> df = pd.DataFrame(np.arange(10).reshape(-1, 2), columns=['A', 'B'])
>>> 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