refactor: rename mask_elements -> mask_regions

computational-psychology · Apr 3, 2023 · 090f0d7 · 090f0d7
1 parent 4f8a889
commit 090f0d7
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/stimupy/components/__init__.py b/stimupy/components/__init__.py
@@ -10,7 +10,7 @@
     "plot_overview",
     "image_base",
     "draw_regions",
-    "mask_elements",
+    "mask_regions",
     "overview",
     "angulars",
     "radials",
@@ -114,7 +114,7 @@ def image_base(visual_size=None, shape=None, ppd=None, rotation=0.0, origin="mea
     }
 
 
-def mask_elements(
+def mask_regions(
     distance_metric,
     edges,
     shape=None,
@@ -232,7 +232,7 @@ def overview(skip=False):
             "plot_overview",
             "draw_regions",
             "image_base",
-            "mask_elements",
+            "mask_regions",
         ]:
             continue
 

diff --git a/stimupy/components/angulars.py b/stimupy/components/angulars.py
@@ -1,6 +1,6 @@
 import numpy as np
 
-from stimupy.components import draw_regions, mask_elements
+from stimupy.components import draw_regions, mask_regions
 from stimupy.components.radials import ring
 
 __all__ = [
@@ -42,7 +42,7 @@ def mask_angle(
         dict with boolean mask (key: bool_mask) for pixels falling in given angle,
         and additional params
     """
-    stim = mask_elements(
+    stim = mask_regions(
         edges=np.deg2rad(angles),
         distance_metric="angular",
         rotation=rotation,
@@ -175,7 +175,7 @@ def mask_segments(
         mask with integer index for each segment (key: "wedge_mask"),
         and additional keys containing stimulus parameters
     """
-    stim = mask_elements(
+    stim = mask_regions(
         distance_metric="angular",
         edges=np.deg2rad(edges),
         rotation=rotation,

diff --git a/stimupy/components/frames.py b/stimupy/components/frames.py
@@ -1,6 +1,6 @@
 import numpy as np
 
-from stimupy.components import draw_regions, mask_elements
+from stimupy.components import draw_regions, mask_regions
 
 __all__ = [
     "frames",
@@ -37,7 +37,7 @@ def mask_frames(
         mask with integer index for each frame (key: "frame_mask"),
         and additional keys containing stimulus parameters
     """
-    stim = mask_elements(
+    stim = mask_regions(
         distance_metric="rectilinear",
         edges=edges,
         rotation=0.0,

diff --git a/stimupy/components/radials.py b/stimupy/components/radials.py
@@ -2,7 +2,7 @@
 
 import numpy as np
 
-from stimupy.components import image_base, mask_elements
+from stimupy.components import image_base, mask_regions
 from stimupy.utils import resolution
 
 __all__ = [
@@ -57,7 +57,7 @@ def mask_rings(
         )
 
     # Mark elements with integer idx-value
-    stim = mask_elements(
+    stim = mask_regions(
         distance_metric="radial",
         edges=radii,
         rotation=0.0,