bundles / numpy 2.4.3 / numpy / ma / core / is_masked

function

`numpy.ma.core:is_masked`

source: /numpy/ma/core.py :6862

Signature

def is_masked ( x )

Summary

Determine whether input has masked values.

Extended Summary

Accepts any object as input, but always returns False unless the input is a MaskedArray containing masked values.

Parameters

x : array_like: Array to check for masked values.

Returns

result : bool: True if x is a MaskedArray with masked values, False otherwise.

Examples

import numpy as np
import numpy.ma as ma
x = ma.masked_equal([0, 1, 0, 2, 3], 0)
x
ma.is_masked(x)
x = ma.masked_equal([0, 1, 0, 2, 3], 42)
x
ma.is_masked(x)

Always returns False if `x` isn't a MaskedArray.

x = [False, True, False]
ma.is_masked(x)
x = 'a string'
ma.is_masked(x)

Aliases

numpy.ma.is_masked