Move the vignetting models into optika.radiometry

optika/__init__.py

@@ -18,7 +18,6 @@
 from . import surfaces
 from . import sensors
 from . import distortion
-from . import vignetting
 from . import radiometry
 from . import systems
 
@@ -41,7 +40,6 @@
     "surfaces",
     "sensors",
     "distortion",
-    "vignetting",
     "radiometry",
     "systems",
 ]

optika/radiometry/__init__.py

@@ -4,8 +4,16 @@
     AbstractEffectiveAreaModel,
     InterpolatedEffectiveAreaModel,
 )
+from ._vignetting import (
+    AbstractVignettingModel,
+    AbstractInterpolatedVignettingModel,
+    PolynomialVignettingModel,
+)
 
 __all__ = [
     "AbstractEffectiveAreaModel",
     "InterpolatedEffectiveAreaModel",
+    "AbstractVignettingModel",
+    "AbstractInterpolatedVignettingModel",
+    "PolynomialVignettingModel",
 ]

optika/vignetting/_vignetting.py → optika/radiometry/_vignetting.py

@@ -128,7 +128,7 @@ class PolynomialVignettingModel(
         )
         illumination = 1 - 0.1 * (scene.position.length / u.deg) ** 2
 
-        model = optika.vignetting.PolynomialVignettingModel(
+        model = optika.radiometry.PolynomialVignettingModel(
             coordinates_scene=scene,
             illumination=illumination,
             axis_wavelength="wavelength",

optika/vignetting/_vignetting_test.py → optika/radiometry/_vignetting_test.py

@@ -27,14 +27,14 @@ def _illumination() -> na.AbstractScalar:
 class AbstractTestAbstractVignettingModel(
     test_mixins.AbstractTestPrintable,
 ):
-    def test__call__(self, a: optika.vignetting.AbstractVignettingModel):
+    def test__call__(self, a: optika.radiometry.AbstractVignettingModel):
         scene = _scene()
         result = a(scene)
         assert isinstance(result, na.AbstractScalar)
         for ax in ("field_x", "field_y"):
             assert ax in na.shape(result)
 
-    def test_inverse(self, a: optika.vignetting.AbstractVignettingModel):
+    def test_inverse(self, a: optika.radiometry.AbstractVignettingModel):
         scene = _scene()
         result = a.inverse(scene)
         assert isinstance(result, na.AbstractScalar)
@@ -46,25 +46,25 @@ class AbstractTestAbstractInterpolatedVignettingModel(
 ):
     def test_coordinates_scene(
         self,
-        a: optika.vignetting.AbstractInterpolatedVignettingModel,
+        a: optika.radiometry.AbstractInterpolatedVignettingModel,
     ):
         assert isinstance(a.coordinates_scene, na.AbstractSpectralPositionalVectorArray)
 
     def test_illumination(
         self,
-        a: optika.vignetting.AbstractInterpolatedVignettingModel,
+        a: optika.radiometry.AbstractInterpolatedVignettingModel,
     ):
         assert isinstance(a.illumination, na.AbstractScalar)
 
     def test_axis_wavelength(
         self,
-        a: optika.vignetting.AbstractInterpolatedVignettingModel,
+        a: optika.radiometry.AbstractInterpolatedVignettingModel,
     ):
         assert isinstance(a.axis_wavelength, str)
 
     def test_axis_field(
         self,
-        a: optika.vignetting.AbstractInterpolatedVignettingModel,
+        a: optika.radiometry.AbstractInterpolatedVignettingModel,
     ):
         assert isinstance(a.axis_field, tuple)
         assert all(isinstance(ax, str) for ax in a.axis_field)
@@ -73,7 +73,7 @@ def test_axis_field(
 @pytest.mark.parametrize(
     argnames="a",
     argvalues=[
-        optika.vignetting.PolynomialVignettingModel(
+        optika.radiometry.PolynomialVignettingModel(
             coordinates_scene=_scene(),
             illumination=_illumination(),
             axis_wavelength="wavelength",
@@ -86,7 +86,7 @@ def test_axis_field(
 class TestPolynomialVignettingModel(
     AbstractTestAbstractInterpolatedVignettingModel,
 ):
-    def test_fit(self, a: optika.vignetting.PolynomialVignettingModel):
+    def test_fit(self, a: optika.radiometry.PolynomialVignettingModel):
         assert isinstance(a.fit, na.PolynomialFitFunctionArray)
         assert a.fit.degree == a.degree
 
@@ -99,7 +99,7 @@ def test_fit(self, a: optika.vignetting.PolynomialVignettingModel):
     )
     def test_plot(
         self,
-        a: optika.vignetting.PolynomialVignettingModel,
+        a: optika.radiometry.PolynomialVignettingModel,
         kwargs: dict,
     ):
         fig, ax = a.plot(**kwargs)
@@ -117,7 +117,7 @@ def test_plot(
     )
     def test_plot_residual(
         self,
-        a: optika.vignetting.PolynomialVignettingModel,
+        a: optika.radiometry.PolynomialVignettingModel,
         kwargs: dict,
     ):
         fig, ax = a.plot_residual(**kwargs)