quantiles¶
- earthkit.transforms.climatology.quantiles(dataarray: Dataset | DataArray, q: float | list, time_dim: str | None = None, groupby_kwargs: dict | None = None, climatology_range: tuple | list | None = None, **reduce_kwargs) DataArray[source]¶
Calculate a set of climatological quantiles.
- Parameters:
dataarray (xarray.DataArray) – The DataArray over which to calculate the climatological quantiles. Must contain a time dimension.
q (float | list) – The quantile, or list of quantiles, to calculate the climatology.
frequency (str (optional)) – Valid options are day, week, month and year. The default is year.
bin_widths (int or list (optional)) – If bin_widths is an int, it defines the width of each group bin on the frequency provided by frequency. If bin_widths is a sequence it defines the edges of each bin, allowing for non-uniform bin widths.
time_dim (str (optional)) – Name of the time dimension in the data object, default behaviour is to detect the time dimension from the input object
climatology_range ((list or tuple, optional)) – Start and end year of the period to be used for the reference climatology. Default is to use the entire time-series.
groupby_kwargs (dict) – Any other kwargs that are accepted by earthkit.transforms.aggregate.groupby_time
**reduce_kwargs – Any other kwargs that are accepted by earthkit.transforms.aggregate.reduce (except how)
- Return type: