olympicSmoothing()
==================

**Signature:**

.. code-block:: python

    olympic_moving_average(
        window: int,
        only_valid: bool,
        use_reduced: bool,
        in_place: bool = False
    ) -> TimeSeries

`Detailed Documentation <https://hydrologicengineeringcenter.github.io/hec-python-library/hec/timeseries.html#TimeSeries.olympic_moving_average>`_

The hec-python-library equivalent of Jython method **olympicSmoothing()**:

Computes and returns a time series that is the olympic moving average of this time series.

An olympic moving average sets the value at each time to be the average of the values at that
time and a number of previous and following consecutive times, disregarding the minimum and
maximum values in the range to average over.

.. include:: _in_place.rst

**Example:**

.. code-block:: python

    avg_ts = ts.olympic_moving_average(
        7,     # average over 7 values at each time step
        True,  # ignore invalid values when averaging
        True   # use less than 7 values a start and end
    )

    
====


**Signature:**

.. code-block:: python

    iolympic_moving_average(
        window: int,
        only_valid: bool,
        use_reduced: bool,
    ) -> TimeSeries

Convenience method for executing ``olympic_moving_average(...)`` with ``in_place=True``.

**Example:**

.. code-block:: python

    ts.iolympic_moving_average(
        7,     # average over 7 values at each time step
        True,  # ignore invalid values when averaging
        True   # use less than 7 values a start and end
    )