pytme 0.2.3__cp311-cp311-macosx_14_0_arm64.whl → 0.2.5__cp311-cp311-macosx_14_0_arm64.whl

tme/preprocessing/composable_filter.py

@@ -20,7 +20,6 @@ class ComposableFilter(ABC):
 
         Parameters
         ----------
-
         *args : tuple
             Variable length argument list.
         **kwargs : dict
@@ -28,7 +27,6 @@ class ComposableFilter(ABC):
 
         Returns
         -------
-
         Dict
             A dictionary representing the result of the filtering operation.
         """

tme/preprocessing/compose.py

@@ -17,13 +17,13 @@ class Compose:
     This class allows composing multiple transformations together. Each transformation
     is expected to be a callable that accepts keyword arguments and returns metadata.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     transforms : Tuple[object]
         A tuple containing transformation objects.
 
-    Returns:
-    --------
+    Returns
+    -------
     Dict
         Metadata resulting from the composed transformations.
 

tme/preprocessing/frequency_filters.py

@@ -18,12 +18,10 @@ from ._utils import fftfreqn, crop_real_fourier, shift_fourier, compute_fourier_
 
 class BandPassFilter:
     """
-    This class provides methods to generate bandpass filters in Fourier space,
-    either by directly specifying the frequency cutoffs (discrete_bandpass) or
-    by using Gaussian functions (gaussian_bandpass).
+    Generate bandpass filters in Fourier space.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     lowpass : float, optional
         The lowpass cutoff, defaults to None.
     highpass : float, optional
@@ -67,8 +65,8 @@ class BandPassFilter:
         """
         Generate a bandpass filter using discrete frequency cutoffs.
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         shape : tuple of int
             The shape of the bandpass filter.
         lowpass : float
@@ -84,8 +82,8 @@ class BandPassFilter:
         **kwargs : dict
             Additional keyword arguments.
 
-        Returns:
-        --------
+        Returns
+        -------
         BackendArray
             The bandpass filter in Fourier space.
         """
@@ -98,17 +96,18 @@ class BandPassFilter:
             shape_is_real_fourier=shape_is_real_fourier,
             compute_euclidean_norm=True,
         )
-
-        lowpass = 0 if lowpass is None else lowpass
-        highpass = 1e10 if highpass is None else highpass
+        grid = be.to_backend_array(grid)
+        sampling_rate = be.to_backend_array(sampling_rate)
 
         highcut = grid.max()
-        if lowpass > 0:
-            highcut = np.max(2 * sampling_rate / lowpass)
-        lowcut = np.max(2 * sampling_rate / highpass)
+        if lowpass is not None:
+            highcut = be.max(2 * sampling_rate / lowpass)
 
-        bandpass_filter = ((grid <= highcut) & (grid >= lowcut)) * 1.0
+        lowcut = 0
+        if highpass is not None:
+            lowcut = be.max(2 * sampling_rate / highpass)
 
+        bandpass_filter = ((grid <= highcut) & (grid >= lowcut)) * 1.0
         bandpass_filter = shift_fourier(
             data=bandpass_filter, shape_is_real_fourier=shape_is_real_fourier
         )
@@ -129,10 +128,10 @@ class BandPassFilter:
         **kwargs,
     ) -> BackendArray:
         """
-        Generate a bandpass filter using Gaussian functions.
+        Generate a bandpass filter using Gaussians.
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         shape : tuple of int
             The shape of the bandpass filter.
         lowpass : float
@@ -148,8 +147,8 @@ class BandPassFilter:
         **kwargs : dict
             Additional keyword arguments.
 
-        Returns:
-        --------
+        Returns
+        -------
         BackendArray
             The bandpass filter in Fourier space.
         """
@@ -216,15 +215,13 @@ class BandPassFilter:
 
 class LinearWhiteningFilter:
     """
-    This class provides methods to compute the spectrum of the input data and
-    apply linear whitening to the Fourier coefficients.
+    Compute Fourier power spectrums and perform whitening.
 
-    Parameters:
-    -----------
+    Parameters
+    ----------
     **kwargs : Dict, optional
         Additional keyword arguments.
 
-
     References
     ----------
     .. [1] de Teresa-Trueba, I.; Goetz, S. K.; Mattausch, A.; Stojanovska, F.; Zimmerli, C. E.;
@@ -243,10 +240,10 @@ class LinearWhiteningFilter:
         data_rfft: BackendArray, n_bins: int = None, batch_dimension: int = None
     ) -> Tuple[BackendArray, BackendArray]:
         """
-        Compute the spectrum of the input data.
+        Compute the power spectrum of the input data.
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         data_rfft : BackendArray
             The Fourier transform of the input data.
         n_bins : int, optional
@@ -254,8 +251,8 @@ class LinearWhiteningFilter:
         batch_dimension : int, optional
             Batch dimension to average over.
 
-        Returns:
-        --------
+        Returns
+        -------
         bins : BackendArray
             Array containing the bin indices for the spectrum.
         radial_averages : BackendArray
@@ -330,8 +327,8 @@ class LinearWhiteningFilter:
         """
         Apply linear whitening to the data and return the result.
 
-        Parameters:
-        -----------
+        Parameters
+        ----------
         data : BackendArray, optional
             The input data, defaults to None.
         data_rfft : BackendArray, optional
@@ -345,8 +342,8 @@ class LinearWhiteningFilter:
         **kwargs : Dict
             Additional keyword arguments.
 
-        Returns:
-        --------
+        Returns
+        -------
         Dict
            Filter data and associated parameters.
         """