pandas.DataFrame.mask

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

Возвращает объект той же формы, что и self, элементы которого взяты из self, если cond ложно, и иначе из other.

Параметры:

cond : булево NDFrame, массив или вызываемый объект Если cond — вызываемый объект, он вычисляется для NDFrame и должен возвращать булево NDFrame или массив. Вызываемый объект не должен изменять входной NDFrame (хотя pandas этого не проверяет). Введено в версии 0.18.1. В качестве cond может использоваться вызываемый объект. other : скаляр, NDFrame или вызываемый объект Если other — вызываемый объект, он вычисляется для NDFrame и должен возвращать скаляр или NDFrame. Вызываемый объект не должен изменять входной NDFrame (хотя pandas этого не проверяет). Введено в версии 0.18.1. В качестве other может использоваться вызываемый объект. inplace : boolean, по умолчанию False Выполнять ли операцию на данных in place? axis : ось выравнивания, если необходимо, по умолчанию None level : уровень выравнивания, если необходимо, по умолчанию None try_cast : boolean, по умолчанию False попытаться привести результат к типу входных данных (если возможно), raise_on_error : boolean, по умолчанию True Вызывать ли ошибку при недопустимых типах данных (например, при попытке where на строках)

Возвращаемое значение:

wh : тот же тип, что и вызываемый объект

См. также

DataFrame.where()

Примечания

Метод 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

>>> 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