This is a pre-release version (2.5.0.dev0+git20251130.2de293a). Go to latest (2.4.4)
{ } Raw JSON

bundles / numpy 2.5.0.dev0+git20251130.2de293a / numpy / ma / extras / corrcoef

function

numpy.ma.extras:corrcoef

source: build-install/usr/lib/python3.14/site-packages/numpy/ma/extras.py :1675

Signature

def   corrcoef ( x y = None rowvar = True allow_masked = True )

Summary

Return Pearson product-moment correlation coefficients.

Extended Summary

Except for the handling of missing data this function does the same as numpy.corrcoef. For more details and examples, see numpy.corrcoef.

Parameters

x : array_like

A 1-D or 2-D array containing multiple variables and observations. Each row of x represents a variable, and each column a single observation of all those variables. Also see rowvar below.

y : array_like, optional

An additional set of variables and observations. y has the same shape as x.

rowvar : bool, optional

If rowvar is True (default), then each row represents a variable, with observations in the columns. Otherwise, the relationship is transposed: each column represents a variable, while the rows contain observations.

allow_masked : bool, optional

If True, masked values are propagated pair-wise: if a value is masked in x, the corresponding value is masked in y. If False, raises an exception. Because bias is deprecated, this argument needs to be treated as keyword only to avoid a warning.

Examples

import numpy as np
x = np.ma.array([[0, 1], [1, 1]], mask=[0, 1, 0, 1])
np.ma.corrcoef(x)

See also

cov

Estimate the covariance matrix.

numpy.corrcoef

Equivalent function in top-level NumPy module.

Aliases

  • numpy.ma.corrcoef