geedim.collection.MaskedCollection.search
- MaskedCollection.search(start_date: datetime | str = None, end_date: datetime | str = None, region: Dict = None, fill_portion: float = None, cloudless_portion: float = None, custom_filter: str = None, **kwargs) MaskedCollection
Search for images based on date, region, filled/cloudless portion, and custom criteria.
Filled and cloudless portions are only calculated and included in collection properties when one or both of
fill_portion
/cloudless_portion
are specified.Search speed can be increased by specifying
custom_filter
, and or by omittingfill_portion
/cloudless_portion
.- Parameters:
start_date (datetime, str) – Start date (UTC). In ‘%Y-%m-%d’ format if a string.
end_date (datetime, str, optional) – End date (UTC). In ‘%Y-%m-%d’ format if a string. If None,
end_date
is set to a day afterstart_date
.region (dict, ee.Geometry) – Polygon in WGS84 specifying a region that images should intersect.
fill_portion (float, optional) – Lower limit on the portion of region that contains filled/valid image pixels (%).
cloudless_portion (float, optional) – Lower limit on the portion of filled pixels that are cloud/shadow free (%).
custom_filter (str, optional) – Custom image property filter expression e.g. “property > value”. See the EE docs.
**kwargs – Optional cloud/shadow masking parameters - see
geedim.mask.MaskedImage.__init__()
for details.
- Returns:
Filtered MaskedCollection instance containing the search result image(s).
- Return type: