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.

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)[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__#

Implements the geo-interface protocol.

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

as_geojson_object()[source]#

GeoJSON representation of SearchResult

as_shapely_geometry_object()[source]#

shapely.geometry.GeometryCollection representation of SearchResult

as_wkt_object()[source]#

WKT representation of SearchResult

crunch(cruncher, **search_params)[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=None, end=None)[source]#

Apply FilterDate crunch, check its documentation to know more.

filter_latest_by_name(name_pattern)[source]#

Apply FilterLatestByName crunch, check its documentation to know more.

filter_latest_intersect(geometry)[source]#

Apply FilterLatestIntersect crunch, check its documentation to know more.

filter_overlap(geometry, minimum_overlap=0, contains=False, intersects=False, within=False)[source]#

Apply FilterOverlap crunch, check its documentation to know more.

filter_property(operator='eq', **search_property)[source]#

Apply FilterProperty crunch, check its documentation to know more.

static from_geojson(feature_collection)[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