geocat.comp.climatologies.climate_anomaly#
- geocat.comp.climatologies.climate_anomaly(dset, freq, time_dim=None, keep_attrs='default')#
This function calculates climate anomalies by subtracting the long term mean of each
freq
period (day, month, season, or year) from each datapoint.- Parameters:
dset (
xarray.Dataset
,xarray.DataArray
) – The data on which to operate. It must be uniformly spaced in the time dimension.freq (
str
) – Frequency alias. When the'year'
allias is used, the yearly average is subtracted from each data point. Multiyear climatologies are not yet possible with this function. Accepted aliases:day: for anomalies from the daily climatology
month: for anomalies from the monthly climatology
season: for anomalies from the seasonal climatology (seasons are DJF, MAM, JJA, and SON)
year: for anomalies from the yearly average
time_dim (
str
, optional) – Name of the time coordinate forxarray
objects. Defaults toNone
and infers the name from the data.keep_attrs (
bool
, optional) – If True, attrs will be copied from the original object to the new one. If False, the new object will be returned without attributes. Defaults to None which means the attrs will only be kept in unambiguous circumstances.
- Returns:
computed_dset (
xarray.Dataset
,xarray.DataArray
) – The computed anomalies
Note
Seasonal averages are weighted based on the number of days in each month. This means that the given data must be uniformly spaced (i.e. data every 6 hours, every two days, every month, etc.) and must not cross month boundaries (i.e. don’t use weekly averages where the week falls in two different months)
See also
Related GeoCAT Functions: climatology_average calendar_average
Related NCL Functions: calcDayAnomTLL calcMonAnomLLLT calcMonAnomLLT calcMonAnomTLL