feat!: Support for Complex and Hilbert models (#202)

docs/api_reference/_autosummary/xeofs.models.HilbertEOF.rst

@@ -0,0 +1,45 @@
+xeofs.models.HilbertEOF
+=======================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: HilbertEOF
+   :members:
+   :show-inheritance: 
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~HilbertEOF.__init__
+      ~HilbertEOF.components
+      ~HilbertEOF.components_amplitude
+      ~HilbertEOF.components_phase
+      ~HilbertEOF.compute
+      ~HilbertEOF.deserialize
+      ~HilbertEOF.explained_variance
+      ~HilbertEOF.explained_variance_ratio
+      ~HilbertEOF.fit
+      ~HilbertEOF.fit_transform
+      ~HilbertEOF.get_params
+      ~HilbertEOF.get_serialization_attrs
+      ~HilbertEOF.inverse_transform
+      ~HilbertEOF.load
+      ~HilbertEOF.save
+      ~HilbertEOF.scores
+      ~HilbertEOF.scores_amplitude
+      ~HilbertEOF.scores_phase
+      ~HilbertEOF.serialize
+      ~HilbertEOF.singular_values
+      ~HilbertEOF.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.HilbertEOFRotator.rst

@@ -0,0 +1,45 @@
+xeofs.models.HilbertEOFRotator
+==============================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: HilbertEOFRotator
+   :members:
+   :show-inheritance: 
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~HilbertEOFRotator.__init__
+      ~HilbertEOFRotator.components
+      ~HilbertEOFRotator.components_amplitude
+      ~HilbertEOFRotator.components_phase
+      ~HilbertEOFRotator.compute
+      ~HilbertEOFRotator.deserialize
+      ~HilbertEOFRotator.explained_variance
+      ~HilbertEOFRotator.explained_variance_ratio
+      ~HilbertEOFRotator.fit
+      ~HilbertEOFRotator.fit_transform
+      ~HilbertEOFRotator.get_params
+      ~HilbertEOFRotator.get_serialization_attrs
+      ~HilbertEOFRotator.inverse_transform
+      ~HilbertEOFRotator.load
+      ~HilbertEOFRotator.save
+      ~HilbertEOFRotator.scores
+      ~HilbertEOFRotator.scores_amplitude
+      ~HilbertEOFRotator.scores_phase
+      ~HilbertEOFRotator.serialize
+      ~HilbertEOFRotator.singular_values
+      ~HilbertEOFRotator.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.HilbertMCA.rst

@@ -0,0 +1,48 @@
+xeofs.models.HilbertMCA
+=======================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: HilbertMCA
+   :members:
+   :show-inheritance: 
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~HilbertMCA.__init__
+      ~HilbertMCA.components
+      ~HilbertMCA.components_amplitude
+      ~HilbertMCA.components_phase
+      ~HilbertMCA.compute
+      ~HilbertMCA.covariance_fraction
+      ~HilbertMCA.deserialize
+      ~HilbertMCA.fit
+      ~HilbertMCA.get_params
+      ~HilbertMCA.get_serialization_attrs
+      ~HilbertMCA.heterogeneous_patterns
+      ~HilbertMCA.homogeneous_patterns
+      ~HilbertMCA.inverse_transform
+      ~HilbertMCA.load
+      ~HilbertMCA.save
+      ~HilbertMCA.scores
+      ~HilbertMCA.scores_amplitude
+      ~HilbertMCA.scores_phase
+      ~HilbertMCA.serialize
+      ~HilbertMCA.singular_values
+      ~HilbertMCA.squared_covariance
+      ~HilbertMCA.squared_covariance_fraction
+      ~HilbertMCA.total_covariance
+      ~HilbertMCA.transform
+
+
+
+
+
+

docs/api_reference/_autosummary/xeofs.models.HilbertMCARotator.rst

@@ -0,0 +1,48 @@
+xeofs.models.HilbertMCARotator
+==============================
+
+.. currentmodule:: xeofs.models
+
+.. autoclass:: HilbertMCARotator
+   :members:
+   :show-inheritance: 
+   :inherited-members:
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~HilbertMCARotator.__init__
+      ~HilbertMCARotator.components
+      ~HilbertMCARotator.components_amplitude
+      ~HilbertMCARotator.components_phase
+      ~HilbertMCARotator.compute
+      ~HilbertMCARotator.covariance_fraction
+      ~HilbertMCARotator.deserialize
+      ~HilbertMCARotator.fit
+      ~HilbertMCARotator.get_params
+      ~HilbertMCARotator.get_serialization_attrs
+      ~HilbertMCARotator.heterogeneous_patterns
+      ~HilbertMCARotator.homogeneous_patterns
+      ~HilbertMCARotator.inverse_transform
+      ~HilbertMCARotator.load
+      ~HilbertMCARotator.save
+      ~HilbertMCARotator.scores
+      ~HilbertMCARotator.scores_amplitude
+      ~HilbertMCARotator.scores_phase
+      ~HilbertMCARotator.serialize
+      ~HilbertMCARotator.singular_values
+      ~HilbertMCARotator.squared_covariance
+      ~HilbertMCARotator.squared_covariance_fraction
+      ~HilbertMCARotator.total_covariance
+      ~HilbertMCARotator.transform
+
+
+
+
+
+

docs/api_reference/multi_set_analysis.rst

@@ -9,6 +9,7 @@ Methods that investigate relationships or patterns between variables across two
    :recursive:
 
    xeofs.models.MCA
+   xeofs.models.ComplexMCA
    xeofs.models.HilbertMCA
    xeofs.models.CCA
 
@@ -22,4 +23,5 @@ Sparse Solutions via Rotation
    :recursive:
 
    xeofs.models.MCARotator
+   xeofs.models.ComplexMCARotator
    xeofs.models.HilbertMCARotator

docs/api_reference/single_set_analysis.rst

@@ -10,6 +10,7 @@ Methods that examine relationships among variables within a single dataset, or w
     :recursive:
 
     xeofs.models.EOF
+    xeofs.models.ComplexEOF
     xeofs.models.HilbertEOF
     xeofs.models.ExtendedEOF
     xeofs.models.OPA
@@ -27,4 +28,5 @@ Sparse Solutions via Rotation
     :recursive:
 
     xeofs.models.EOFRotator
+    xeofs.models.ComplexEOFRotator
     xeofs.models.HilbertEOFRotator

docs/auto_examples/1single/index.rst

@@ -29,6 +29,23 @@
     </div>
 
 
+.. raw:: html
+
+    <div class="sphx-glr-thumbcontainer" tooltip="In this tutorial, we&#x27;ll walk through how to perform a Complex EOF analysis on the zonal and mer...">
+
+.. only:: html
+
+  .. image:: /auto_examples/1single/images/thumb/sphx_glr_plot_complex_eof_thumb.png
+    :alt:
+
+  :ref:`sphx_glr_auto_examples_1single_plot_complex_eof.py`
+
+.. raw:: html
+
+      <div class="sphx-glr-thumbnail-title">Complex EOF analysis</div>
+    </div>
+
+
 .. raw:: html
 
     <div class="sphx-glr-thumbcontainer" tooltip="EOF analysis in T-mode maximises the spatial variance.">
@@ -48,18 +65,18 @@
 
 .. raw:: html
 
-    <div class="sphx-glr-thumbcontainer" tooltip="We demonstrate how to execute a Complex EOF (or Hilbert EOF) analysis [1]_ [2]_ [3]_. This meth...">
+    <div class="sphx-glr-thumbcontainer" tooltip="We demonstrate how to execute a Hilbert EOF analysis [1]_ [2]_ [3]_. This method extends tradit...">
 
 .. only:: html
 
-  .. image:: /auto_examples/1single/images/thumb/sphx_glr_plot_complex_eof_thumb.png
+  .. image:: /auto_examples/1single/images/thumb/sphx_glr_plot_hilbert_eof_thumb.png
     :alt:
 
-  :ref:`sphx_glr_auto_examples_1single_plot_complex_eof.py`
+  :ref:`sphx_glr_auto_examples_1single_plot_hilbert_eof.py`
 
 .. raw:: html
 
-      <div class="sphx-glr-thumbnail-title">Complex/Hilbert EOF analysis</div>
+      <div class="sphx-glr-thumbnail-title">Hilbert EOF analysis</div>
     </div>
 
 
@@ -191,8 +208,9 @@
    :hidden:
 
    /auto_examples/1single/plot_eeof
-   /auto_examples/1single/plot_eof-tmode
    /auto_examples/1single/plot_complex_eof
+   /auto_examples/1single/plot_eof-tmode
+   /auto_examples/1single/plot_hilbert_eof
    /auto_examples/1single/plot_eof-smode
    /auto_examples/1single/plot_eeof_trend
    /auto_examples/1single/plot_multivariate-eof