sisppeo.products.mask_time_series¶
- sisppeo.products.mask_time_series(ts_algo, ts_masks, lst_mask_type, inplace=False)[source]¶
Masks time series of L3AlgoProducts.
Masks a TimeSeries made of L3AlgoProducts with one (or multiple ones) made of L3MaskProducts. It can be used for instance to get rid of clouds or to extract only water areas.
- Parameters
ts_algo – The TimeSeries to be masked.
ts_masks – The TimeSeries or list of TimeSeries to use as mask (/list of masks).
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 TimeSeries.