healpy.pixelfunc.mask_good

healpy.pixelfunc.mask_good(m, badval=<class 'Mock'>, rtol=1e-05, atol=1e-08)

Returns a bool array with False where m is close to badval.

Parameters :

m : a map (may be a sequence of maps)

badval : float, optional

The value of the pixel considered as bad (UNSEEN by default)

rtol : float, optional

The relative tolerance

atol : float, optional

The absolute tolerance

Returns :

a bool array with the same shape as the input map, ``False`` where input map is :

close to badval, and ``True`` elsewhere. :

See also

mask_bad, ma

Examples

>>> import healpy as hp
>>> m = np.arange(12.)
>>> m[3] = hp.UNSEEN
>>> hp.mask_good(m)
array([ True,  True,  True, False,  True,  True,  True,  True,  True,
        True,  True,  True], dtype=bool)

Project Versions

Previous topic

healpy.pixelfunc.mask_bad

Next topic

healpy.pixelfunc.ma

This Page