removed old sbc function and added docstring

stimuli/illusions/sbc.py

@@ -1,70 +1,37 @@
-import numpy as np
-import stimuli
-from stimuli.utils import pad_img, plot_stim
+from stimuli.utils import plot_stim
 from stimuli.components import rectangle
 
 
-def simultaneous_brightness_contrast(
-    ppd=10,
-    target_shape=(5, 5),
-    inner_padding=(3, 3, 3, 3),
-    left=1.0,
-    right=0.0,
-    target=0.5,
-):
+def simultaneous_contrast(
+        ppd=10,
+        im_size=(4., 4.),
+        target_size=(2., 2.),
+        target_pos=(1., 1.),
+        vback=0.,
+        vtarget=0.5
+        ):
     """
-    Simultaneous brightness contrast
+    Simultaneous contrast stimulus
 
     Parameters
     ----------
     ppd : int
         pixels per degree (visual angle)
-    target shape : (float, float)
-        target shape in degrees visual angle (height, width)
-    padding : (float, float, float, float)
-        4-valued tuple specifying outer padding (top, bottom, left, right) in degrees visual angle
-    inner_padding:
-        4-valued tuple specifying inner padding (top, bottom, left, right) in degrees visual angle
-    left : float
-        left background value
-    right : float
-        right background value
-    target : float
-        target value
+    im_size : (float, float)
+        size of the image in degree visual angle
+    target_size : (float, float)
+        size of the target in degree visual angle
+    target_pos : (float, float)
+        coordinates of the target in degree visual angle
+    vback : float
+        value for background
+    vtarget : float
+        value for target
 
     Returns
     -------
-    A stimulus object
+    A stimulus dictionary with the stimulus ['img'] and target mask ['mask']
     """
-
-    target_height, target_width = target_shape
-
-    target_height_px, target_width_px = stimuli.utils.degrees_to_pixels(
-        target_shape, ppd
-    )
-
-    img = np.ones((target_height_px, target_width_px)) * target
-    mask = np.ones((target_height_px, target_width_px))
-
-    img1 = pad_img(img, inner_padding, ppd, left)
-    img2 = pad_img(img, inner_padding, ppd, right)
-    img = np.hstack((img1, img2))
-
-    mask1 = pad_img(mask, inner_padding, ppd, 0)
-    mask2 = pad_img(mask, inner_padding, ppd, 0)
-    mask = np.hstack((mask1, mask2 * 2))
-
-    return {"img": img, "mask": mask}
-
-
-def simultaneous_contrast(
-        ppd=10,
-        im_size=(4., 4.),
-        target_size=(2., 2.),
-        target_pos=(1., 1.),
-        vback=0.,
-        vtarget=0.5
-        ):
     img = rectangle(ppd, im_size, target_size, target_pos, vback, vtarget)
     mask = rectangle(ppd, im_size, target_size, target_pos, 0, 1)
     return {"img": img, "mask": mask}