## burst.BurstCollection


Collection of Sentinel-1 bursts with geospatial and temporal data.


Usage

``` python
burst.BurstCollection(df=None)
```


Provides methods for working with multiple bursts, including finding interferometric pairs, filtering, and visualization.


## Parameters


`df: gpd.GeoDataFrame | None = None`  
DataFrame with burst data. If `None`, an empty collection is created.


## Raises


`TypeError`  
If df is not a GeoDataFrame.

`ValueError`  
If required columns are missing.


## Methods

| Name | Description |
|----|----|
| [find_pairs()](#find_pairs) | Find interferometric burst pairs with a specified temporal baseline. |
| [from_bursts()](#from_bursts) | Create a BurstCollection from a collection of Burst objects. |
| [from_cdse_response()](#from_cdse_response) | Create a BurstCollection directly from a CDSEResponse. |
| [within()](#within) | Select the bursts acquired on a day of a time range. |

------------------------------------------------------------------------


#### find_pairs()


Find interferometric burst pairs with a specified temporal baseline.


Usage

``` python
find_pairs(*, baseline, max_delta=Timedelta(hours=6))
```


##### Parameters


`baseline: int | timedelta | np.timedelta64`  
Temporal baseline between primary and secondary bursts, a positive whole number of days: an integer number of days, or a `pandas.Timedelta`, `datetime.timedelta` or `numpy.timedelta64`.

`max_delta: timedelta | np.timedelta64 = Timedelta(hours=6)`  
Maximum allowed deviation from baseline, less than 12 hours, as a `pandas.Timedelta`, `datetime.timedelta` or `numpy.timedelta64`. Pairs are named by their spacing rounded to whole days, so a smaller tolerance keeps every pair at the requested baseline.


##### Returns


`BurstPairCollection`  
Collection of burst pairs matching the baseline criteria. Empty if no pair satisfies them.


##### Raises


`TypeError`  
If `baseline` is neither an integer nor a duration, or `max_delta` is not a duration.

`ValueError`  
If `baseline` is not a positive whole number of days, or `max_delta` is negative or 12 hours or more.


------------------------------------------------------------------------


#### from_bursts()


Create a BurstCollection from a collection of Burst objects.


Usage

``` python
from_bursts(bursts)
```


##### Parameters


`bursts: Collection[Burst]`  
Collection of Burst instances.


##### Returns


`BurstCollection`  
New BurstCollection instance.


------------------------------------------------------------------------


#### from_cdse_response()


Create a BurstCollection directly from a CDSEResponse.


Usage

``` python
from_cdse_response(response)
```


##### Parameters


`response: CDSEResponse`  
CDSE API response containing burst data.


##### Returns


`BurstCollection`  
New BurstCollection instance.


------------------------------------------------------------------------


#### within()


Select the bursts acquired on a day of a time range.


Usage

``` python
within(time_range)
```


##### Parameters


`time_range: TimeRange`  
Inclusive window of calendar days. A burst is kept when the UTC day of its acquisition falls in it, as for [SearchQuery](query.SearchQuery.md#s1bursts.query.SearchQuery).


##### Returns


`Self`  
New collection of the bursts in the window, possibly empty.