Skip to content

Commit

Permalink
feat: add CCA as cross-set analysis (#211)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicrie authored Sep 2, 2024
1 parent 675983f commit fcba987
Show file tree
Hide file tree
Showing 10 changed files with 870 additions and 2 deletions.
46 changes: 46 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.CCA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
CCA
===

.. currentmodule:: xeofs.cross

.. autoclass:: CCA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~CCA.__init__
~CCA.components
~CCA.compute
~CCA.correlation_coefficients_X
~CCA.correlation_coefficients_Y
~CCA.cross_correlation_coefficients
~CCA.deserialize
~CCA.fit
~CCA.fraction_variance_X_explained_by_X
~CCA.fraction_variance_Y_explained_by_X
~CCA.fraction_variance_Y_explained_by_Y
~CCA.get_params
~CCA.get_serialization_attrs
~CCA.heterogeneous_patterns
~CCA.homogeneous_patterns
~CCA.inverse_transform
~CCA.load
~CCA.predict
~CCA.save
~CCA.scores
~CCA.serialize
~CCA.squared_covariance_fraction
~CCA.transform






50 changes: 50 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.ComplexCCA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
ComplexCCA
==========

.. currentmodule:: xeofs.cross

.. autoclass:: ComplexCCA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~ComplexCCA.__init__
~ComplexCCA.components
~ComplexCCA.components_amplitude
~ComplexCCA.components_phase
~ComplexCCA.compute
~ComplexCCA.correlation_coefficients_X
~ComplexCCA.correlation_coefficients_Y
~ComplexCCA.cross_correlation_coefficients
~ComplexCCA.deserialize
~ComplexCCA.fit
~ComplexCCA.fraction_variance_X_explained_by_X
~ComplexCCA.fraction_variance_Y_explained_by_X
~ComplexCCA.fraction_variance_Y_explained_by_Y
~ComplexCCA.get_params
~ComplexCCA.get_serialization_attrs
~ComplexCCA.heterogeneous_patterns
~ComplexCCA.homogeneous_patterns
~ComplexCCA.inverse_transform
~ComplexCCA.load
~ComplexCCA.predict
~ComplexCCA.save
~ComplexCCA.scores
~ComplexCCA.scores_amplitude
~ComplexCCA.scores_phase
~ComplexCCA.serialize
~ComplexCCA.squared_covariance_fraction
~ComplexCCA.transform






50 changes: 50 additions & 0 deletions docs/api_reference/_autosummary/xeofs.cross.HilbertCCA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
HilbertCCA
==========

.. currentmodule:: xeofs.cross

.. autoclass:: HilbertCCA
:members:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

~HilbertCCA.__init__
~HilbertCCA.components
~HilbertCCA.components_amplitude
~HilbertCCA.components_phase
~HilbertCCA.compute
~HilbertCCA.correlation_coefficients_X
~HilbertCCA.correlation_coefficients_Y
~HilbertCCA.cross_correlation_coefficients
~HilbertCCA.deserialize
~HilbertCCA.fit
~HilbertCCA.fraction_variance_X_explained_by_X
~HilbertCCA.fraction_variance_Y_explained_by_X
~HilbertCCA.fraction_variance_Y_explained_by_Y
~HilbertCCA.get_params
~HilbertCCA.get_serialization_attrs
~HilbertCCA.heterogeneous_patterns
~HilbertCCA.homogeneous_patterns
~HilbertCCA.inverse_transform
~HilbertCCA.load
~HilbertCCA.predict
~HilbertCCA.save
~HilbertCCA.scores
~HilbertCCA.scores_amplitude
~HilbertCCA.scores_phase
~HilbertCCA.serialize
~HilbertCCA.squared_covariance_fraction
~HilbertCCA.transform






3 changes: 3 additions & 0 deletions docs/api_reference/cross_set_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,13 @@ Methods that investigate relationships or patterns between variables **across tw
:template: custom-class-template.rst
:recursive:

~xeofs.cross.CCA
~xeofs.cross.MCA
~xeofs.cross.CPCCA
~xeofs.cross.ComplexCCA
~xeofs.cross.ComplexMCA
~xeofs.cross.ComplexCPCCA
~xeofs.cross.HilbertCCA
~xeofs.cross.HilbertMCA
~xeofs.cross.HilbertCPCCA

Expand Down
Binary file modified docs/auto_examples/auto_examples_jupyter.zip
Binary file not shown.
Binary file modified docs/auto_examples/auto_examples_python.zip
Binary file not shown.
Loading

0 comments on commit fcba987

Please sign in to comment.