Search¶

Back to Scenes

search(aoi, products=None, start_datetime=None, end_datetime=None, cloud_fraction=None, storage_state=None, limit=100, sort_field=None, sort_order='asc', date_field='acquired', query=None, randomize=False, raster_client=None, metadata_client=None)[source]¶

Search for Scenes in the Descartes Labs catalog.

Returns a SceneCollection of Scenes that overlap with an area of interest, and meet the given search criteria.

Parameters:

Parameters:	aoi (GeoJSON-like dict, `GeoContext`, or object with __geo_interface__) – Search for scenes that intersect this area by any amount. If a `GeoContext`, a copy is returned as `ctx`, with missing values filled in. Otherwise, the returned `ctx` will be an `AOI`, with this as its geometry. products (str or List[str], optional) – Descartes Labs product identifiers start_datetime (str, datetime-like, optional) – Restrict to scenes acquired after this datetime end_datetime (str, datetime-like, optional) – Restrict to scenes acquired before this datetime cloud_fraction (float, optional) – Restrict to scenes that are covered in clouds by less than this fraction (between 0 and 1) storage_state (str, optional) – Filter results based on `storage_state` value (`"available"`, `"remote"`, or `None`) limit (int or None, optional, default 100) – Maximum number of Scenes to return, or None for all results. sort_field (str, optional) – Field name in `Scene.properties` by which to order the results sort_order (str, optional, default 'asc') – `"asc"` or `"desc"` date_field (str, optional, default 'acquired') – The field used when filtering by date (`"acquired"`, `"processed"`, `"published"`) query (Expression, optional) – Expression used to filter Scenes by their properties, built from `dl.properties`. You can construct filter expression using the `==`, `!=`, `<`, `>`, `<=` and `>=` operators as well as the `like()` method. You cannot use the boolean keywords `and` and `or` because of Python language limitations; instead you can combine filter expressions with `&` (boolean “and”) and `\|` (boolean “or”). Example: `150 < dl.properties.azimuth_angle < 160 & dl.properties.cloud_fraction < 0.5` randomize (bool, default False, optional) – Randomize the order of the results. You may also use an int or str as an explicit seed. raster_client (Raster, optional) – Unneeded in general use; lets you use a specific client instance with non-default auth and parameters. metadata_client (Metadata, optional) – Unneeded in general use; lets you use a specific client instance with non-default auth and parameters.
Returns:	scenes (`SceneCollection`) – Scenes matching your criteria. ctx (`GeoContext`) – The given `aoi` as a `GeoContext` (if it isn’t one already), with reasonable default parameters for loading all matching Scenes. If `aoi` was a `GeoContext`, `ctx` will be a copy of `aoi`, with any properties that were `None` assigned the defaults below. If `aoi` was not a `GeoContext`, an `AOI` instance will be created with `aoi` as its geometry, and defaults assigned as described below: Default Spatial Parameters: resolution: the finest resolution of any band of all matching scenes crs: the most common CRS used of all matching scenes

aoi (GeoJSON-like dict, GeoContext, or object with __geo_interface__) – Search for scenes that intersect this area by any amount. If a GeoContext, a copy is returned as ctx, with missing values filled in. Otherwise, the returned ctx will be an AOI, with this as its geometry.
products (str or List[str], optional) – Descartes Labs product identifiers
start_datetime (str, datetime-like, optional) – Restrict to scenes acquired after this datetime
end_datetime (str, datetime-like, optional) – Restrict to scenes acquired before this datetime
cloud_fraction (float, optional) – Restrict to scenes that are covered in clouds by less than this fraction (between 0 and 1)
storage_state (str, optional) – Filter results based on storage_state value ("available", "remote", or None)
limit (int or None, optional, default 100) – Maximum number of Scenes to return, or None for all results.
sort_field (str, optional) – Field name in Scene.properties by which to order the results
sort_order (str, optional, default 'asc') – "asc" or "desc"
date_field (str, optional, default 'acquired') – The field used when filtering by date ("acquired", "processed", "published")
query (Expression, optional) – Expression used to filter Scenes by their properties, built from dl.properties. You can construct filter expression using the ==, !=, <, >, <= and >= operators as well as the like() method. You cannot use the boolean keywords and and or because of Python language limitations; instead you can combine filter expressions with & (boolean “and”) and | (boolean “or”). Example: 150 < dl.properties.azimuth_angle < 160 & dl.properties.cloud_fraction < 0.5
randomize (bool, default False, optional) – Randomize the order of the results. You may also use an int or str as an explicit seed.
raster_client (Raster, optional) – Unneeded in general use; lets you use a specific client instance with non-default auth and parameters.
metadata_client (Metadata, optional) – Unneeded in general use; lets you use a specific client instance with non-default auth and parameters.

Returns:

scenes (SceneCollection) – Scenes matching your criteria.
ctx (GeoContext) – The given aoi as a GeoContext (if it isn’t one already), with reasonable default parameters for loading all matching Scenes.

If aoi was a GeoContext, ctx will be a copy of aoi, with any properties that were None assigned the defaults below.

If aoi was not a GeoContext, an AOI instance will be created with aoi as its geometry, and defaults assigned as described below:

Default Spatial Parameters:
- resolution: the finest resolution of any band of all matching scenes
- crs: the most common CRS used of all matching scenes