pygeoinf 1.3.3__py3-none-any.whl → 1.3.5__py3-none-any.whl

pygeoinf/symmetric_space/sphere.py

@@ -41,6 +41,7 @@ except ImportError:
     )
 
 from pygeoinf.hilbert_space import (
+    EuclideanSpace,
     HilbertModule,
     MassWeightedHilbertModule,
 )
@@ -50,12 +51,14 @@ from .symmetric_space import (
     AbstractInvariantLebesgueSpace,
     AbstractInvariantSobolevSpace,
 )
+from .sh_tools import SHVectorConverter
 
 
 if TYPE_CHECKING:
     from matplotlib.figure import Figure
     from cartopy.mpl.geoaxes import GeoAxes
     from cartopy.crs import Projection
+    from pyshtools import SHGrid
 
 
 class SphereHelper:
@@ -528,6 +531,93 @@ class Lebesgue(SphereHelper, HilbertModule, AbstractInvariantLebesgueSpace):
             f"extend={self.extend}"
         )
 
+    def to_coefficient_operator(self, lmax: int, lmin: int = 0):
+        """
+        Returns a LinearOperator that maps an element of the space to
+        a vector of its spherical harmonic coefficients within the
+        specified range of degrees.
+
+        The output coefficients are ordered in the following manner:
+
+        u_{00}, u_{1-1}, u_{10}, u_{11}, u_{2-2}, u_{2-1}, u_{20}, u_{21}, u_{22}, ...
+
+        in this case assuming lmin = 0.
+
+        If lmax is larger than the field's lmax, the output will be padded by zeros.
+
+        Args:
+            lmax: The maximum spherical harmonic degree to include in the output.
+            lmin: The minimum spherical harmonic degree to include in the output.
+                Defaults to 0.
+
+        Returns:
+            A LinearOperator that maps an SHGrid to a NumPy vector of coefficients.
+
+        Notes:
+            This is a left inverse of the from_coefficient_operator so long a the
+            values for lmin and lmax are equal.
+        """
+
+        converter = SHVectorConverter(lmax, lmin)
+        codomain = EuclideanSpace(converter.vector_size)
+
+        def mapping(u: SHGrid) -> np.ndarray:
+            ulm = self.to_coefficients(u)
+            return converter.to_vector(ulm.coeffs)
+
+        def adjoint_mapping(data: np.ndarray) -> SHGrid:
+            coeffs = converter.from_vector(data, output_lmax=self.lmax)
+            ulm = sh.SHCoeffs.from_array(
+                coeffs,
+                normalization=self.normalization,
+                csphase=self.csphase,
+            )
+            return self.from_coefficients(ulm) / self.radius**2
+
+        return LinearOperator(self, codomain, mapping, adjoint_mapping=adjoint_mapping)
+
+    def from_coefficient_operator(self, lmax: int, lmin: int = 0):
+        """
+        Returns a LinearOperator that maps a vector of spherical harmonic coefficients
+        to an element of the space.
+
+        The input coefficients are ordered in the following manner:
+
+        u_{00}, u_{1-1}, u_{10}, u_{11}, u_{2-2}, u_{2-1}, u_{20}, u_{21}, u_{22}, ...
+
+        in this case assuming lmin = 0.
+
+        Args:
+            lmax: The maximum spherical harmonic degree to include in the output.
+            lmin: The minimum spherical harmonic degree to include in the output.
+                Defaults to 0.
+
+        Returns:
+            A LinearOperator that maps a NumPy vector of coefficients to an SHGrid.
+
+        Notes:
+            This is a right inverse of the to_coefficient_operator so long a the
+            values for lmin and lmax are equal.
+        """
+
+        converter = SHVectorConverter(lmax, lmin)
+        domain = EuclideanSpace(converter.vector_size)
+
+        def mapping(data: np.ndarray) -> SHGrid:
+            coeffs = converter.from_vector(data, output_lmax=self.lmax)
+            ulm = sh.SHCoeffs.from_array(
+                coeffs,
+                normalization=self.normalization,
+                csphase=self.csphase,
+            )
+            return self.from_coefficients(ulm)
+
+        def adjoint_mapping(u: SHGrid) -> np.ndarray:
+            ulm = self.to_coefficients(u)
+            return converter.to_vector(ulm.coeffs) * self.radius**2
+
+        return LinearOperator(domain, self, mapping, adjoint_mapping=adjoint_mapping)
+
 
 class Sobolev(SphereHelper, MassWeightedHilbertModule, AbstractInvariantSobolevSpace):
     """
@@ -691,3 +781,64 @@ class Sobolev(SphereHelper, MassWeightedHilbertModule, AbstractInvariantSobolevS
             f"grid={self.grid}\n"
             f"extend={self.extend}"
         )
+
+    def to_coefficient_operator(self, lmax: int, lmin: int = 0):
+        """
+        Returns a LinearOperator that maps an element of the space to
+        a vector of its spherical harmonic coefficients within the
+        specified range of degrees.
+
+        The output coefficients are ordered in the following manner:
+
+        u_{00}, u_{1-1}, u_{10}, u_{11}, u_{2-2}, u_{2-1}, u_{20}, u_{21}, u_{22}, ...
+
+        in this case assuming lmin = 0.
+
+        If lmax is larger than the field's lmax, the output will be padded by zeros.
+
+        Args:
+            lmax: The maximum spherical harmonic degree to include in the output.
+            lmin: The minimum spherical harmonic degree to include in the output.
+                Defaults to 0.
+
+        Returns:
+            A LinearOperator that maps an SHGrid to a NumPy vector of coefficients.
+
+        Notes:
+            This is a left inverse of the from_coefficient_operator so long a the
+            values for lmin and lmax are equal.
+        """
+
+        l2_operator = self.underlying_space.to_coefficient_operator(lmax, lmin)
+
+        return LinearOperator.from_formal_adjoint(
+            self, l2_operator.codomain, l2_operator
+        )
+
+    def from_coefficient_operator(self, lmax: int, lmin: int = 0):
+        """
+        Returns a LinearOperator that maps a vector of spherical harmonic coefficients
+        to an element of the space.
+
+        The input coefficients are ordered in the following manner:
+
+        u_{00}, u_{1-1}, u_{10}, u_{11}, u_{2-2}, u_{2-1}, u_{20}, u_{21}, u_{22}, ...
+
+        in this case assuming lmin = 0.
+
+        Args:
+            lmax: The maximum spherical harmonic degree to include in the output.
+            lmin: The minimum spherical harmonic degree to include in the output.
+                Defaults to 0.
+
+        Returns:
+            A LinearOperator that maps a NumPy vector of coefficients to an SHGrid.
+
+        Notes:
+            This is a right inverse of the to_coefficient_operator so long a the
+            values for lmin and lmax are equal.
+        """
+
+        l2_operator = self.underlying_space.from_coefficient_operator(lmax, lmin)
+
+        return LinearOperator.from_formal_adjoint(l2_operator.domain, self, l2_operator)

{pygeoinf-1.3.3.dist-info → pygeoinf-1.3.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygeoinf
-Version: 1.3.3
+Version: 1.3.5
 Summary: A package for solving geophysical inference and inverse problems
 License: BSD-3-Clause
 License-File: LICENSE

{pygeoinf-1.3.3.dist-info → pygeoinf-1.3.5.dist-info}/RECORD

@@ -1,30 +1,33 @@
-pygeoinf/__init__.py,sha256=vAoI6Kw2EL5koHn0EP0kbLvhtWV9gxA439PowiqkQHU,3246
+pygeoinf/__init__.py,sha256=IrG0WA80NuoXRJvoKNG7lKcht5ICBEQacjtuqBKQ2fU,3622
 pygeoinf/auxiliary.py,sha256=lfoTt9ZH4y8SAV8dKZi5EWx1oF_JtxtBMSmlFYqJYfE,1610
 pygeoinf/backus_gilbert.py,sha256=eFi4blSwOCsg_NuH6WD4gcgjvzvu5g5WpWahGobSBdM,3694
-pygeoinf/checks/hilbert_space.py,sha256=07AZ6fx44PgSPjo_bjRJlVWTta1k1hhIX0TTTwMRdm8,8665
-pygeoinf/checks/linear_operators.py,sha256=LjC7X3RRimsyoLu062RNdhj1KEau3CBhBTZ4m3ZRmjI,7042
-pygeoinf/checks/nonlinear_operators.py,sha256=CoINs_Pm0lzo8nR3H70bo8Osvauiy03CA-b99MnCPjw,7532
+pygeoinf/checks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pygeoinf/checks/hilbert_space.py,sha256=-4x2G4Byj2lsK5UNM34jWXumjZ8AqeNFSTJu-WEmwVI,8667
+pygeoinf/checks/linear_operators.py,sha256=945ECCM7nEPuE00_5Tb8o2pG5IYbNtDSqwKNhXqnrew,7044
+pygeoinf/checks/nonlinear_operators.py,sha256=pFHQrbQslrbBM9J_p1-4TQoETsupVICKtTtKFSWBfsk,7533
 pygeoinf/direct_sum.py,sha256=7V0qrwFGj0GN-p_zzffefPrIB0dPu5dshLTxem1mQGE,19274
 pygeoinf/forward_problem.py,sha256=NnqWp7iMfkhHa9d-jBHzYHClaAfhKmO5D058AcJLLYg,10724
 pygeoinf/gaussian_measure.py,sha256=bBh64xHgmLFl27krn9hkf8qDQjop_39x69cyhJgUHN8,26219
-pygeoinf/hilbert_space.py,sha256=rKF8upjHw7uw3qBKS-bsEo1J9-So0urTcmVsmJJQeog,25875
+pygeoinf/hilbert_space.py,sha256=Yc0Jw0A8Jo12Zpgb_9dhcF7CD77S1IDMrSTDFHpTRB8,27340
 pygeoinf/inversion.py,sha256=RV0hG2bGnciWdja0oOPKPxnFhYzufqdj-mKYNr4JJ_o,6447
-pygeoinf/linear_bayesian.py,sha256=L1cJkeHtba4fPXZ8CmiLRBtuG2fmzG228M_iEar-iP8,9643
+pygeoinf/linear_bayesian.py,sha256=o6m0fYESba8rE-rjxfCqXaV6irPthB1aWf8vhM2v8XQ,11324
 pygeoinf/linear_forms.py,sha256=mgZeDRegNKo8kviE68KrxkHR4gG9bf1RgsJz1MtDMCk,9181
 pygeoinf/linear_operators.py,sha256=Bn-uzwUXi2kkWZ7wc9Uhj3vBHtocN17hnzc_r7DAzTk,64530
-pygeoinf/linear_optimisation.py,sha256=UbSr6AOPpR2sRYoN1Pvv24-Zu7_XlJk1zE1IhQu83hg,12428
+pygeoinf/linear_optimisation.py,sha256=vF1T3HE9rPOnXy3PU82-46dlvGwdAvsqUNXOx0o-KD8,20431
 pygeoinf/linear_solvers.py,sha256=v-7yjKsa67Ts5EcyJzCdpj-aF0qBrA-akq0kLe59DS4,16843
 pygeoinf/nonlinear_forms.py,sha256=t7lk-Bha7Xdk9eiwXMmS0F47oTR6jW6qQ3HkgRGk54A,7012
 pygeoinf/nonlinear_operators.py,sha256=AtkDTQfGDzAnfFDIgiKfdk7uPEI-j_ZA3CNvY5A3U8w,7144
 pygeoinf/nonlinear_optimisation.py,sha256=skK1ikn9GrVYherD64Qt9WrEYHA2NAJ48msOu_J8Oig,7431
 pygeoinf/parallel.py,sha256=VVFvNHszy4wSa9LuErIsch4NAkLaZezhdN9YpRROBJo,2267
-pygeoinf/plot.py,sha256=zXY0o5MvgJUiwy3uEwTOwVdKT_5XRBKx_-9qmyalB3A,13654
+pygeoinf/plot.py,sha256=Uw9PCdxymUiAkFF0BS0kUAZBRWL6sh89FJnSIxtp_2s,13664
 pygeoinf/random_matrix.py,sha256=71l6eAXQ2pRMleaz1lXud6O1F78ugKyp3vHcRBXhdwM,17661
+pygeoinf/subspaces.py,sha256=5Bo1F9if5oEmKJ0YPWMFaajJKec5aGIrYZKvetwWa3c,10454
 pygeoinf/symmetric_space/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pygeoinf/symmetric_space/circle.py,sha256=GuwVmLdHGTMxMrZfyXIPP3pz_y971ntlD5pl42lKJZ0,18796
-pygeoinf/symmetric_space/sphere.py,sha256=SYeGa70fKzasXxwPoVk3tNBtlP0QwLQe5jwW7o3AmcU,23376
+pygeoinf/symmetric_space/sh_tools.py,sha256=_A_coPElu8DNYwA5udL92X87wiTyBClTbFtf6ch9nXM,3520
+pygeoinf/symmetric_space/sphere.py,sha256=wZlAVG3kKMuPmRURL4r2ZP3sQ8kWOAWRk1G_Lo_TZmo,28983
 pygeoinf/symmetric_space/symmetric_space.py,sha256=pEIZZYWsdegrYCwUs3bo86JTz3d2LsXFWdRYFa0syFs,17963
-pygeoinf-1.3.3.dist-info/METADATA,sha256=qXr6ZBARRYzRbjidXKyJ7bOmrf6tPNWZD4qdHjt6I14,16482
-pygeoinf-1.3.3.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-pygeoinf-1.3.3.dist-info/licenses/LICENSE,sha256=GrTQnKJemVi69FSbHprq60KN0OJGsOSR-joQoTq-oD8,1501
-pygeoinf-1.3.3.dist-info/RECORD,,
+pygeoinf-1.3.5.dist-info/METADATA,sha256=m0YVVuJ1McMBzUG1QYdurV1hB91UGmIiSn-STSq9a0s,16482
+pygeoinf-1.3.5.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+pygeoinf-1.3.5.dist-info/licenses/LICENSE,sha256=GrTQnKJemVi69FSbHprq60KN0OJGsOSR-joQoTq-oD8,1501
+pygeoinf-1.3.5.dist-info/RECORD,,