Baselines#

class faninsar.Baselines(dates: pd.DatetimeIndex | Sequence[datetime], values: np.ndarray)[source]#

Bases: object

A class manage the baselines of the interferograms.

property frame: Series#

Return the DataFrame of the baselines.

property values: ndarray#

Return the values of the baselines.

property dates: DatetimeIndex#

Return the dates of the SAR acquisitions.

classmethod from_pair_wise(pairs: Pairs, values: np.ndarray) → Baselines[source]#

Generate the Baselines object from the pair-wise baseline.

Parameters:

  • pairs (Pairs) – The pairs instance of the interferograms.

  • values (np.ndarray) – The values of spatial baselines of the pairs.

Returns:

baselines – The Baselines object.

Return type:

Baselines

to_pair_wise(pairs: Pairs) → pd.Series[source]#

Generate the pair-wise baseline from the Baselines object.

Parameters:

pairs (Pairs) – The pairs of the interferograms.

Returns:

values – The values of the baselines.

Return type:

np.ndarray

plot(pairs: Pairs, pairs_removed: Pairs | None = None, plot_gaps: bool = True, ax: plt.Axes | None = None, xlabel: str = 'Acquisition date', ylabel: str = 'Perpendicular baseline (m)', legend: bool = True, legend_labels: list[str] | None = None, pairs_kwargs: dict | None = None, pairs_removed_kwargs: dict | None = None, acq_kwargs: dict | None = None, gaps_kwargs: dict | None = None) → plt.Axes[source]#

Plot the baselines of the interferograms.

Parameters:

  • pairs (Pairs) – All pairs used (temporal baseline).

  • pairs_removed (Pairs, optional) – The pairs of the interferograms which are removed. Default is None.

  • plot_gaps (bool) – Whether to plot the gaps between the acquisitions. Default is True.

  • ax (plt.Axes) – The axes of the plot. Default is None, which means a new plot will be created.

  • xlabel (str) – The label of the x-axis. Default is “Acquisition date”.

  • ylabel (str) – The label of the y-axis. Default is “Perpendicular baseline (m)”.

  • legend (bool) – Whether to show the legend. Default is True.

  • legend_labels (list[str] | None) – The labels of the legend in the order of [valid pairs, removed pairs, acquisitions, gaps]. Default is None,

  • pairs_kwargs (dict) – The keyword arguments for the pairs to plt.plot(). Default is None.

  • pairs_removed_kwargs (dict) – The keyword arguments for the pairs remove to plt.plot(). Default is None.

  • acq_kwargs (dict) – The keyword arguments for the acquisitions to plt.plot(). Default is {}.

  • gaps_kwargs (dict) – The keyword arguments for the gaps to plt.vlines(). Default is None.

Returns:

ax – The axes of the plot.

Return type:

plt.Axes