Renamed optika.systems.AbstractSequentialSystem.rayfunction to `ray…

…function_default`. (#27)
sun-data · May 15, 2024 · 93dd7cd · 93dd7cd
1 parent 19c9b58
commit 93dd7cd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/optika/_tests/test_systems.py b/optika/_tests/test_systems.py
@@ -94,8 +94,8 @@ def test_raytrace(
         assert isinstance(raytrace.outputs, optika.rays.RayVectorArray)
         assert a.axis_surface in raytrace.shape
 
-    def test_rayfunction(self, a: optika.systems.AbstractSequentialSystem):
-        rayfunction = a.rayfunction
+    def test_rayfunction_default(self, a: optika.systems.AbstractSequentialSystem):
+        rayfunction = a.rayfunction_default
         assert isinstance(rayfunction, optika.rays.RayFunctionArray)
         assert isinstance(rayfunction.inputs, optika.vectors.ObjectVectorArray)
         assert isinstance(rayfunction.outputs, optika.rays.RayVectorArray)

diff --git a/optika/systems.py b/optika/systems.py
@@ -502,7 +502,11 @@ def _calc_rayfunction(
         return raytrace[{axis: ~0}]
 
     @functools.cached_property
-    def rayfunction(self) -> optika.rays.RayFunctionArray:
+    def rayfunction_default(self) -> optika.rays.RayFunctionArray:
+        """
+        Computes the rays at the last surface in the system as a function of
+        input wavelength and position using :attr:`grid_input_normalized`.
+        """
         return self._calc_rayfunction()
 
     def plot(