getEventsWithStatisticsForMultipleSeries: Get Events with Statistics for multiple Series

In KWB-R/kwb.event: Generate Events from Time Series and Work with Events

Get Events with Statistics for multiple Series

Description

Get Events with Statistics for multiple Series

Usage

getEventsWithStatisticsForMultipleSeries(
  rainData,
  eventSeparationTime,
  signalWidth = kwb.datetime::getTimestepInSeconds(timestamps = rainData[, 1]),
  signalThreshold = 0,
  signalComparisonOperator = "gt"
)

Arguments

rainData	data frame with time stamps in the first column and rain heights (or intensities) in the remaining columns
eventSeparationTime	“event separation time” in seconds. Maximal allowed time difference between two consecutive timestamps within the same event.
signalWidth	“signal width” in seconds. Length of time interval that one timestamp is representing, e.g. 5*60 = 300 if each timestamp respresents a time interval of five minutes (as e.g. a time series is recorded on a five minute time scale). This parameter is needed to calculate event durations.
signalThreshold	value that needs to be exceeded (signalComparisonOperator == "gt") or reached (signalComparisonOperator == "ge") by the rain heights (or intensities) in order to be counted as a "signal". Default: 0
signalComparisonOperator	Operator to be applied when comparing rain values with signalThreshold. Must be one of "gt" (greater than) or "ge" greater than or equal. Default: "gt"

KWB-R/kwb.event documentation built on June 14, 2022, 1:15 p.m.