Add new 'cloud_mask' param to load_ard
#1000
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed changes
A recent client enquiry revealed a limitation of the current
load_ard
implementation of multiple cloud masks: at the moment the choice of whether to use Fmask or s2cloudless is tied to the same param (mask_pixel_quality
) that decides whether to actually mask out cloudy pixels as NaN. Users may instead just want to use s2cloudless for filtering to non-cloudy scenes usingmin_gooddata
, without actually applying the mask.This PR separates the choice of cloud mask from the choice of whether to actually mask out clouds as NaN pixels by removing the choice of cloud mask from the
mask_pixel_quality
param, and introducing a newcloud_mask
param that controls the choice of cloud mask. This allows users to e.g. filter to non-cloudy cloudy scenes usingmin_gooddata
+s2cloudless
, but not actually have to apply the cloud mask to their data.Have updated the
Using_load_ard.ipynb
andDEA_Sentinel2_Surface_Reflectance.ipynb
notebooks to update them for this change.