Update default dtype parameters in check_1d_arrays decorator, and allow None type

Author: PierreRaybaut

sigima/tools/checks.py

@@ -16,11 +16,11 @@ def check_1d_arrays(
     func: Callable[..., Any] | None = None,
     *,
     x_1d: bool = True,
-    x_dtype: type = np.floating,
+    x_dtype: type | None = np.floating,  # Default to floating point types
     x_sorted: bool = False,
     x_evenly_spaced: bool = False,
     y_1d: bool = True,
-    y_dtype: type = np.floating,
+    y_dtype: type | None = np.inexact,  # Default to inexact types (float or complex)
     x_y_same_size: bool = True,
     rtol: float = 1e-5,
 ) -> Callable:
@@ -65,7 +65,7 @@ def wrapper(x: np.ndarray, y: np.ndarray, *args: Any, **kwargs: Any) -> Any:
             # === Check x array
             if x_1d and x.ndim != 1:
                 raise ValueError("x must be 1-D.")
-            if not np.issubdtype(x.dtype, x_dtype):
+            if x_dtype is not None and not np.issubdtype(x.dtype, x_dtype):
                 raise TypeError(f"x must be of type {x_dtype}, but got {x.dtype}.")
             if x_sorted and x.size > 1 and not np.all(np.diff(x) >= 0.0):
                 raise ValueError("x must be sorted in ascending order.")
@@ -76,7 +76,7 @@ def wrapper(x: np.ndarray, y: np.ndarray, *args: Any, **kwargs: Any) -> Any:
             # === Check y array
             if y_1d and y.ndim != 1:
                 raise ValueError("y must be 1-D.")
-            if not np.issubdtype(y.dtype, y_dtype):
+            if y_dtype is not None and not np.issubdtype(y.dtype, y_dtype):
                 raise TypeError(f"y must be of type {y_dtype}, but got {y.dtype}.")
             if x_y_same_size and x.size != y.size:
                 raise ValueError("x and y must have the same size.")

sigima/tools/signal/fourier.py

@@ -46,7 +46,7 @@ def zero_padding(
     return xnew, ynew
 
 
-@check_1d_arrays(x_dtype=np.inexact, x_evenly_spaced=True, y_dtype=np.inexact)
+@check_1d_arrays(x_evenly_spaced=True)
 def fft1d(
     x: np.ndarray, y: np.ndarray, shift: bool = True
 ) -> tuple[np.ndarray, np.ndarray]:
@@ -70,12 +70,7 @@ def fft1d(
     return f, sp
 
 
-@check_1d_arrays(
-    x_dtype=np.inexact,
-    x_sorted=False,
-    x_evenly_spaced=False,
-    y_dtype=np.complexfloating,
-)
+@check_1d_arrays(x_evenly_spaced=False, x_sorted=False, y_dtype=np.complexfloating)
 def ifft1d(
     f: np.ndarray, sp: np.ndarray, initial: float = 0.0
 ) -> tuple[np.ndarray, np.ndarray]:
@@ -116,7 +111,7 @@ def ifft1d(
     return x, y.real
 
 
-@check_1d_arrays(x_dtype=np.inexact, x_evenly_spaced=True, y_dtype=np.inexact)
+@check_1d_arrays(x_evenly_spaced=True)
 def magnitude_spectrum(
     x: np.ndarray, y: np.ndarray, log_scale: bool = False
 ) -> tuple[np.ndarray, np.ndarray]:
@@ -138,7 +133,7 @@ def magnitude_spectrum(
     return x1, y_mag
 
 
-@check_1d_arrays(x_dtype=np.inexact, x_evenly_spaced=True, y_dtype=np.inexact)
+@check_1d_arrays(x_evenly_spaced=True)
 def phase_spectrum(x: np.ndarray, y: np.ndarray) -> tuple[np.ndarray, np.ndarray]:
     """Compute phase spectrum.
 
@@ -154,7 +149,7 @@ def phase_spectrum(x: np.ndarray, y: np.ndarray) -> tuple[np.ndarray, np.ndarray
     return x1, y_phase
 
 
-@check_1d_arrays(x_dtype=np.inexact, x_evenly_spaced=True, y_dtype=np.inexact)
+@check_1d_arrays(x_evenly_spaced=True)
 def psd(
     x: np.ndarray, y: np.ndarray, log_scale: bool = False
 ) -> tuple[np.ndarray, np.ndarray]:
@@ -189,6 +184,7 @@ def sort_frequencies(x: np.ndarray, y: np.ndarray) -> np.ndarray:
     return freqs[np.argsort(fourier)]
 
 
+@check_1d_arrays(x_evenly_spaced=True)
 def brickwall_filter(
     x: np.ndarray,
     y: np.ndarray,