Skip to content
Snippets Groups Projects
Commit ddc97cb6 authored by Maria Tarasevich's avatar Maria Tarasevich
Browse files

Update README.md

parent 6301b91b
No related branches found
No related tags found
1 merge request!1Doc
...@@ -15,32 +15,34 @@ Python tool to perform maximal covariance analysis and calculating empirical ort ...@@ -15,32 +15,34 @@ Python tool to perform maximal covariance analysis and calculating empirical ort
количество пар максимально скоррелированных мод (по умолчанию 3) и значение переключателя режима вычитания из поля его среднего по времени значения количество пар максимально скоррелированных мод (по умолчанию 3) и значение переключателя режима вычитания из поля его среднего по времени значения
(по умолчанию `True`, то есть из поля _вычитается_ его среднее по времени значение). (по умолчанию `True`, то есть из поля _вычитается_ его среднее по времени значение).
Пусть $`X(t), Y(t)`$ --- два меняющихся во времени поля, максимально скоррелированные моды которых мы ищем, причём $\operatorname{dim}(X)=nT \times nX$\footnote{Здесь и далее размерности массивов указаны в порядке, принятом в \texttt{C} и \texttt{Python}. В \texttt{Fortran} размерности массивов следует развернуть в обратном порядке} и $\operatorname{dim}(Y)\hm=nT \times nY$, где $nX$ и $nY$ могут быть одним или несколькими измерениями массивов (в случае среднемесячных данных INMCM $nX$ и $nY$ --- $120 \times 180$). Пусть $`X(t), Y(t)`$ — два меняющихся во времени поля, максимально скоррелированные моды которых мы ищем, причём $`\operatorname{dim}(X)=nT \times nX`$[^1] и $`\operatorname{dim}(Y)=nT \times nY`$, где $`nX`$ и $`nY`$ могут быть одним или несколькими измерениями массивов (в случае среднемесячных данных INMCM $`nX`$ и $`nY`$ — $`120 \times 180`$).
Функция \texttt{supersvd} вычисляет разложение вида:
\begin{equation} [^1]: Здесь и далее размерности массивов указаны в порядке, принятом в `C` и `Python`. В `Fortran` размерности массивов следует развернуть в обратном порядке.
Функция `supersvd` вычисляет разложение вида:
```math
\begin{aligned} \begin{aligned}
X(t) &= \overline{X} + XV_1 XC_1(t) + XV_2 XC_2(t) + \ldots + XV_k XC_k(t) + \ldots,\\ X(t) &= \overline{X} + XV_1 XC_1(t) + XV_2 XC_2(t) + \ldots + XV_k XC_k(t) + \ldots,\\
Y(t) &= \overline{Y} + YV_1 YC_1(t) + YV_2 YC_2(t) + \ldots + YV_k YC_k(t) + \ldots, Y(t) &= \overline{Y} + YV_1 YC_1(t) + YV_2 YC_2(t) + \ldots + YV_k YC_k(t) + \ldots,
\end{aligned} \end{aligned}
\label{eq:svd} ```
\end{equation}
где где
\begin{equation*} ```math
\overline{X}=\frac{1}{nT}\sum_{t=1}^{nT} X(t),\qquad \overline{X}=\frac{1}{nT}\sum_{t=1}^{nT} X(t),\qquad
\overline{Y}=\frac{1}{nT}\sum_{t=1}^{nT} Y(t), \overline{Y}=\frac{1}{nT}\sum_{t=1}^{nT} Y(t),
\end{equation*} ```
а $k$ --- количество пар максимально скоррелированных мод. В \eqref{eq:svd} каждое новое слагаемое получается максимизацией корреляции между $XC_k(t)$ и $YC_k(t)$, а а $`k`$ — количество пар максимально скоррелированных мод. В формуле выше каждое новое слагаемое получается максимизацией корреляции между $`XC_k(t)`$ и $`YC_k(t)`$, а
$XV_k, YV_k$~--- два семейства ортогональных пространственных мод. $`XV_k, YV_k`$ — два семейства ортогональных пространственных мод.
Моды $XV_k, YV_k$ являются левыми и правыми сингулярными векторами матрицы ковариации $$C =\frac{1}{nT} \sum_{t=1}^{nT} (X(t) - \overline{X}) (Y(t) - \overline{Y})^{\mathsf T}.$$ Моды $`XV_k, YV_k`$ являются левыми и правыми сингулярными векторами матрицы ковариации
```math
Функция \texttt{supersvd} возвращает: C =\frac{1}{nT} \sum_{t=1}^{nT} (X(t) - \overline{X}) (Y(t) - \overline{Y})^{\mathsf T}.
\begin{itemize} ```
\item массивы \texttt{x\_coeff}, \texttt{y\_coeff} временных коэффициентов $XC(t), YC(t)$ разложения \eqref{eq:svd} \big(раз\-мерности $k \times nT$\big); Функция `supersvd` возвращает:
\item массив \texttt{x\_vect} левых сингулярных векторов $XV$ \big(размерности $k \times nX$\big); * массивы `x_coeff`, `y_coeff` временных коэффициентов $`XC(t), YC(t)`$ разложения (размерности $`k \times nT`$);
\item массив \texttt{y\_vect} правых сингулярных векторов $YV$ \big(размерности $k \times nY$\big); * массив `x_vect` левых сингулярных векторов $`XV`$ (размерности $`k \times nX`$);
\item массив \texttt{corrcoeff}, содержащий $k$ коэффициентов корреляции между $XC_k(t)$ и $YC_k(t)$; * массив `y_vect` правых сингулярных векторов $`YV`$ (размерности $`k \times nY`$);
\item массив \texttt{x\_variance\_fraction} (\texttt{y\_variance\_fraction}), содержащий доли дисперсии, приходящиеся на каждый из $k$ левых (правых) сингулярных векторов; * массив `corrcoeff`, содержащий $`k`$ коэффициентов корреляции между $`XC_k(t)`$ и $`YC_k(t)`$;
\item массив \texttt{eigenvalue\_fraction}, содержащий долю дисперсии матрицы ковариации, приходящуюся на $k$-ую пару сингулярных векторов; * массив `x_variance_fraction` (`y_variance_fraction`), содержащий доли дисперсии, приходящиеся на каждый из $`k`$ левых (правых) сингулярных векторов;
\item массив \texttt{eigenvalues} сингулярных значений матрицы ковариации $C$. * массив `eigenvalue_fraction`, содержащий долю дисперсии матрицы ковариации, приходящуюся на $`k`$-ую пару сингулярных векторов;
\end{itemize} * массив `eigenvalues` сингулярных значений матрицы ковариации $`C`$.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment