{ } Raw JSON

bundles / scipy 1.17.1 / scipy / spatial / distance / correlation

function

scipy.spatial.distance:correlation

source: /scipy/spatial/distance.py :595

Signature

def   correlation ( u v w = None centered = True )

Summary

Compute the correlation distance between two 1-D arrays.

Extended Summary

The correlation distance between u and v, is defined as

where is the mean of the elements of u and is the dot product of and .

Parameters

u : (N,) array_like of floats

Input array.

v : (N,) array_like of floats

Input array.

w : (N,) array_like of floats, optional

The weights for each value in u and v. Default is None, which gives each value a weight of 1.0

centered : bool, optional

If True, u and v will be centered. Default is True.

Returns

correlation : double

The correlation distance between 1-D array u and v.

Examples

Find the correlation between two arrays.
from scipy.spatial.distance import correlation
correlation([1, 0, 1], [1, 1, 0])
Using a weighting array, the correlation can be calculated as:
correlation([1, 0, 1], [1, 1, 0], w=[0.9, 0.1, 0.1])
If centering is not needed, the correlation can be calculated as:
correlation([1, 0, 1], [1, 1, 0], centered=False)

Aliases

  • scipy.spatial.distance.correlation

Referenced by