Overview
The
geometry_relation field in the Subscriptions API controls how a scene's footprint is spatially compared to your Area of Interest (AOI). This gives you precise control over which scenes are delivered based on how they overlap with your AOI.The Subscriptions API supports three spatial relations:
| Value | Behavior |
intersects |
Delivers scenes whose footprint overlaps with any part of your AOI |
contains |
Delivers only scenes that completely cover your AOI |
within |
Delivers only scenes whose footprint is entirely inside your AOI |
Note:
disjointis not supported.
intersects — The Default Behavior
intersects is the default value. If you don't specify a geometry_relation in your subscription, this behavior is applied automatically. It casts the widest net of the three options, returning any scene that touches any portion of your AOI — even if the scene only partially covers it.This is useful when you want maximum coverage and are comfortable with partial scenes at the edges of your AOI.
For workflows where only fully covered imagery will do — for example, when feeding data into a pipeline that requires complete scene coverage — consider using
contains instead.Code Example
catalog_source = catalog_source(
item_types=["PSScene"],
asset_types=["ortho_analytic_4b"],
start_time=datetime.fromisoformat("2024-11-05T00:00:00Z"),
geometry={...},
geometry_relation="intersects" # default; can be omitted
)This functionality extends the Item Search | Planet Documentation already available in the Data API into the Subscriptions API. For full reference documentation, see the Sources | Planet Documentation.
Comments
Please sign in to leave a comment.