Structure.flowEvents

Structure.flowEvents(inter_event_period=6, thresholdFlow=0.01, useNegativeFlow=False, reverseFlow=False)

Bin flow data into discrete events based on an inter-event period and threshold flow rate. Maximum flowrates, total flow volumes, and duration of each event are returned in a DataFrame.

Parameters:

inter_event_period: float, optional

The period in hours of flow less than or equal to thresholdFlow that demarks flow events, default to 6

thresholdFlow: float, optional

The flowrate in model flow units that dry or baseline condition that is not considered significant, default to 0.01

useNegativeFlow: bool, optional

If true, the method will consider negative flows when calculating flow volumes, defaults False

reverseFlow: bool, optional

If true, the method will calculate the flow in the reverse direction by multiplying the timeseries by negative one, defaults to False

Returns:

pd.DataFrame

DataFrame with statistics on each flow event