Crunch Plugins#

Crunch plugins must inherit the following class and implement proceed():

class eodag.plugins.crunch.base.Crunch(config: Optional[Dict[str, Any]])[source]#

Base cruncher

proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Implementation of how the results must be crunched

This table lists all the crunch plugins currently available:

eodag.plugins.crunch.filter_date.FilterDate(config)

FilterDate cruncher: filter products by date

eodag.plugins.crunch.filter_latest_intersect.FilterLatestIntersect(config)

FilterLatestIntersect cruncher

eodag.plugins.crunch.filter_latest_tpl_name.FilterLatestByName(config)

FilterLatestByName cruncher

eodag.plugins.crunch.filter_overlap.FilterOverlap(config)

FilterOverlap cruncher

eodag.plugins.crunch.filter_property.FilterProperty(config)

FilterProperty cruncher

The signature of each plugin’s proceed() method is displayed below, it may contain information useful to execute the cruncher:

FilterDate.proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Execute crunch: Filter products between start and end dates.

Parameters

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

Returns

The filtered products

Return type

list(EOProduct)

FilterLatestIntersect.proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Execute crunch: Filter latest products (the ones with a the highest start date) that intersect search extent.

Parameters

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

  • search_params (dict) – Search criteria that must contain geometry (dict) or search geom (shapely.geometry.base.BaseGeometry) argument will be used

Returns

The filtered products

Return type

list(EOProduct)

FilterLatestByName.proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Execute crunch: Filter Search results to get only the latest product, based on the name of the product

Parameters

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

Returns

The filtered products

Return type

list(EOProduct)

FilterOverlap.proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Execute crunch: Filter products, retaining only those that are overlapping with the search_extent

Parameters

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

  • search_params (dict) – Search criteria that must contain geometry

Returns

The filtered products

Return type

list(EOProduct)

FilterProperty.proceed(products: List[EOProduct], **search_params: Any) → List[EOProduct][source]#

Execute crunch: Filter products, retaining only those that match property filtering

Parameters

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

Returns

The filtered products

Return type

list(EOProduct)