Added esis.optics.Sensor class. (#17)

Author: roytsmart

docs/conf.py

@@ -113,4 +113,5 @@
     'astropy': ('https://docs.astropy.org/en/stable/', None),
     'named_arrays': ('https://named-arrays.readthedocs.io/en/stable/', None),
     'optika': ('https://optika.readthedocs.io/en/stable/', None),
+    'msfc_ccd': ('https://msfc-ccd.readthedocs.io/en/stable/', None),
 }

esis/optics/__init__.py

@@ -8,6 +8,7 @@
 from ._field_stops import FieldStop
 from ._gratings import Grating
 from ._filters import Filter
+from ._sensors import Sensor
 
 __all__ = [
     "abc",
@@ -18,4 +19,5 @@
     "FieldStop",
     "Grating",
     "Filter",
+    "Sensor",
 ]

esis/optics/_sensors/__init__.py

@@ -0,0 +1,5 @@
+from ._sensors import Sensor
+
+__all__ = [
+    "Sensor",
+]

esis/optics/_sensors/_sensors.py

@@ -0,0 +1,44 @@
+import dataclasses
+import astropy.units as u
+import named_arrays as na
+import optika
+import msfc_ccd
+from .. import mixins
+
+__all__ = [
+    "Sensor",
+]
+
+
+@dataclasses.dataclass(repr=False)
+class Sensor(
+    optika.mixins.Printable,
+    optika.mixins.Rollable,
+    optika.mixins.Yawable,
+    optika.mixins.Pitchable,
+    optika.mixins.Translatable,
+    mixins.CylindricallyTransformable,
+    msfc_ccd.TeledyneCCD230,
+):
+    """A model of the CCD sensors used to detect light."""
+
+    distance_radial: u.Quantity | na.AbstractScalar = 0 * u.mm
+    """The distance between the axis of symmetry and the center of the detector."""
+
+    azimuth: u.Quantity | na.AbstractScalar = 0 * u.deg
+    """The angle that the detector has been rotated about the axis of symmetry."""
+
+    translation: u.Quantity | na.AbstractCartesian3dVectorArray = 0 * u.mm
+    """An additional translation vector."""
+
+    pitch: u.Quantity | na.AbstractScalar = 0 * u.deg
+    """The pitch angle of this sensor."""
+
+    yaw: u.Quantity | na.AbstractScalar = 0 * u.deg
+    """The yaw angle of this sensor."""
+
+    roll: u.Quantity | na.AbstractScalar = 0 * u.deg
+    """The roll angle of this sensor."""
+
+    position_image: u.Quantity | na.AbstractCartesian2dVectorArray = 0 * u.mm
+    """The position of the center of the FOV on the sensor for the target wavelength."""

esis/optics/_sensors/_sensors_test.py

@@ -0,0 +1,13 @@
+import pytest
+from msfc_ccd._tests.test_sensors import AbstractTestAbstractSensor
+import esis
+
+
+@pytest.mark.parametrize(
+    argnames="sensor",
+    argvalues=[
+        esis.optics.Sensor(),
+    ],
+)
+class TestSensor(AbstractTestAbstractSensor):
+    pass

pyproject.toml

@@ -18,7 +18,7 @@ dependencies = [
     "matplotlib",
     "astropy",
     "optika>=0.12.0",
-    "msfc-ccd>=0.2.0",
+    "msfc-ccd>=0.3.0",
     "aastex>=0.3.1",
 ]
 dynamic = ["version"]