SearchResult#

Constructor#

SearchResult(products)

An object representing a collection of EOProduct resulting from a search.

Crunch#

SearchResult.crunch(cruncher, **search_params)

Do some crunching with the underlying EO products.

SearchResult.filter_date([start, end])

Apply FilterDate crunch, check its documentation to know more.

SearchResult.filter_latest_intersect(geometry)

Apply FilterLatestIntersect crunch, check its documentation to know more.

SearchResult.filter_latest_by_name(name_pattern)

Apply FilterLatestByName crunch, check its documentation to know more.

SearchResult.filter_overlap(geometry[, ...])

Apply FilterOverlap crunch, check its documentation to know more.

SearchResult.filter_property([operator])

Apply FilterProperty crunch, check its documentation to know more.

SearchResult.filter_online()

Use cruncher FilterProperty, filter for online products.

Conversion#

SearchResult.from_geojson(feature_collection)

Builds an SearchResult object from its representation as geojson

SearchResult.as_geojson_object()

GeoJSON representation of SearchResult

SearchResult.as_shapely_geometry_object()

shapely.geometry.GeometryCollection representation of SearchResult

SearchResult.as_wkt_object()

WKT representation of SearchResult

Interface#

SearchResult.__geo_interface__

Implements the geo-interface protocol.

class eodag.api.search_result.SearchResult(products: List[EOProduct])[source]#

An object representing a collection of EOProduct resulting from a search.

Parameters:

products (list(EOProduct)) – A list of products resulting from a search

property __geo_interface__: Dict[str, Any]#

Implements the geo-interface protocol.

See https://gist.github.com/sgillies/2217756

as_geojson_object() Dict[str, Any][source]#

GeoJSON representation of SearchResult

as_shapely_geometry_object() GeometryCollection[source]#

shapely.geometry.GeometryCollection representation of SearchResult

as_wkt_object() str[source]#

WKT representation of SearchResult

crunch(cruncher: Crunch, **search_params: Any) SearchResult[source]#

Do some crunching with the underlying EO products.

Parameters:
  • cruncher (subclass of Crunch) – The plugin instance to use to work on the products

  • search_params (dict) – The criteria that have been used to produce this result

Returns:

The result of the application of the crunching method to the EO products

Return type:

SearchResult

filter_date(start: str | None = None, end: str | None = None) SearchResult[source]#

Apply FilterDate crunch, check its documentation to know more.

filter_latest_by_name(name_pattern: str) SearchResult[source]#

Apply FilterLatestByName crunch, check its documentation to know more.

filter_latest_intersect(geometry: Dict[str, Any] | BaseGeometry | Any) SearchResult[source]#

Apply FilterLatestIntersect crunch, check its documentation to know more.

filter_online() SearchResult[source]#

Use cruncher FilterProperty, filter for online products.

filter_overlap(geometry: Any, minimum_overlap: int = 0, contains: bool = False, intersects: bool = False, within: bool = False) SearchResult[source]#

Apply FilterOverlap crunch, check its documentation to know more.

filter_property(operator: str = 'eq', **search_property: Any) SearchResult[source]#

Apply FilterProperty crunch, check its documentation to know more.

static from_geojson(feature_collection: Dict[str, Any]) SearchResult[source]#

Builds an SearchResult object from its representation as geojson

Parameters:

feature_collection (dict) – A collection representing a search result.

Returns:

An eodag representation of a search result

Return type:

SearchResult