Marine Extremes

This abstract type represents the main extremes which are heatwaves and cold spells. Both of them have their specific types – MHW for the heatwaves and MCS for the cold spells. Details below.

Cold spell and Heatwaves

MarineHeatwaves.MHW — Type
mhw = MHW(temp, clim, thresh)::MHW

Construct a marine heat wave object.

MarineHeatwaves.MCS — Type
mcs = MCS(temp, clim, thresh)::MCS

Construct a marine cold spell object.

MarineHeatwaves.mextreme — Function
mex, cixs = mextreme(sst, sstdate, mhwdate, climdate)

Return a MExtreme (MHW or MCS), and the indices of non-NaN values in the original array.

MarineHeatwaves.excess — Function
excds = excess(me::MExtreme)

Return in a Vector or Matrix, regions where the value is above (mhw) or below (mcs) the threshold.

Climatological mean and threshold

MarineHeatwaves.seamask — Function
mask = seamask(sst, dims)

Compute the regions of the data that are always NaN, and return them as a mask.

MarineHeatwaves.subtemp — Function
subtemp(sst::Array, mhix::UnitRange, clix::UnitRange)

Calculate the subset of the input array, using the range of the dates for the mhw/mcs event (mhix) and the climatology (clix)

For n-dimensional array input where n > 1, return n-1 dimension.

Return the array subset and indices of mask.

MarineHeatwaves.climthresh — Function
clim, thresh = climthresh(climsst, cldt_leap_year_day, mhdt_leap_year_day,
                          event_window, smoothing_window, threshold; wrap::Bool)

Calculate and return the climatology mean and quantile.