PlanetMaskType#

class PlanetMaskType(value)[source]#

Bases: ListEnum

Planet Mask Type UDM2 > UDM > NONE

NONE = 'None'#

The product has no mask. Only valid for some RapidEye old products

UDM = 'Unusable Data Mask'#

The unusable data mask file provides information on areas of unusable data within an image (e.g. cloud and non-imaged areas). The pixel size after orthorectification will be 3.125 m for PlanetScope OrthoTiles, 3.0m for PlanetScope Scenes, 50m for RapidEye, and 0.8 m for SkySat. It is suggested that when using the file to check for usable data, a buffer of at least 1 pixel should be considered. Each bit in the 8-bit pixel identifies whether the corresponding part of the product contains useful imagery: - Bit 0: Identifies whether the area contains blackfill in all bands (this area was not imaged). A value of “1” indicates blackfill. - Bit 1: Identifies whether the area is cloud covered. A value of “1” indicates cloud coverage. Cloud detection is performed on a decimated version of the image (i.e. the browse image) and hence small clouds may be missed. Cloud areas are those that have pixel values in the assessed band (Red, NIR or Green) that are above a configurable threshold. This algorithm will: - Assess snow as cloud - Assess cloud shadow as cloud free - Assess haze as cloud free - Bit 2: Identifies whether the area contains missing (lost during downlink) or suspect (contains down-link errors) data in band 1. A value of “1” indicates missing/suspect data. If the product does not include this band, the value is set to “0”. - Bit 3: Identifies whether the area contains missing (lost during downlink and hence blackfilled) or suspect (contains downlink errors) data in the band 2. A value of “1” indicates missing/suspect data. If the product does not include this band, the value is set to “0”. - Bit 4: Identifies whether the area contains missing (lost during downlink) or suspect (contains downlink errors) data in the band 3. A value of “1” indicates missing/suspect data. If the product does not include this band, the value is set to “0”. - Bit 5: Identifies whether the area contains missing (lost during downlink) or suspect (contains downlink errors) data in band 4. A value of “1” indicates missing/suspect data. If the product does not include this band, the value is set to “0”. - Bit 6: Identifies whether the area contains missing (lost during downlink) or suspect (contains downlink errors) data in band 5. A value of “1” indicates missing/suspect data. If the product does not include this band, the value is set to “0”. - Bit 7: Is currently set to “0”.

The UDM information is found in band 8 of the Usable Data Mask file.

UDM2 = 'Usable Data Mask'#

The usable data mask file provides information on areas of usable data within an image (e.g. clear, snow, shadow, light haze, heavy haze and cloud). The pixel size after orthorectification will be 3.125 m for PlanetScope OrthoTiles and 3.0m for PlanetScope Scenes. The usable data mask is a raster image having the same dimensions as the image product, comprised of 8 bands, where each band represents a specific usability class mask. The usability masks are mutually exclusive, and a value of one indicates that the pixel is assigned to that usability class. - Band 1: clear mask (a value of “1” indicates the pixel is clear, a value of “0” indicates that the pixel is not clear and is one of the 5 remaining classes below) - Band 2: snow mask - Band 3: shadow mask - Band 4: light haze mask - Band 5: heavy haze mask - Band 6: cloud mask - Band 7: confidence map (a value of “0” indicates a low confidence in the assigned classification, a value of “100” indicates a high confidence in the assigned classification) - Band 8: unusable data mask