Rename confusing variable. The clipping is for NOT fast

Author: viljarjf

diffsims/simulations/simulation2d.py

@@ -353,7 +353,7 @@ def get_diffraction_pattern(
         mirrored: bool = False,
         fast: bool = True,
         normalize: bool = True,
-        fast_clip_threshold: float = 1,
+        clip_threshold: float = 1,
     ):
         """Returns the diffraction data as a numpy array with
         two-dimensional Gaussians representing each diffracted peak. Should only
@@ -377,7 +377,7 @@ def get_diffraction_pattern(
             Whether to speed up calculations by rounding spot coordinates down to integer pixel
         normalize: bool, optional
             Whether to normalize the pattern to values between 0 and 1
-        fast_clip_threshold: float, optional
+        clip_threshold: float, optional
             Only used when `fast` is False.
             Pixel intensity threshold, such that pixels which would be below this value are ignored.
             Thresholding performed before possible normalization.
@@ -424,7 +424,7 @@ def get_diffraction_pattern(
             return np.zeros(shape)
 
         pattern = get_pattern_from_pixel_coordinates_and_intensities(
-            spot_coords, spot_intens, shape, sigma, fast_clip_threshold
+            spot_coords, spot_intens, shape, sigma, clip_threshold
         )
         if normalize:
             pattern = np.divide(pattern, np.max(pattern))

diffsims/tests/simulations/test_simulations2d.py

@@ -141,7 +141,7 @@ def test_get_diffraction_pattern_fast_vs_slow(self, al_phase):
             sigma=1,
             calibration=1,
             normalize=False,
-            fast_clip_threshold=0.01,
+            clip_threshold=0.01,
         )
         # Check that fast/slow are the same when coordinates are dtype int
         fast = int_sim.get_diffraction_pattern(fast=True, **sim_kwargs)
@@ -153,7 +153,7 @@ def test_get_diffraction_pattern_fast_vs_slow(self, al_phase):
         float_fast = float_sim.get_diffraction_pattern(fast=True, **sim_kwargs)
         float_slow = float_sim.get_diffraction_pattern(fast=False, **sim_kwargs)
         assert np.allclose(float_fast, fast)
-        assert np.all((float_slow - float_fast) < sim_kwargs["fast_clip_threshold"])
+        assert np.all((float_slow - float_fast) < sim_kwargs["clip_threshold"])
 
         # Change the size, now the center is between pixels.
         # Slow should reflect this