Crunch Plugins

Crunch Plugins#

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

class eodag.plugins.crunch.base.Crunch(config)[source]#

Base cruncher

Parameters:

config (dict[str, Any] | None) – Crunch configuration

proceed(products, **search_params)[source]#

Implementation of how the results must be crunched

Parameters:
Return type:

list[EOProduct]

This table lists all the crunch plugins currently available:

filter_date.FilterDate(config)

FilterDate cruncher: filter products by date

filter_latest_intersect.FilterLatestIntersect(config)

FilterLatestIntersect cruncher

filter_latest_tpl_name.FilterLatestByName(config)

FilterLatestByName cruncher

filter_overlap.FilterOverlap(config)

FilterOverlap cruncher

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, **search_params)[source]#

Execute crunch: Filter products between start and end dates.

Parameters:

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

  • search_params (Any)

Return type:

list[EOProduct]

Returns:

The filtered products

FilterLatestIntersect.proceed(products, **search_params)[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[str, Any]) – Search criteria that must contain geometry or geom parameters having value of type shapely.geometry.base.BaseGeometry or dict[str, Any]

Return type:

list[EOProduct]

Returns:

The filtered products

FilterLatestByName.proceed(products, **search_params)[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

  • search_params (Any)

Return type:

list[EOProduct]

Returns:

The filtered products

FilterOverlap.proceed(products, **search_params)[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 (Any) – Search criteria that must contain geometry

Return type:

list[EOProduct]

Returns:

The filtered products

FilterProperty.proceed(products, **search_params)[source]#

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

Parameters:

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

  • search_params (Any)

Return type:

list[EOProduct]

Returns:

The filtered products

Contents