matchCompatibility: Compatibility diagnostics of a matched suite

In gmsp: Ground Motion Signal Processing

Compatibility diagnostics of a matched suite

Description

Record-level and suite-level compatibility of the scaled spectra against the target band: PGA position, band containment, and RMSE diagnostics per record, plus their suite aggregate.

Usage

matchCompatibility(
  .x,
  target,
  scale,
  ocid = "H1",
  factorMin = 0,
  factorMax = Inf
)

Arguments

.x	data.table. Final PSW rows (after record scaling) with the record key columns, Tn, and ⁠PSA.<ocid>⁠.
target	data.table. Target band with columns Tn, Sa.low, Sa.mean, Sa.high; must include exactly one Tn == 0 row.
scale	data.table. Record scaling table (RecordID, scaleFactor) from fitRecordFactor().
ocid	character. Component evaluated ("H1", "H2", "UP").
factorMin	numeric. Lower record-factor bound used to flag saturated records. Default 0.
factorMax	numeric. Upper record-factor bound used to flag saturated records. Default Inf.

Value

list with record (per-record diagnostics, one row per record) and summary (one-row suite aggregate).

Examples

## Not run: 
QA <- matchCompatibility(.x = PSW, target = Band, scale = Suite$scale,
                         factorMin = 0.5, factorMax = 1.6)

## End(Not run)

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