Skip to contents

Compute intensity measures from a long time-series table.

getIntensity.Rd

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")
#>       OCID     ID     IM         value    units
#>     <char> <char> <char>         <num>   <char>
#>  1:     H1     AT     AI  8.008832e-05    mm /s
#>  2:     H1     AT    AIu  4.004416e-05    mm /s
#>  3:     H1     AT    AId  4.004416e-05    mm /s
#>  4:     H1     AT    PGA  1.000000e+00   mm /s2
#>  5:     H1     AT   ARMS  7.035975e-01   mm /s2
#>  6:     H1     AT    AZC  1.000000e+00        -
#>  7:     H1     AT    ATo  0.000000e+00   mm /s2
#>  8:     H1     AT    ATn -2.449294e-16   mm /s2
#>  9:     H1     AT  D0595  7.400000e-01        s
#> 10:     H1     AT  D2080  5.600000e-01        s
#> 11:     H1     AT  D0575  6.200000e-01        s
#> 12:     H1     AT    TmA  5.049154e-01        s
#> 13:     H1     AT    CAV  6.364103e-01    mm /s
#> 14:     H1     AT   CAV5  0.000000e+00    mm /s
#> 15:     H1     AT     NP  1.010000e+02  samples
#> 16:     H1     AT     dt  1.000000e-02        s
#> 17:     H1     AT     Fs  1.000000e+02       Hz
#> 18:     H1     AT   Dmax  1.000000e+00        s
#> 19:     H1     AT    EPI  3.330000e-01 mm^2/s^2
#> 20:     H1     AT    PDI  8.008832e-05     mm.s
#>       OCID     ID     IM         value    units
#>     <char> <char> <char>         <num>   <char>