Refactor ffs_shift operations.

examples/convolve_2d.py

@@ -1,5 +1,5 @@
 import numpy as np
-from pyffs import ffsn_sample, iffsn_shift
+from pyffs import ffsn_sample, iffs_shift
 from pyffs.func import dirichlet_2D
 from scipy.signal import convolve2d as convolve_scipy
 from scipy.signal import fftconvolve
@@ -41,7 +41,7 @@
 sample_points_y = np.squeeze(sample_points[1])
 idx_x = np.squeeze(idx[0])
 idx_y = np.squeeze(idx[1])
-diric_samples_ord = iffsn_shift(diric_samples) if not reorder else diric_samples
+diric_samples_ord = iffs_shift(diric_samples) if not reorder else diric_samples
 
 output_scipy = (
     convolve_scipy(diric_samples_ord, diric_samples_ord, mode="full", boundary="fill")
@@ -126,7 +126,7 @@
 ax = plot2d(
     x_vals=sample_points_x[idx_x],
     y_vals=sample_points_y[idx_y],
-    Z=np.real(iffsn_shift(output_samples)) if not reorder else np.real(output_samples),
+    Z=np.real(iffs_shift(output_samples)) if not reorder else np.real(output_samples),
     pcolormesh=pcolormesh,
     colorbar=False,
 )

profile/convolve2d.py

@@ -4,7 +4,7 @@
 import matplotlib.pyplot as plt
 import numpy as np
 from util import comparison_plot, plotting_setup
-from pyffs import ffsn_sample, convolve, iffsn_shift
+from pyffs import ffsn_sample, convolve, iffs_shift
 from pyffs.func import dirichlet_2D
 from scipy.signal import convolve2d as convolve_scipy
 
@@ -47,7 +47,7 @@ def profile_ffsn(n_trials):
         print("-- {} : {} seconds".format(_key, proc_time[_N_S][_key]))
 
         # SciPy
-        diric_samples_ord = iffsn_shift(diric_samples)
+        diric_samples_ord = iffs_shift(diric_samples)
         _key = "scipy.signal.convolve2d (wrap)"
         timings = []
         for _ in range(n_trials):

pyffs/conv.py

@@ -8,7 +8,7 @@
 
 import numpy as np
 from pyffs.ffs import ffsn, iffsn
-from pyffs.util import ffsn_shift, iffsn_shift, _verify_ffsn_input
+from pyffs.util import ffs_shift, iffs_shift, _verify_ffsn_input
 from pyffs.backend import get_array_module
 
 
@@ -77,8 +77,8 @@ def convolve(f, h, T, T_c, N_FS, return_coef=False, reorder=True, axes=None):
 
     # reorder samples
     if reorder:
-        f = ffsn_shift(f)
-        h = ffsn_shift(h)
+        f = ffs_shift(f)
+        h = ffs_shift(h)
 
     F = ffsn(f, T, T_c, N_FS, axes=axes)
     H = ffsn(h, T, T_c, N_FS, axes=axes)
@@ -87,6 +87,6 @@ def convolve(f, h, T, T_c, N_FS, return_coef=False, reorder=True, axes=None):
     else:
         output_samples = iffsn(F * H, T=T, T_c=T_c, N_FS=N_FS, axes=axes)
         if reorder:
-            output_samples = iffsn_shift(output_samples)
+            output_samples = iffs_shift(output_samples)
 
         return output_samples

pyffs/util.py

@@ -382,7 +382,7 @@ def ffsn_sample(T, N_FS, T_c, N_s, mod=None):
     return sample_points, idx
 
 
-def ffsn_shift(x):
+def ffs_shift(x):
     """
     Reorder an input to order expected by :py:func:`~pyffs.ffs.ffsn`.
 
@@ -400,10 +400,10 @@ def ffsn_shift(x):
     return np.fft.ifftshift(x)
 
 
-def iffsn_shift(x):
+def iffs_shift(x):
     """
-    Inverse of :py:func:`~pyffs.util.ffsn_shift` Reorder input to natural order
-    after shifting with :py:func:`~pyffs.util.ffsn_shift`.
+    Inverse of :py:func:`~pyffs.util.ffs_shift` Reorder input to natural order
+    after shifting with :py:func:`~pyffs.util.ffs_shift`.
 
     Parameters
     ----------