Skip to content

Commit

Permalink
feat: add Continuum Power CCA (#196)
Browse files Browse the repository at this point in the history
Co-authored-by: Sam Levang <[email protected]>
  • Loading branch information
nicrie and slevang authored Sep 1, 2024
1 parent 77ac921 commit de9eaa7
Show file tree
Hide file tree
Showing 40 changed files with 4,713 additions and 2,761 deletions.
47 changes: 47 additions & 0 deletions docs/api_reference/_autosummary/xeofs.models.CPCCARotator.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
xeofs.models.CPCCARotator
=========================

.. currentmodule:: xeofs.models

.. autoclass:: CPCCARotator
:members:
:show-inheritance:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

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






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

.. currentmodule:: xeofs.models

.. autoclass:: ComplexCPCCA
:members:
:show-inheritance:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

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






Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
xeofs.models.ComplexCPCCARotator
================================

.. currentmodule:: xeofs.models

.. autoclass:: ComplexCPCCARotator
:members:
:show-inheritance:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

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






12 changes: 8 additions & 4 deletions docs/api_reference/_autosummary/xeofs.models.ComplexMCA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,28 @@
~ComplexMCA.components_amplitude
~ComplexMCA.components_phase
~ComplexMCA.compute
~ComplexMCA.covariance_fraction
~ComplexMCA.correlation_coefficients_X
~ComplexMCA.correlation_coefficients_Y
~ComplexMCA.covariance_fraction_CD95
~ComplexMCA.cross_correlation_coefficients
~ComplexMCA.deserialize
~ComplexMCA.fit
~ComplexMCA.fraction_variance_X_explained_by_X
~ComplexMCA.fraction_variance_Y_explained_by_X
~ComplexMCA.fraction_variance_Y_explained_by_Y
~ComplexMCA.get_params
~ComplexMCA.get_serialization_attrs
~ComplexMCA.heterogeneous_patterns
~ComplexMCA.homogeneous_patterns
~ComplexMCA.inverse_transform
~ComplexMCA.load
~ComplexMCA.predict
~ComplexMCA.save
~ComplexMCA.scores
~ComplexMCA.scores_amplitude
~ComplexMCA.scores_phase
~ComplexMCA.serialize
~ComplexMCA.singular_values
~ComplexMCA.squared_covariance
~ComplexMCA.squared_covariance_fraction
~ComplexMCA.total_covariance
~ComplexMCA.transform


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,24 +21,28 @@
~ComplexMCARotator.components_amplitude
~ComplexMCARotator.components_phase
~ComplexMCARotator.compute
~ComplexMCARotator.covariance_fraction
~ComplexMCARotator.correlation_coefficients_X
~ComplexMCARotator.correlation_coefficients_Y
~ComplexMCARotator.covariance_fraction_CD95
~ComplexMCARotator.cross_correlation_coefficients
~ComplexMCARotator.deserialize
~ComplexMCARotator.fit
~ComplexMCARotator.fraction_variance_X_explained_by_X
~ComplexMCARotator.fraction_variance_Y_explained_by_X
~ComplexMCARotator.fraction_variance_Y_explained_by_Y
~ComplexMCARotator.get_params
~ComplexMCARotator.get_serialization_attrs
~ComplexMCARotator.heterogeneous_patterns
~ComplexMCARotator.homogeneous_patterns
~ComplexMCARotator.inverse_transform
~ComplexMCARotator.load
~ComplexMCARotator.predict
~ComplexMCARotator.save
~ComplexMCARotator.scores
~ComplexMCARotator.scores_amplitude
~ComplexMCARotator.scores_phase
~ComplexMCARotator.serialize
~ComplexMCARotator.singular_values
~ComplexMCARotator.squared_covariance
~ComplexMCARotator.squared_covariance_fraction
~ComplexMCARotator.total_covariance
~ComplexMCARotator.transform


Expand Down
47 changes: 47 additions & 0 deletions docs/api_reference/_autosummary/xeofs.models.ContinuumPowerCCA.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
xeofs.models.ContinuumPowerCCA
==============================

.. currentmodule:: xeofs.models

.. autoclass:: ContinuumPowerCCA
:members:
:show-inheritance:
:inherited-members:


.. automethod:: __init__


.. rubric:: Methods

.. autosummary::

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






12 changes: 8 additions & 4 deletions docs/api_reference/_autosummary/xeofs.models.MCA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,26 @@
~MCA.__init__
~MCA.components
~MCA.compute
~MCA.covariance_fraction
~MCA.correlation_coefficients_X
~MCA.correlation_coefficients_Y
~MCA.covariance_fraction_CD95
~MCA.cross_correlation_coefficients
~MCA.deserialize
~MCA.fit
~MCA.fraction_variance_X_explained_by_X
~MCA.fraction_variance_Y_explained_by_X
~MCA.fraction_variance_Y_explained_by_Y
~MCA.get_params
~MCA.get_serialization_attrs
~MCA.heterogeneous_patterns
~MCA.homogeneous_patterns
~MCA.inverse_transform
~MCA.load
~MCA.predict
~MCA.save
~MCA.scores
~MCA.serialize
~MCA.singular_values
~MCA.squared_covariance
~MCA.squared_covariance_fraction
~MCA.total_covariance
~MCA.transform


Expand Down
12 changes: 8 additions & 4 deletions docs/api_reference/_autosummary/xeofs.models.MCARotator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,22 +19,26 @@
~MCARotator.__init__
~MCARotator.components
~MCARotator.compute
~MCARotator.covariance_fraction
~MCARotator.correlation_coefficients_X
~MCARotator.correlation_coefficients_Y
~MCARotator.covariance_fraction_CD95
~MCARotator.cross_correlation_coefficients
~MCARotator.deserialize
~MCARotator.fit
~MCARotator.fraction_variance_X_explained_by_X
~MCARotator.fraction_variance_Y_explained_by_X
~MCARotator.fraction_variance_Y_explained_by_Y
~MCARotator.get_params
~MCARotator.get_serialization_attrs
~MCARotator.heterogeneous_patterns
~MCARotator.homogeneous_patterns
~MCARotator.inverse_transform
~MCARotator.load
~MCARotator.predict
~MCARotator.save
~MCARotator.scores
~MCARotator.serialize
~MCARotator.singular_values
~MCARotator.squared_covariance
~MCARotator.squared_covariance_fraction
~MCARotator.total_covariance
~MCARotator.transform


Expand Down
8 changes: 7 additions & 1 deletion docs/api_reference/multi_set_analysis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@ Methods that investigate relationships or patterns between variables across two
:recursive:

xeofs.models.MCA
xeofs.models.CCA
xeofs.models.CPCCA
xeofs.models.ComplexMCA
xeofs.models.ComplexCPCCA
xeofs.models.HilbertMCA
xeofs.models.CCA
xeofs.models.HilbertCPCCA

------------------------------
Sparse Solutions via Rotation
Expand All @@ -23,5 +26,8 @@ Sparse Solutions via Rotation
:recursive:

xeofs.models.MCARotator
xeofs.models.CPCCARotator
xeofs.models.ComplexMCARotator
xeofs.models.ComplexCPCCARotator
xeofs.models.HilbertMCARotator
xeofs.models.HilbertCPCCARotator
Loading

0 comments on commit de9eaa7

Please sign in to comment.