Partial updates for new method names.

Author: mkelley

sbpy/surfaces/scattered.py

@@ -10,26 +10,7 @@
 from ..units.typing import SpectralQuantity, SpectralFluxDensityQuantity, UnitLike
 
 
-class ScatteredLight(Surface):
-    """Abstract base class to observe light scattered by a surface."""
-
-    @u.quantity_input
-    def radiance(
-        self,
-        F_i: SpectralFluxDensityQuantity,
-        i: u.physical.angle,
-        e: u.physical.angle,
-        phi: u.physical.angle,
-    ) -> u.Quantity:
-        """Observed light reflected from a surface."""
-        return F_i * self.reflectance(i, e, phi) / u.sr
-
-    radiance.__doc__ += Surface.radiance.__doc__[
-        Surface.radiance.__doc__.index("\n") :  # noqa: E203
-    ]
-
-
-class ScatteredSunlight(ScatteredLight):
+class ScatteredSunlight(Surface):
     """Abstract base class to observe sunlight scattered by a surface."""
 
     @u.quantity_input
@@ -82,7 +63,7 @@ def scattered_sunlight(
             F_i = sun.observe(wave_freq, unit=flux_density_unit)
 
         F_i /= rh.to_value("au") ** 2
-        return self.radiance(F_i, i, e, phi).to(unit)
+        return self.reflectance(F_i, i, e, phi).to(unit)
 
     @u.quantity_input
     def scattered_sunlight_from_vectors(

sbpy/surfaces/surface.py

@@ -39,7 +39,11 @@ def _min_zero_cos(a: u.physical.angle) -> u.Quantity:
         return np.maximum(x, 0)
 
     @abstractmethod
-    def absorptance(self, i: u.physical.angle) -> u.Quantity:
+    def absorbed_radiance(
+        self,
+        F_i: SpectralFluxDensityQuantity,
+        i: u.physical.angle,
+    ) -> u.Quantity:
         r"""Absorption of incident light.
 
         The surface is illuminated by incident flux density, :math:`F_i`, at an
@@ -48,6 +52,9 @@ def absorptance(self, i: u.physical.angle) -> u.Quantity:
 
         Parameters
         ----------
+        F_i : `astropy.units.Quantity`
+            Incident light (spectral flux density).
+
         i : `~astropy.units.Quantity`
             Angle from normal of incident light.
 
@@ -60,7 +67,12 @@ def absorptance(self, i: u.physical.angle) -> u.Quantity:
         """
 
     @abstractmethod
-    def emittance(self, e: u.physical.angle, phi: u.physical.angle) -> u.Quantity:
+    def emitted_radiance(
+        self,
+        F_e: SpectralFluxDensityQuantity,
+        e: u.physical.angle,
+        phi: u.physical.angle,
+    ) -> u.Quantity:
         r"""Emission of light.
 
         The surface is observed at an angle of :math:`e`, measured from the
@@ -69,8 +81,11 @@ def emittance(self, e: u.physical.angle, phi: u.physical.angle) -> u.Quantity:
 
         Parameters
         ----------
+        F_e : `astropy.units.Quantity`
+            Spectral emittance (spectral flux density).
+
         e : `~astropy.units.Quantity`
-            Angle from normal of emitted light.
+            Observed angle from normal.
 
         phi : `~astropy.units.Quantity`
             Source-target-observer (phase) angle.
@@ -96,36 +111,6 @@ def reflectance(
         emitted light are assumed to be collimated.
 
 
-        Parameters
-        ----------
-        i : `~astropy.units.Quantity`
-            Angle from normal of incident light.
-
-        e : `~astropy.units.Quantity`
-            Angle from normal of emitted light.
-
-        phi : `~astropy.units.Quantity`
-            Source-target-observer (phase) angle.
-
-
-        Returns
-        -------
-        r : `~astropy.units.Quantity`
-            Surface reflectance.
-
-        """
-
-    @abstractmethod
-    def radiance(
-        self,
-        F_i: SpectralFluxDensityQuantity,
-        i: u.physical.angle,
-        e: u.physical.angle,
-        phi: u.physical.angle,
-    ) -> u.Quantity:
-        """Observed radiance from a surface.
-
-
         Parameters
         ----------
         F_i : `astropy.units.Quantity`
@@ -143,8 +128,8 @@ def radiance(
 
         Returns
         -------
-        radiance : `~astropy.units.Quantity`
-            Observed radiance.
+        r : `~astropy.units.Quantity`
+            Surface reflectance.
 
         """
 
@@ -165,14 +150,14 @@ def _vectors_to_angles(
         return i, e, phi
 
     @u.quantity_input
-    def radiance_from_vectors(
+    def reflectance_from_vectors(
         self,
         F_i: SpectralFluxDensityQuantity,
         n: np.ndarray,
         rs: u.physical.length,
         ro: np.ndarray,
     ) -> u.Quantity:
-        """Observed radiance from a surface with geometry defined by vectors.
+        """Vector based alternative to reflectance().
 
         Input vectors do not need to be normalized.
 
@@ -194,9 +179,9 @@ def radiance_from_vectors(
 
         Returns
         -------
-        radiance : `~astropy.units.Quantity`
-            Observed radiance.
+        reflectance : `~astropy.units.Quantity`
+            Reflectance.
 
         """
 
-        return self.radiance(F_i, *self._vectors_to_angles(n, rs, ro))
+        return self.reflectance(F_i, *self._vectors_to_angles(n, rs, ro))