Skip to content

TimeScan

TimeScan module

This module provides functions to build a TimeScan functionnality.

timescan(da, t0_start, t0_end, t1_start, t1_end, t2_start, t2_end, aggregation=None)

Create a RGB timescan from a product and three date ranges.

Parameters:

Name Type Description Default
da DataArray | Dataset

xarray object on which to perform the timescan

required
t0_start datetime | Timestamp | str

start date of the first date range

required
t0_end datetime | Timestamp | str

end date of the first date range

required
t1_start datetime | Timestamp | str

start date of the second date range

required
t1_end datetime | Timestamp | str

end date of the second date range

required
t2_start datetime | Timestamp | str

start date of the third date range

required
t2_end datetime | Timestamp | str

end date of the third date range

required
aggregation Callable[[DataArray], DataArray]

aggregation to perform along the time dimension over each date range. If None, it defaults to a maximum aggregation.

None

Returns:

Name Type Description
rgb_timescan

RGB timescan product. RGB bands will be added to a new dimension 'rgb' along axis=0, with the first date range corresponding to the red band, the second to the green band and the third to the blue band.