accumulation()

Signature:

accum(in_place: bool = False) -> TimeSeries

Detailed Documentation

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

Returns a time series whose values are the accumulation of values in this time series.

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.

Missing values are ignored; the accumulation at those times is the same as for the previous time.

If a selection is present, all non-selected items are set to missing before the accumulation is computed. They remain missing in the retuned time series.

Example:

accum_ts = ts.accum()

Signature:

iaccum() -> TimeSeries

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

Example:

ts.iaccum() # modifies ts to be the accumulation