cdse.CDSEResponse
Response object for Sentinel-1 burst search operations.
Usage
cdse.CDSEResponse(
context,
value,
count=None,
)Parameters
context: str-
OData context metadata string (usually includes entity type).
value: list[dict[str, Any]]-
List of result items returned by the search.
count: int | None = None- Total number of matches on the server (if requested).
Methods
| Name | Description |
|---|---|
| __len__() | Return the number of items in the search result. |
| __repr__() | Return a human-readable summary of the CDSEResponse. |
| from_dict() | Create a CDSEResponse from a raw API response dictionary. |
| is_complete() | Check whether the response contains all available bursts that match the query. |
| to_geodataframe() | Convert the search results to a GeoPandas GeoDataFrame. |
__len__()
Return the number of items in the search result.
Usage
__len__()Returns
int- Number of bursts returned.
__repr__()
Return a human-readable summary of the CDSEResponse.
Usage
__repr__()Returns
str- A string representation showing count and entity type.
from_dict()
Create a CDSEResponse from a raw API response dictionary.
Usage
from_dict(data)Parameters
data: dict[str, Any]- JSON response dictionary from the search API.
Returns
CDSEResponse- Parsed CDSEResponse instance.
is_complete()
Check whether the response contains all available bursts that match the query.
Usage
is_complete()Returns
bool- True if response length is equal to count.
Raises
CatalogError- If count is None.
to_geodataframe()
Convert the search results to a GeoPandas GeoDataFrame.
Usage
to_geodataframe()Returns
geopandas.GeoDataFrame- The geospatial representation of the search results.
Raises
CatalogError- If a burst has no footprint, a footprint that is not a polygon in EWKT, or one in an unknown EPSG code.