is_mask

Contents

is_mask#

is_mask(mask: str | SpectralBandNames | SarBandNames | CloudsBandNames | DemBandNames | BandNames) → bool[source]#

Returns True if is a Mask band (from MaskBandNames)

Parameters:

mask (BandType) – Anything that could be a Mask band

Returns:

True if the band asked is a Mask band

Return type:

bool

Examples

>>> from eoreader.bands import NDVI, HH, GREEN, SLOPE, CLOUDS, CLDPRB
>>>
>>> is_mask(NDVI)
False
>>> is_mask(HH)
False
>>> is_mask(GREEN)
False
>>> is_mask(SLOPE)
False
>>> is_mask(CLOUDS)
False
>>> is_mask(CLDPRB)
True
Contents