getIntensity: Compute intensity measures from a long time-series table.

View source: R/getIntensity.R

getIntensityR Documentation

Compute intensity measures from a long time-series table.

Description

getIntensity() is a compatibility wrapper around TSL2IM(). It accepts canonical long TSL input only; convert wide TSW input with TSW2TSL() first.

Usage

getIntensity(.x, units.source, units.target = "mm", output = c("IML", "IMW"))

Arguments

.x

data.table. Long-format TSL with at least OCID, ID, t, s columns plus optional record-identifier metadata columns.

units.source

character. Source units of the s column ("mm", "cm", "m", "gal", "g").

units.target

character. Target units for the returned intensities. Default "mm".

output

character. "IML" returns long intensity rows; "IMW" returns one row per metadata and OCID, with intensity measures as columns.

Value

See TSL2IM().

Examples

t <- seq(0, 1, by = 0.01)
tsl <- data.table::data.table(t = t, s = sin(2 * pi * t),
                              ID = "AT", OCID = "H1")
getIntensity(tsl, units.source = "mm")


gmsp documentation built on July 18, 2026, 5:07 p.m.