Skip to main content

query.SearchQuery

Query parameters for searching Sentinel-1 bursts via the CDSE API.

Usage

Source

query.SearchQuery(
    time_range=None,
    intersects=None,
    burst_id=None,
    abs_burst_id=None,
    polarization=None,
    mode=None,
    sub_swath=None,
    pass_direction=None,
    platform_serial_id=None,
    rel_orbit_number=None
)

All parameters are optional; omitting a parameter means no filtering on that field.

Parameters

time_range: TimeRange | None = None

Acquisition time window. The search keeps every acquisition on any of its days, end included, and the same window can then name the composite built from the search.

intersects: HasWkt | None = None

Spatial filter; bursts must intersect this geometry, in WGS 84 longitude and latitude. A geometry that carries a crs, such as an odc.geo Geometry, must be in EPSG:4326. The catalog rejects a geometry with too many vertices, such as the exact outline of an MGRS cell; search with its bounding box and select with BurstCollection.intersecting().

burst_id: int | None = None

Sentinel-1 relative burst ID, unique within each sub-swath. Must be positive.

abs_burst_id: int | None = None

Sentinel-1 absolute burst ID, globally unique across all sub-swaths and orbits. Must be positive.

polarization: Polarization | None = None

Polarization channel.

mode: Mode | None = None

Acquisition mode.

sub_swath: SubSwath | None = None

Sub-swath identifier.

pass_direction: PassDirection | None = None

Pass direction.

platform_serial_id: PlatformSerialID | None = None

Sentinel-1 platform serial identifier.

rel_orbit_number: int | None = None
Relative orbit number (1-175).

Raises

TypeError

If time_range is not a TimeRange.

ValueError
If any value falls outside its accepted range or set of identifiers, or intersects is not a geometry, is empty or is not in WGS 84.

Methods

Name Description
__repr__() Return string representation showing only non-None parameters.

__repr__()

Return string representation showing only non-None parameters.

Usage

Source

__repr__()
Returns
str
String representation of the query.