pandas.DataFrame.mask

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

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

Параметры:

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

Возвращает:

Тип, совпадающий с вызывающим объектом

См. также

DataFrame.where()

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

Примечания

Метод mask — это применение конструкции if-then. Для каждого элемента в вызываемом 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'])
>>> 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