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 floatsInput array.
v: (N,) array_like of floatsInput array.
w: (N,) array_like of floats, optionalThe weights for each value in
uandv. Default is None, which gives each value a weight of 1.0centered: bool, optionalIf True,
uandvwill be centered. Default is True.
Returns
correlation: doubleThe correlation distance between 1-D array
uandv.
Examples
Find the correlation between two arrays.from scipy.spatial.distance import correlation
✓correlation([1, 0, 1], [1, 1, 0])
✗correlation([1, 0, 1], [1, 1, 0], w=[0.9, 0.1, 0.1])
✗correlation([1, 0, 1], [1, 1, 0], centered=False)
✗Aliases
-
scipy.spatial.distance.correlation