screenWithRateOfChange()

Signature:

screen_with_value_change_rate(
    min_reject_limit: float = nan,
    min_question_limit: float = nan,
    max_question_limit: float = nan,
    max_reject_limit: float = nan,
    in_place: bool = False
) -> TimeSeries

Detailed Documentation

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

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_value_change_rate(
    -5.0,
    -1.0,
    1.0,
    5.0
)

---

Signature:

iscreen_with_value_change_rate(
    min_reject_limit: float = nan,
    min_question_limit: float = nan,
    max_question_limit: float = nan,
    max_reject_limit: float = nan,
) -> TimeSeries

Convenience method for calling screen_with_value_change_rate(...) with in_place=True. Example:

ts1.iscreen_with_value_change_rate(
    -5.0,
    -1.0,
    1.0,
    5.0
)