screenWithForwardMovingAverage()

Signature:

screen_with_forward_moving_average(
    window: int,
    only_valid: bool,
    use_reduced: bool,
    diff_limit: float,
    failed_validity: str = 'M',
    in_place: bool = False
) -> TimeSeries

Detailed Documentation

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

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:

ts2 = ts1.screen_with_forward_moving_average(
    7,
    True,
    True,
    5.5
)

---

Signature:

iscreen_with_forward_moving_average(
    window: int,
    only_valid: bool,
    use_reduced: bool,
    diff_limit: float,
    failed_validity: str = 'M',
) -> TimeSeries

Convenience method for calling screen_with_forward_moving_average(..) with in_place=True.

Example:

ts1.iscreen_with_forward_moving_average(
    7,
    True,
    True,
    5.5
)