Replace circular.rings by waves.square_radial

stimupy/illusions/circulars.py

@@ -1,128 +1,11 @@
 import numpy as np
 
-from stimupy.components.circulars import square_wave as grating
 from stimupy.utils import resolution, stack_dicts
+from stimupy.waves import square_radial as rings
 
 __all__ = ["rings", "two_sided_rings", "bullseye", "two_sided_bullseye"]
 
 
-def rings(
-    visual_size=None,
-    ppd=None,
-    shape=None,
-    frequency=None,
-    n_rings=None,
-    ring_width=None,
-    phase_shift=0,
-    target_indices=None,
-    intensity_target=0.5,
-    intensity_rings=(1.0, 0.0),
-    intensity_background=0.5,
-    origin="mean",
-    clip=True,
-):
-    """Circular grating, with one or more target rings
-
-    Specification of the number of rings, and their width can be done in two ways:
-    a ring_width (in degrees) and n_rings, and/or by specifying the spatial frequency
-    of a circular grating (in cycles per degree)
-
-    The total shape (in pixels) and visual size (in degrees) has to match the
-    specification of the rings and their widths.
-    Thus, not all 6 parameters (visual_size, ppd, shape, frequency, ring_width, n_rings)
-    have to be specified, as long as both the resolution, and the distribution of rings,
-    can be resolved.
-
-    Note: all rings in a grating have the same width -- if more control is required
-    see disc_and_rings
-
-    Parameters
-    ----------
-    visual_size : Sequence[Number, Number], Number, or None (default)
-        visual size [height, width] of image, in degrees
-    ppd : Sequence[Number, Number], Number, or None (default)
-        pixels per degree [vertical, horizontal]
-    shape : Sequence[Number, Number], Number, or None (default)
-        shape [height, width] of image, in pixels
-    frequency : Number, or None (default)
-        spatial frequency of circular grating, in cycles per degree
-    n_rings : int, or None (default)
-        number of rings
-    ring_width : Number, or None (default)
-        width of a single ring, in degrees
-    phase_shift : float
-        phase shift of grating in degrees
-    target_indices : int or Sequence[int, ] (optional)
-        indices of target discs. If not specified, use middle ring (round down)
-    intensity_target : float (optional)
-        intensity value of target ring(s), by default 0.5
-    intensity_rings : Sequence[Number, ...]
-        intensity value for each ring, from inside to out, by default [1,0]
-        If fewer intensities are passed than number of radii, cycles through intensities
-    intensity_background : float (optional)
-        intensity value of background, by default 0.5
-    origin : "corner", "mean" or "center"
-        if "corner": set origin to upper left corner
-        if "mean": set origin to hypothetical image center (default)
-        if "center": set origin to real center (closest existing value to mean)
-    clip : Bool
-        if True, clip stimulus to image size (default: True)
-
-    Returns
-    -------
-    dict[str, Any]
-        dict with the stimulus (key: "img"),
-        mask with integer index for each target (key: "target_mask"),
-        and additional keys containing stimulus parameters
-
-    References
-    ----------
-    Hong, S. W., and Shevell, S. K. (2004).
-        Brightness contrast and assimilation from patterned inducing backgrounds.
-        Vision Research, 44, 35-43.
-        https://doi.org/10.1016/j.visres.2003.07.010
-    Howe, P. D. L. (2005).
-        White's effect:
-        removing the junctions but preserving the strength of the illusion.
-        Perception, 34, 557-564.
-        https://doi.org/10.1068/p5414
-    """
-
-    # Get stim
-    stim = grating(
-        visual_size=visual_size,
-        ppd=ppd,
-        frequency=frequency,
-        n_rings=n_rings,
-        ring_width=ring_width,
-        phase_shift=phase_shift,
-        intensity_background=intensity_background,
-        intensity_rings=intensity_rings,
-        shape=shape,
-        origin=origin,
-        clip=clip,
-    )
-
-    if isinstance(target_indices, (float, int)):
-        target_indices = [target_indices]
-
-    if target_indices is None:
-        target_indices = [int(stim["ring_mask"].max() / 2)]
-
-    # Add targets
-    stim["target_mask"] = np.zeros(stim["shape"])
-    for i, ring_idx in enumerate(target_indices):
-        stim["img"] = np.where(stim["ring_mask"] == ring_idx + 1, intensity_target, stim["img"])
-        stim["target_mask"] = np.where(stim["ring_mask"] == ring_idx + 1, i + 1, 0).astype(int)
-        if ring_idx > stim["ring_mask"].max() - 1:
-            raise ValueError(f"target idx {ring_idx} is above maximum ring idx")
-
-    # Update stim dict
-    stim["target_indices"] = target_indices
-    stim["intensity_target"] = intensity_target
-    return stim
-
-
 def two_sided_rings(
     visual_size=None,
     ppd=None,
@@ -468,7 +351,7 @@ def two_sided_bullseye(
     from stimupy.utils import plot_stimuli
 
     stims = {
-        "rings": rings(visual_size=(8, 8), ppd=32, frequency=1.0),
+        "rings": rings(visual_size=(8, 8), ppd=32, frequency=1.0, clip=True),
         "two_sided_rings": two_sided_rings(visual_size=(8, 8), ppd=32, frequency=1.0),
         "bullseye": bullseye(visual_size=(8, 8), ppd=32, frequency=1.0),
         "two_sided_bullseye": two_sided_bullseye(visual_size=(8, 16), ppd=32, frequency=1.0),