naginterfaces.library.mv.canon_​corr

naginterfaces.library.mv.canon_corr(z, isz, nx, ny, mcv, tol, wt=None)

canon_corr performs canonical correlation analysis upon input data matrices.

For full information please refer to the NAG Library document for g03ad

https://www.nag.com/numeric/nl/nagdoc_29.3/flhtml/g03/g03adf.html

Parameters

zfloat, array-like, shape $(n,m)$

$z[\text{i}-1,\text{j}-1]$ must contain the $\text{i}$th observation for the $\text{j}$th variable, for $\text{j}=1,2,\dots ,m$, for $\text{i}=1,2,\dots ,n$.

Both $x$ and $y$ variables are to be included in $z$, the indicator array, $isz$, being used to assign the variables in $z$ to the $x$ or $y$ sets as appropriate.

iszint, array-like, shape $\left(m\right)$

$isz[j-1]$ indicates whether or not the $j$th variable is included in the analysis and to which set of variables it belongs.

$isz[j-1]>0$

The variable contained in the $j$th column of $z$ is included as an $x$ variable in the analysis.

$isz[j-1]<0$

The variable contained in the $j$th column of $z$ is included as a $y$ variable in the analysis.

$isz[j-1]=0$

The variable contained in the $j$th column of $z$ is not included in the analysis.

nxint

The number of $x$ variables in the analysis, $n_x$.

nyint

The number of $y$ variables in the analysis, $n_y$.

mcvint

An upper limit to the number of canonical variates.

tolfloat

The value of $tol$ is used to decide if the variables are of full rank and, if not, what is the rank of the variables. The smaller the value of $tol$ the stricter the criterion for selecting the singular value decomposition. If a non-negative value of $tol$ less than machine precision is entered, the square root of machine precision is used instead.

wtNone or float, array-like, shape $\left(n\right)$, optional

The elements of $wt$ must contain the weights to be used in the analysis. The effective number of observations is the sum of the weights. If $wt[i-1]=0.0$ then the $i$th observation is not included in the analysis.

If weights are not provided then $wt$ must be set to None and the effective number of observations is $\text{n}$.

Returns

efloat, ndarray, shape $(min(nx,ny),6)$

The statistics of the canonical variate analysis.

$e[i-1,0]$

The canonical correlations, ${\delta }_{\text{i}}$, for $\text{i}=1,2,\dots ,l$.

$e[i-1,1]$

The eigenvalues of $\Sigma$, ${\lambda }_{\text{i}}^2$, for $\text{i}=1,2,\dots ,l$.

$e[i-1,2]$

The proportion of variation explained by the $\text{i}$th canonical variate, for $\text{i}=1,2,\dots ,l$.

$e[i-1,3]$

The ${\chi }^2$ statistic for the $\text{i}$th canonical variate, for $\text{i}=1,2,\dots ,l$.

$e[i-1,4]$

The degrees of freedom for ${\chi }^2$ statistic for the $\text{i}$th canonical variate, for $\text{i}=1,2,\dots ,l$.

$e[i-1,5]$

The significance level for the ${\chi }^2$ statistic for the $\text{i}$th canonical variate, for $\text{i}=1,2,\dots ,l$.

ncvint

The number of canonical correlations, $l$. This will be the minimum of the rank of $X$ and the rank of $Y$.

cvxfloat, ndarray, shape $(nx,mcv)$

The canonical variate loadings for the $x$ variables. $cvx[i-1,j-1]$ contains the loading coefficient for the $i$th $x$ variable on the $j$th canonical variate.

cvyfloat, ndarray, shape $(ny,mcv)$

The canonical variate loadings for the $y$ variables. $cvy[i-1,j-1]$ contains the loading coefficient for the $i$th $y$ variable on the $j$th canonical variate.

Raises

NagValueError

(errno $1$)

On entry, $mcv=⟨value⟩$ and $min(nx,ny)=⟨value⟩$.

Constraint: $mcv\ge min(nx,ny)$.

(errno $1$)

On entry, $tol=⟨value⟩$.

Constraint: $tol\ge 0.0$.

(errno $1$)

On entry, $\text{weight}=⟨value⟩$.

Constraint: $\text{weight}=\text{'U'}$ or $\text{'W'}$.

(errno $1$)

On entry, $\text{lde}=⟨value⟩$ and $min(nx,ny)=⟨value⟩$.

Constraint: $\text{lde}\ge min(nx,ny)$.

(errno $1$)

On entry, $n=⟨value⟩$ and $nx+ny=⟨value⟩$.

Constraint: $n>nx+ny$.

(errno $1$)

On entry, $m=⟨value⟩$ and $nx+ny=⟨value⟩$.

Constraint: $m\ge nx+ny$.

(errno $1$)

On entry, $ny=⟨value⟩$.

Constraint: $ny\ge 1$.

