Using the Geometry Filter to Obtain Full AOI Coverage via Planet APIs

Data API

The  Data API's GeometryFilter allows you to search for images that fully cover your area of interests. The GeometryFilter can be used to search for items with a footprint geometry which intersects with the specified geometry.

The filter's configuration supports PointMultiPointLineStringMultiLineStringPolygon, and MultiPolygon GeoJSON objects. For best results, the geometry should meet OpenGIS Simple Features Interface Specification requirements. If an invalid GeoJSON object is supplied, the API will automatically attempt to correct the geometry and return matching search results.

An optional relation field can be provided to specify the geometry boolean operation, which can be one of the following values: intersectscontainswithin, or disjoint.

  • intersects (default) : Returns items whose footprint geometry partially or fully overlaps with the AOI.
  • contains : Returns items where the footprint geometry fully encloses the AOI.
  • disjoint : Returns items whose footprint geometry does not intersect with the AOI in any way.
  • within : Returns items whose entire footprint geometry is fully contained within the AOI.

Subscriptions API

The Subscriptions API  geometry_relation allows you to specifiy the relationship between the subscription's geometry and a matched item's geometry. This parameter is an extension of the Data API's GeometryFilter.

  • intersects (default) : Returns items whose footprint geometry partially or fully overlaps with the subscription geometry.
  • contains : Returns items where the footprint geometry fully encloses the subscription geometry.
  • within : Returns items whose entire footprint geometry is fully contained within the subscription geometry.

Notably, subscriptions does not support the disjoint relation.

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.