ILAMB.Variable.Variable.spatialDistribution¶
- Variable.spatialDistribution(var, region='global')[source]¶
Evaluates how well the input variable is spatially distributed relative to this variable.
This routine returns the normalized standard deviation and correlation (needed for a Taylor plot) as well as a score given as
\[\frac{4(1+R)}{((\sigma+\frac{1}{\sigma})^2 (1+R_0))}\]where \(R\) is the correlation, \(R_0=1\) is the reference correlation, and \(\sigma\) is the normalized standard deviation.
- Parameters
var (ILAMB.Variable.Variable) – the comparison variable
region (str, optional) – the name of the region over which to check the spatial distribution
- Returns
std (ILAMB.Variable.Variable) – the normalized standard deviation of the input variable
R (ILAMB.Variable.Variable) – the correlation of the input variable
score (ILAMB.Variable.Variable) – the spatial distribution score