forwardMovingAverage()

Signature:

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

Detailed Documentation

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

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

A forward moving average sets the value at each time to be the average of the values at that time and a number of previous consecutive times.

If in_place=True, the instance itself is modified. In this case the returned value (which can be ignored in python) is the modified instance, which can be used in chaining methods.

Example:

avg_ts = ts.forward_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:

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

Convenience method for executing forward_moving_average(...) with in_place=True.

Example:

ts.iforward_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
)