sisppeo.products.mask_product¶
- sisppeo.products.mask_product(l3_algo, l3_masks, lst_mask_type, inplace=False)[source]¶
Masks an L3AlgoProduct.
Masks an L3AlgoProduct with one or more L3MaskProducts. It can be used for instance to get rid of clouds or to extract only water areas.
- Parameters
l3_algo – The L3AlgoProduct to be masked.
l3_masks – The mask or list of masks to use.
lst_mask_type – The type of the input mask (or the list of the types of input masks). Can either be ‘IN’ or ‘OUT’, indicating if the corresponding mask is inclusive or exclusive.
inplace – If True, do operation inplace and return None.
- Returns
A masked L3AlgoProduct.