screenWithConstantValue()

Signature:

screen_with_constant_value(
    duration: Union[hec.Duration, str],
    missing_limit: float = nan,
    reject_limit: float = nan,
    question_limit: float = nan,
    min_threshold: float = nan,
    percent_valid_required: float = nan,
    in_place: bool = False
) -> TimeSeries

Detailed Documentation

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

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_constant_value(
    "1Day",
    0.1,
    min_threshold=1.0
)

---

Signature:

iscreen_with_constant_value(
    duration: Union[hec.Duration, str],
    missing_limit: float = nan,
    reject_limit: float = nan,
    question_limit: float = nan,
    min_threshold: float = nan,
    percent_valid_required: float = nan,
) -> TimeSeries

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

Example:

ts1.iscreen_with_constant_value(
    "1Day",
    0.1,
    min_threshold=1.0
)