(errno $1$)

On entry, $nx=⟨value⟩$.

Constraint: $nx\ge 1$.

(errno $2$)

On entry, $i=⟨value⟩$ and $wt[i-1]<0.0$.

Constraint: $wt[\text{i}-1]\ge 0.0$.

(errno $3$)

On entry, $ny=⟨value⟩$, expected $\text{value}=⟨value⟩$.

Constraint: $ny$ must be consistent with $isz$.

(errno $3$)

On entry, $nx=⟨value⟩$, expected $\text{value}=⟨value⟩$.

Constraint: $nx$ must be consistent with $isz$.

(errno $4$)

On entry, the effective number of observations is less than $nx+ny+1$.

(errno $5$)

The singular value decomposition has failed to converge.

Warns

NagAlgorithmicWarning

(errno $6$)

A canonical correlation is equal to $1.0$.

(errno $7$)

On entry, the rank of the $Y$ matrix is $0$.

(errno $7$)

On entry, the rank of the $X$ matrix is $0$.

Notes

In the NAG Library the traditional C interface for this routine uses a different algorithmic base. Please contact NAG if you have any questions about compatibility.

Let there be two sets of variables, $x$ and $y$. For a sample of $n$ observations on $n_x$ variables in a data matrix $X$ and $n_y$ variables in a data matrix $Y$, canonical correlation analysis seeks to find a small number of linear combinations of each set of variables in order to explain or summarise the relationships between them. The variables thus formed are known as canonical variates.

Let the variance-covariance matrix of the two datasets be

$$\begin{array}{c}\left(\begin{array}{cc}{S}_{xx}& S_{xy}\\ S_{yx}& S_{yy}\end{array}\right)\end{array}$$

and let

$$\Sigma =S_{yy}^{-1}{S}_{yx}{S}_{xx}^{-1}{S}_{xy}$$

then the canonical correlations can be calculated from the eigenvalues of the matrix $\Sigma$. However, canon_corr calculates the canonical correlations by means of a singular value decomposition (SVD) of a matrix $V$. If the rank of the data matrix $X$ is $k_x$ and the rank of the data matrix $Y$ is $k_y$, and both $X$ and $Y$ have had variable (column) means subtracted then the $k_x\times k_y$ matrix $V$ is given by:

$$V=Q_x^T{Q}_y\text{,}$$

where $Q_x$ is the first $k_x$ columns of the orthogonal matrix $Q$ either from the $QR$ decomposition of $X$ if $X$ is of full column rank, i.e., $k_x=n_x$:

$$X=Q_x{R}_x$$

or from the SVD of $X$ if $k_x<n_x$:

$$X=Q_x{D}_x{P}_x^T\text{.}$$

Similarly $Q_y$ is the first $k_y$ columns of the orthogonal matrix $Q$ either from the $QR$ decomposition of $Y$ if $Y$ is of full column rank, i.e., $k_y=n_y$:

$$Y=Q_y{R}_y$$

or from the SVD of $Y$ if $k_y<n_y$:

$$Y=Q_y{D}_y{P}_y^T\text{.}$$

Let the SVD of $V$ be:

$$V=U_x\Delta U_y^T$$

then the nonzero elements of the diagonal matrix $\Delta$, ${\delta }_{\text{i}}$, for $\text{i}=1,2,\dots ,l$, are the $l$ canonical correlations associated with the $l$ canonical variates, where $l=min(k_x,k_y)$.

The eigenvalues, ${\lambda }_i^2$, of the matrix $\Sigma$ are given by:

$${\lambda }_i^2={\delta }_i^2\text{.}$$

The value of ${\pi }_i={\lambda }_i^2/\sum {\lambda }_i^2$ gives the proportion of variation explained by the $i$th canonical variate. The values of the ${\pi }_i$’s give an indication as to how many canonical variates are needed to adequately describe the data, i.e., the dimensionality of the problem.

To test for a significant dimensionality greater than $i$ the ${\chi }^2$ statistic:

$$(n-\frac{1}{2}(k_x+k_y+3))\sum _{j=i+1}^l\log (1-{\delta }_j^2)$$

can be used. This is asymptotically distributed as a ${\chi }^2$-distribution with $(k_x-i)(k_y-i)$ degrees of freedom. If the test for $i=k_{min}$ is not significant, then the remaining tests for $i>k_{min}$ should be ignored.

The loadings for the canonical variates are calculated from the matrices $U_x$ and $U_y$ respectively. These matrices are scaled so that the canonical variates have unit variance.

References

Hastings, N A J and Peacock, J B, 1975, Statistical Distributions, Butterworth

Kendall, M G and Stuart, A, 1976, The Advanced Theory of Statistics (Volume 3), (3rd Edition), Griffin

Morrison, D F, 1967, Multivariate Statistical Methods, McGraw–Hill