Skip to contents

Computes the relative root-mean-square distance-matrix error after optional scalar calibration: $$ \left[ \frac{\sum_{i<j}(\alpha\hat D_{ij}-D_{ij})^2} {\sum_{i<j}D_{ij}^2} \right]^{1/2}. $$

Usage

isometry.rel.rms.error(
  D.estimated,
  D.true,
  scale = TRUE,
  true.tol = sqrt(.Machine$double.eps)
)

Arguments

D.estimated

Estimated distance matrix or dist object.

D.true

Ground-truth distance matrix or dist object.

scale

Logical scalar. If TRUE, use isometry.scale() to optimally rescale estimated distances before computing the error.

true.tol

Non-negative tolerance. Pairs with true distance less than or equal to this value are excluded from relative metrics.

Value

Numeric scalar relative RMS error.

Examples

D <- as.matrix(dist(1:4))
isometry.rel.rms.error(2 * D, D)
#> [1] 0