Rename to stimuli.utils.resolution

stimuli/utils/sizes.py → stimuli/utils/resolution.py

@@ -43,6 +43,8 @@ def valid_resolution(shape, visual_size, ppd):
     ppd = validate_ppd(ppd)
     visual_size = validate_visual_size(visual_size)
 
+    # TODO: error is one input is None
+
     calculated = shape_from_visual_size_ppd(visual_size=visual_size, ppd=ppd)
     if calculated != shape:
         raise ResolutionError(f"Invalid resolution; {visual_size},{shape},{ppd}")
@@ -73,6 +75,8 @@ def shape_from_visual_size_ppd(visual_size, ppd):
     visual_size = validate_visual_size(visual_size)
     ppd = validate_ppd(ppd)
 
+    # TODO: error if one input is None?
+
     # Calculate width and height in pixels
     if visual_size.width is not None and ppd.horizontal is not None:
         width = visual_size.width * ppd.horizontal

tests/test_resolve.py

@@ -1,5 +1,5 @@
 import pytest
-from stimuli.utils import sizes
+from stimuli.utils import resolution
 
 
 @pytest.mark.parametrize(
@@ -15,7 +15,7 @@
     ),
 )
 def test_pass_valid_resolution(shape, visual_size, ppd):
-    sizes.valid_resolution(shape=shape, visual_size=visual_size, ppd=ppd)
+    resolution.valid_resolution(shape=shape, visual_size=visual_size, ppd=ppd)
 
 
 @pytest.mark.parametrize(
@@ -32,7 +32,7 @@ def test_pass_valid_resolution(shape, visual_size, ppd):
 )
 def test_raises_valid_resolution(shape, visual_size, ppd):
     with pytest.raises(ValueError) as e_info:
-        sizes.valid_resolution(shape=shape, visual_size=visual_size, ppd=ppd)
+        resolution.valid_resolution(shape=shape, visual_size=visual_size, ppd=ppd)
 
 
 def test_resolve():

tests/test_resolve_resolutions.py

@@ -1,6 +1,6 @@
 import numpy as np
 import pytest
-from stimuli.utils import sizes
+from stimuli.utils import resolution
 
 
 #############################
@@ -20,7 +20,7 @@
     ],
 )
 def test_ppd_from_shape_visual_size(shape, visual_size, ppd):
-    out = sizes.ppd_from_shape_visual_size(shape, visual_size)
+    out = resolution.ppd_from_shape_visual_size(shape, visual_size)
     assert out.horizontal == ppd[1] and out.vertical == ppd[0]
 
 
@@ -41,7 +41,7 @@ def test_ppd_from_shape_visual_size(shape, visual_size, ppd):
     ],
 )
 def test_shape_from_visual_size_ppd(visual_size, ppd, shape):
-    out = sizes.shape_from_visual_size_ppd(visual_size, ppd)
+    out = resolution.shape_from_visual_size_ppd(visual_size, ppd)
     assert out.height == shape[0] and out.width == shape[1]
 
 
@@ -62,5 +62,5 @@ def test_shape_from_visual_size_ppd(visual_size, ppd, shape):
     ],
 )
 def test_visual_size_from_shape_ppd(visual_size, ppd, shape):
-    out = sizes.visual_size_from_shape_ppd(shape=shape, ppd=ppd)
+    out = resolution.visual_size_from_shape_ppd(shape=shape, ppd=ppd)
     assert out.height == visual_size[0] and out.width == visual_size[1]

tests/test_validate_resolutions.py

@@ -1,6 +1,6 @@
 import numpy as np
 import pytest
-from stimuli.utils import sizes
+from stimuli.utils import resolution
 
 
 #############################
@@ -22,7 +22,7 @@
     ],
 )
 def test_validate_visual_size(visual_size, expected):
-    out = sizes.validate_visual_size(visual_size)
+    out = resolution.validate_visual_size(visual_size)
     assert out.width == expected[1] and out.height == expected[0]
 
 
@@ -38,7 +38,7 @@ def test_validate_visual_size(visual_size, expected):
 )
 def test_raises_visual_size(visual_size, exception):
     with pytest.raises(exception) as e_info:
-        sizes.validate_visual_size(visual_size)
+        resolution.validate_visual_size(visual_size)
 
 
 #############################
@@ -54,10 +54,11 @@ def test_raises_visual_size(visual_size, exception):
         ("32", (32, 32)),
         ((16, "32"), (16, 32)),
         (("16", "32"), (16, 32)),
+        # Add None cases
     ],
 )
 def test_validate_shape(shape, expected):
-    out = sizes.validate_shape(shape)
+    out = resolution.validate_shape(shape)
     assert out.width == expected[1] and out.height == expected[0]
 
 
@@ -73,7 +74,7 @@ def test_validate_shape(shape, expected):
 )
 def test_raises_shape(shape, exception):
     with pytest.raises(exception) as e_info:
-        sizes.validate_shape(shape)
+        resolution.validate_shape(shape)
 
 
 ############################
@@ -89,10 +90,11 @@ def test_raises_shape(shape, exception):
         ("32", (32, 32)),
         ((16, "32"), (16, 32)),
         (("16", "32"), (16, 32)),
+        # Add None cases
     ],
 )
 def test_validate_ppd(ppd, expected):
-    out = sizes.validate_ppd(ppd)
+    out = resolution.validate_ppd(ppd)
     assert out.horizontal == expected[1] and out.vertical == expected[0]
 
 
@@ -108,4 +110,4 @@ def test_validate_ppd(ppd, expected):
 )
 def test_raises_ppd(ppd, exception):
     with pytest.raises(exception) as e_info:
-        sizes.validate_ppd(ppd)
+        resolution.validate_ppd(ppd)