healpy.pixelfunc.isnsideok

Contents

healpy.pixelfunc.isnsideok#

healpy.pixelfunc.isnsideok(nside, nest=False)#

Returns True if nside is a valid nside parameter, False otherwise.

NSIDE needs to be a power of 2 only for nested ordering

Parameters:
nsideint, scalar or array-like

integer value to be tested

nestbool, optional

if True, check if nside is valid for NESTED scheme (must be power of 2). If False (default), RING scheme allows non-power-of-2 nside values.

Returns:
okbool, scalar or array-like

True if given value is a valid nside, False otherwise.

Examples

>>> import healpy as hp
>>> hp.isnsideok(13, nest=True)
False

>>> hp.isnsideok(13, nest=False)
True

>>> hp.isnsideok(32)
True

>>> hp.isnsideok([1, 2, 3, 4, 8, 16], nest=True)
array([ True,  True, False,  True,  True,  True], dtype=bool)
Contents