Merge pull request #89 from uit-cosmo/python_req

Remove static method decorators

blobmodel/blob_shape.py

@@ -20,6 +20,121 @@ def get_blob_shape_perp(self, theta: np.ndarray, **kwargs) -> np.ndarray:
         raise NotImplementedError
 
 
+def _get_exponential_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the exponential pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the exponential pulse shape.
+    """
+    return np.exp(theta) * np.heaviside(-1.0 * theta, 1)
+
+
+def _get_lorentz_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the Lorentzian pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the Lorentzian pulse shape.
+    """
+    return 1 / (np.pi * (1 + theta**2))
+
+
+def _get_double_exponential_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the double-exponential pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+        lam : float
+            Asymmetry parameter controlling the shape.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the double-exponential pulse shape.
+    """
+    lam = kwargs["lam"]
+    assert (lam > 0.0) & (lam < 1.0)
+    kern = np.zeros(shape=np.shape(theta))
+    kern[theta < 0] = np.exp(theta[theta < 0] / lam)
+    kern[theta >= 0] = np.exp(-theta[theta >= 0] / (1 - lam))
+    return kern
+
+
+def _get_gaussian_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the Gaussian pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the Gaussian pulse shape.
+    """
+    return 1 / np.sqrt(2 * np.pi) * np.exp(-(theta**2) / 2)
+
+
+def _get_secant_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the secant pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the secant pulse shape.
+    """
+    return 2 / np.pi / (np.exp(theta) + np.exp(-theta))
+
+
+def _get_dipole_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
+    """Compute the diople pulse shape as a derivative of a gaussian pulse shape.
+
+    Parameters
+    ----------
+    theta : np.ndarray
+        Array of theta values.
+    kwargs
+        Additional keyword arguments.
+
+    Returns
+    -------
+    np.ndarray
+        Array representing the dipole pulse shape.
+    """
+    return -2 * theta / np.sqrt(2 * np.pi) * np.exp(-(theta**2) / 2)
+
+
 class BlobShapeImpl(AbstractBlobShape):
     """Implementation of the AbstractPulseShape class."""
 
@@ -77,121 +192,6 @@ def get_blob_shape_perp(self, theta: np.ndarray, **kwargs) -> np.ndarray:
         """
         raise NotImplementedError
 
-    @staticmethod
-    def _get_exponential_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the exponential pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the exponential pulse shape.
-        """
-        return np.exp(theta) * np.heaviside(-1.0 * theta, 1)
-
-    @staticmethod
-    def _get_lorentz_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the Lorentzian pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the Lorentzian pulse shape.
-        """
-        return 1 / (np.pi * (1 + theta**2))
-
-    @staticmethod
-    def _get_double_exponential_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the double-exponential pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-            lam : float
-                Asymmetry parameter controlling the shape.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the double-exponential pulse shape.
-        """
-        lam = kwargs["lam"]
-        assert (lam > 0.0) & (lam < 1.0)
-        kern = np.zeros(shape=np.shape(theta))
-        kern[theta < 0] = np.exp(theta[theta < 0] / lam)
-        kern[theta >= 0] = np.exp(-theta[theta >= 0] / (1 - lam))
-        return kern
-
-    @staticmethod
-    def _get_gaussian_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the Gaussian pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the Gaussian pulse shape.
-        """
-        return 1 / np.sqrt(2 * np.pi) * np.exp(-(theta**2) / 2)
-
-    @staticmethod
-    def _get_secant_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the secant pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the secant pulse shape.
-        """
-        return 2 / np.pi / (np.exp(theta) + np.exp(-theta))
-
-    @staticmethod
-    def _get_dipole_shape(theta: np.ndarray, **kwargs) -> np.ndarray:
-        """Compute the diople pulse shape as a derivative of a gaussian pulse shape.
-
-        Parameters
-        ----------
-        theta : np.ndarray
-            Array of theta values.
-        kwargs
-            Additional keyword arguments.
-
-        Returns
-        -------
-        np.ndarray
-            Array representing the dipole pulse shape.
-        """
-        return -2 * theta / np.sqrt(2 * np.pi) * np.exp(-(theta**2) / 2)
-
     __GENERATORS = {
         "exp": _get_exponential_shape,
         "gauss": _get_gaussian_shape,

tests/test_blob.py

@@ -101,9 +101,7 @@ def test_single_point():
         x=mesh_x, y=mesh_y, t=0, periodic_y=True, Ly=10
     )
 
-    expected_values = (
-        1 / (2 * np.pi) * np.exp(-(mesh_x**2) / 2) * np.exp(-(4**2) / 2)
-    )
+    expected_values = 1 / (2 * np.pi) * np.exp(-(mesh_x**2) / 2) * np.exp(-(4**2) / 2)
     error = np.max(abs(expected_values - blob_values))
 
     assert error < 1e-8, "Numerical error too big"

tests/test_pulse_shape.py

@@ -1,5 +1,5 @@
 import pytest
-from blobmodel import BlobShapeImpl, AbstractBlobShape, BlobShapeImpl
+from blobmodel import AbstractBlobShape, BlobShapeImpl
 import numpy as np
 
 
@@ -47,24 +47,33 @@ def test__get_double_exponential_shape():
     theta = np.array([-1, 0, 1])
     lam = 0.5
     expected_result = np.array([0.13533528, 1.0, 0.13533528])
-    assert np.allclose(
-        BlobShapeImpl._get_double_exponential_shape(theta, lam=lam), expected_result
-    )
+    ps = BlobShapeImpl("2-exp", "2-exp")
+    values = ps.get_blob_shape_perp(theta, lam=lam)
+    assert np.max(np.abs(values - expected_result)) < 1e-5, "Wrong shape"
 
 
 def test__get_secant_shape():
     theta = np.array([1, 2, 3])
     expected_result = np.array([0.20628208, 0.08460748, 0.03161706])
-    assert np.allclose(BlobShapeImpl._get_secant_shape(theta), expected_result)
+
+    ps = BlobShapeImpl("secant", "secant")
+    values = ps.get_blob_shape_perp(theta)
+    assert np.max(np.abs(values - expected_result)) < 1e-5, "Wrong shape"
 
 
 def test__get_lorentz_shape():
     theta = np.array([1, 2, 3])
     expected_result = np.array([0.15915494, 0.06366198, 0.03183099])
-    assert np.allclose(BlobShapeImpl._get_lorentz_shape(theta), expected_result)
+
+    ps = BlobShapeImpl("lorentz", "lorentz")
+    values = ps.get_blob_shape_perp(theta)
+    assert np.max(np.abs(values - expected_result)) < 1e-5, "Wrong shape"
 
 
 def test__get_dipole_shape():
     theta = np.array([1, 2, 3])
     expected_result = np.array([-0.48394145, -0.21596387, -0.02659109])
-    assert np.allclose(BlobShapeImpl._get_dipole_shape(theta), expected_result)
+
+    ps = BlobShapeImpl("dipole", "dipole")
+    values = ps.get_blob_shape_perp(theta)
+    assert np.max(np.abs(values - expected_result)) < 1e-5, "Wrong shape"