earthkit.climate.land.hydrology.high_flow_frequency

earthkit.climate.land.hydrology.high_flow_frequency(q: xarray.DataArray | str = 'q', ds: xarray.Dataset | Any = None, *, threshold_factor: int = 9, freq: str = 'YS-OCT', **kwargs: Any) → Any

High flow frequency.

Calculate the number of days in a given period with flows greater than a specified threshold, given as a multiple of the median flow. By default, the period is the water year starting on 1st October and ending on 30th September, as commonly defined in North America.

Units:

• q_high_flow_frequency: days

This function wraps xclim.indicators.land.high_flow_frequency.

Parameters:

• q (xarray.DataArray | str) – Daily streamflow data.

• threshold_factor (int) – Factor by which the median flow is multiplied to set the high flow threshold, default is 9.

• freq (str) – Resampling frequency, default is ‘YS-OCT’ for water year starting in October and ending in September.

• ds (xarray.Dataset | Any) – Input dataset.

• **kwargs (Any) – Additional keyword arguments.

Returns:

The computed index.

Return type:

Any