xdem.DEMCollection

xdem.DEMCollection#

class xdem.DEMCollection(dems, timestamps=None, outlines=None, reference_dem=0)[source]#

A temporal collection of DEMs.

__init__(dems, timestamps=None, outlines=None, reference_dem=0)[source]#

Create a new temporal DEM collection.

Parameters:
  • dems (list[Raster] | list[DEM]) – A list of DEMs.

  • timestamps (list[datetime] | None) – A list of DEM timestamps.

  • outlines (Vector | dict[datetime, Vector] | None) – Polygons to separate the changing area of interest. Could for example be glacier outlines.

  • reference_dem (int | Raster) – An instance or index of which DEM in the ‘dems’ list is the reference.

Returns:

A new DEMCollection instance.

Methods

__init__(dems[, timestamps, outlines, ...])

Create a new temporal DEM collection.

get_cumulative_series([kind, ...])

Get the cumulative dH (elevation) or dV (volume) since the first timestamp.

get_ddem_mask(ddem[, outlines_filter])

Get a fitting dDEM mask for a provided dDEM.

get_dh_series([outlines_filter, mask, nans_ok])

Return a dataframe of mean dDEM values and respective areas for every timestamp.

get_dv_series([outlines_filter, mask, nans_ok])

Return a series of mean volume change (dV) for every timestamp.

interpolate_ddems([method])

Interpolate all the dDEMs in the DEMCollection object using the chosen interpolation method.

subtract_dems([resampling_method])

Generate dDEMs by subtracting all DEMs to the reference.

Attributes

reference_dem

Get the DEM acting reference.

reference_timestamp

Get the reference DEM timestamp.