icc3a_1

Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.

icc3a_1(data: ndarray, alpha: float = 0.05) → ICCEstimate[source]

ICC(3A,1): two-way mixed effects, absolute agreement, single measurement.

Parameters:
  • data – (n, k) matrix, one row per voxel, one column per replication of the same condition. NaN handling is the caller’s responsibility (pairwise-complete rows recommended).

  • alpha – Two-sided significance level for the confidence limits.

Returns:

The estimate with its (1 - alpha) confidence limits, truncated to [0, 1] per the paper’s convention.

Raises:

ValueError – If data is not a 2-D, NaN-free matrix with at least 2 rows and 2 columns.