easysnowdata.optical.planetscope.order#
- easysnowdata.optical.planetscope.order(aoi: Any, *, items: Any = None, time: Any = None, item_type: str = 'PSScene', bundle: str = 'analytic_sr', harmonize: str | None = 'Sentinel-2', composite: bool = False, name: str | None = None, reuse: bool = True, wait: bool = True, download: bool = True, cloud_cover: float | None = None, **kwargs: Any) dict[str, Any][source]#
Order scenes clipped to aoi and (by default) wait for and download them.
This spends the account’s quota. Returns a dict with
order_id,state,files(when downloaded) and the request that was sent.Give the order a name to make the call repeatable: with
reuse=True(the default) a name that already belongs to a successful order on the account is re-downloaded instead of re-ordered, so a notebook or a docs build that runs again spends nothing. Planet keeps delivered results for a limited time; when the old order is gone a new one is placed.- Parameters:
aoi – Required: the clip geometry. Ordering without one is refused.
items – Scenes to order (a
search()frame, ids, or item dicts). When omitted, time and cloud_cover drive a fresh search.bundle –
"analytic_sr"(4-band surface reflectance, default),"analytic_8b_sr","analytic"or"visual"; each analytic bundle includes the UDM2 mask.harmonize – Radiometric harmonisation target (
"Sentinel-2"by default, orNoneto skip it). Planet’sharmonizetool rescales PS2.SD and PSB.SD surface reflectance, band by band, onto Sentinel-2’s radiometry so the two sensors can be mixed in one time series.name – An order name, and whether an existing successful order of that name is re-downloaded instead of ordered again (see above).
reuse – An order name, and whether an existing successful order of that name is re-downloaded instead of ordered again (see above).
