https://github.com/samapriya/cloud-utils
Cloud utils for Planet UDM-2
https://github.com/samapriya/cloud-utils
Last synced: 2 months ago
JSON representation
Cloud utils for Planet UDM-2
- Host: GitHub
- URL: https://github.com/samapriya/cloud-utils
- Owner: samapriya
- License: apache-2.0
- Created: 2020-05-05T01:06:17.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-10T08:17:50.000Z (about 5 years ago)
- Last Synced: 2025-03-28T13:46:32.326Z (2 months ago)
- Homepage: https://samapriya.github.io/cloud-utils/
- Size: 42 MB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## **[cloud-utils: Cloud Utility for Planet's UMD-2](https://samapriya.github.io/cloud-utils/)**
[](https://doi.org/10.5281/zenodo.3813171)
[](https://opensource.org/licenses/Apache-2.0)
#### [Go to always updated docs here](https://samapriya.github.io/cloud-utils/)
**Please note: This tool is in no way an official tool or Planet offering, but is a personal project created and maintained by Samapriya Roy**
Cloud utils are tools to work with [Planet's UDM-2 dataset](https://developers.planet.com/docs/data/udm-2/). The Usable Data Mask v2 are an 8 bit 8 band image with the following bands. These tools are designed as modules that can be imported directly into any Google Earth Engine script and can then be used in a plug and play manner.
| Band | Description | Pixel Value Range | Interpretation |
|--------|-----------------|-------------------|----------------------------------------------------------------------------------------|
| Band 1 | Clear map | [0, 1] | 0: not clear, 1: clear |
| Band 2 | Snow map | [0, 1] | 0: no snow or ice, 1: snow or ice |
| Band 3 | Shadow map | [0, 1] | 0: no shadow, 1: shadow |
| Band 4 | Light haze map | [0, 1] | 0: no light haze, 1: light haze |
| Band 5 | Heavy haze map | [0, 1] | 0: no heavy haze, 1: heavy haze |
| Band 6 | Cloud map | [0, 1] | 0: no cloud, 1: cloud |
| Band 7 | Confidence map | [0-100] | percentage value: per-pixel algorithmic confidence in classification |
| Band 8 | Unusable pixels | -- | Equivalent to the UDM asset: see Planet's Imagery Specification for complete details |
| | | | | |
UDM-2 classification stems from a supervised machine learning technique and is designed to seperate the the above classes. Things to note:
* All classes are mutually exclusive meaning you can be either of the classes in Band-1 to Band -6
* The clases (Band-1 to Band-6) are binary as mentioned in the band list.
* The Confidence map value therefore refers to a single class and has a 1:1 correlation to the underlying imagery.
To read more about the [UDM-2 Classification Methodology you can go here at our Developers Center](https://developers.planet.com/docs/data/udm-2/#udm2-classification-methodology).
Eventually this will allow you to apply cloud masking to PlanetScope Scenes and their related UDM-2 masks to create cloud free composites.
If you use this module, and find this tool useful, star and cite it as below
```
Samapriya Roy. (2020, May 7). samapriya/cloud-utils: cloud-utils: Cloud utils for Planet UDM-2 (Version 0.2). Zenodo.
http://doi.org/10.5281/zenodo.3813171
```