pastas.timeseries_utils.get_sample_for_freq
===========================================

.. py:function:: pastas.timeseries_utils.get_sample_for_freq(series: pandas.Series | pandas.DataFrame | None = None, freq: str | None = None, tmin: pandas.Timestamp | str | None = None, tmax: pandas.Timestamp | str | None = None, **kwargs)

   
   Sample a pandas Series or DataFrame so that the frequency is not higher than a supplied frequency.

   :param series: The original Series or DataFrame to be sampled.
   :type series: pandas.Series or pandas.DataFrame
   :param freq: A frequency string accepted by `pandas.date_range()`.
   :type freq: str
   :param tmin: The start date of the sampled series. If None, the tmin is set to the first
                index of series. The default is None.
   :type tmin: pandas.Timestamp or str, optional
   :param tmax: The end date of the sampled series. If None, the tmax is set to the last
                index of series. The default is None.
   :type tmax: pandas.Timestamp or str, optional

   :returns: The sampled series, consisting of a subset of the original series.
   :rtype: pandas.Series















   ..
       !! processed by numpydoc !!