Delbeouf as toplevel stimulus module

computational-psychology · Mar 21, 2023 · db64171 · db64171
1 parent b287e95
commit db64171
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 13 deletions.
diff --git a/stimupy/__init__.py b/stimupy/__init__.py
@@ -4,6 +4,7 @@
     benarys,
     components,
     cubes,
+    delboeufs,
     dungeons,
     gabors,
     hermanns,

diff --git a/stimupy/illusions/delboeufs.py → stimupy/delboeufs.py b/stimupy/illusions/delboeufs.py → stimupy/delboeufs.py
@@ -178,17 +178,32 @@ def two_sided(
     return stim
 
 
-if __name__ == "__main__":
-    from stimupy.utils import plot_stimuli
+def overview(**kwargs):
+    """Generate example stimuli from this module
 
-    p1 = {
-        "visual_size": (10, 20),
+    Returns
+    -------
+    stims : dict
+        dict with all stimuli containing individual stimulus dicts.
+    """
+    default_params = {
+        "visual_size": (10, 10),
         "ppd": 30,
-        "target_radius": 2,
     }
+    default_params.update(kwargs)
 
-    stims = {
-        "single": delboeuf(**p1, outer_radius=4),
-        "two_sided": two_sided(**p1, outer_radii=(4, 2.5)),
+    # fmt: off
+    stimuli = {
+        "Mueller-Lyer illusion": delboeuf(**default_params, target_radius=1, outer_radius=4),
+        "Mueller-Lyer, two-sided": two_sided(**default_params, target_radius=1, outer_radii=(2, 1.1)),
     }
-    plot_stimuli(stims, mask=False, save=None)
+    # fmt: on
+
+    return stimuli
+
+
+if __name__ == "__main__":
+    from stimupy.utils import plot_stimuli
+
+    stims = overview()
+    plot_stimuli(stims, mask=True, save=None)
diff --git a/stimupy/illusions/__init__.py b/stimupy/illusions/__init__.py
@@ -1,4 +1,4 @@
-from . import angulars, checkerboards, circulars, cornsweets, delboeufs, frames, gratings
+from . import angulars, checkerboards, circulars, cornsweets, frames, gratings
 
 
 def create_overview():
@@ -36,9 +36,6 @@ def create_overview():
         "circular_bullseye_two_sided": circulars.two_sided_bullseye(**p, frequency=1.0),
         # Cornsweet
         "cornsweet": cornsweets.cornsweet(**p, ramp_width=3),
-        # Delbouef
-        "delboeuf": delboeufs.delboeuf(**p, outer_radius=4, target_radius=1),
-        "2sided_delboeuf": delboeufs.two_sided(**p, outer_radii=(2, 1.1), target_radius=1),
         # Frames
         "frames": frames.rings(**p, frequency=0.5, target_indices=3),
         "frames_general": frames.rings_generalized(**p, radii=(1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5), target_indices=3),