Huygens MTF

CHANGELOG.md

@@ -11,6 +11,8 @@ ZOS-API can also be added in patch releases.
 
 ### Added
 
+- MTF analysis: `huygens_mtf` (#55)
+
 ### Fixed
 
 ### Changed

scripts/generate_test_reference_data/tests.yaml

@@ -30,6 +30,32 @@ tests:
         frequency: 3
         numberofsteps: 10
         mtftype: Imaginary
+  - model: simple_system
+    analysis: mtf.huygens_mtf
+    file: test_mtf.py
+    test: test_huygens_mtf_returns_correct_result
+    parametrized: [pupil_sampling, image_sampling, image_delta, mtftype, maximum_frequency]
+    parameters:
+      - pupil_sampling: 64x64
+        image_sampling: 64x64
+        image_delta: 0.0
+        mtftype: Modulation
+        maximum_frequency: 150.0
+      - pupil_sampling: 32x32
+        image_sampling: 64x64
+        image_delta: 1.0
+        mtftype: Modulation
+        maximum_frequency: 450.0
+      - pupil_sampling: 128x128
+        image_sampling: 128x128
+        image_delta: 0.0
+        mtftype: Modulation
+        maximum_frequency: 314.5
+      - pupil_sampling: 32x32
+        image_sampling: 32x32
+        image_delta: 0.0
+        mtftype: Modulation
+        maximum_frequency: 150.0
   - model: polarized_system
     analysis: polarization.polarization_pupil_map
     file: test_polarization.py

tests/analyses/test_mtf.py

@@ -1,7 +1,12 @@
 import numpy as np
 import pytest
+from pandas.testing import assert_frame_equal
 
-from zospy.analyses.mtf import fft_through_focus_mtf, fft_through_focus_mtf_fromcfg
+from zospy.analyses.mtf import (
+    fft_through_focus_mtf,
+    fft_through_focus_mtf_fromcfg,
+    huygens_mtf,
+)
 
 _FFT_THROUGH_FOCUS_MTF_MTFTYPE_EXPECTED_RETURN = {
     # The expected return does not match constants.Analysis.Settings.Mtf.MtfTypes for fft_through_focus_mtf
@@ -86,3 +91,38 @@ def test_fft_through_focus_mtf_sets_mtftype_correctly(self, simple_system, mtfty
         )
 
         assert result.Settings["Type"] == _FFT_THROUGH_FOCUS_MTF_MTFTYPE_EXPECTED_RETURN[mtftype]
+
+
+class TestHuygensMTF:
+    def test_can_run_huygens_mtf(self, simple_system):
+        result = huygens_mtf(simple_system)
+
+        assert result.Data is not None
+
+    def test_to_json(self, simple_system):
+        result = huygens_mtf(simple_system)
+
+        assert result.from_json(result.to_json())
+
+    @pytest.mark.parametrize(
+        "pupil_sampling,image_sampling,image_delta,mtftype,maximum_frequency",
+        [
+            ("64x64", "64x64", 0.0, "Modulation", 150.0),
+            ("32x32", "64x64", 1.0, "Modulation", 450.0),
+            ("128x128", "128x128", 0.0, "Modulation", 314.5),
+            ("32x32", "32x32", 0.0, "Modulation", 150.0),
+        ],
+    )
+    def test_huygens_mtf_returns_correct_result(
+        self, simple_system, pupil_sampling, image_sampling, image_delta, mtftype, maximum_frequency, expected_data
+    ):
+        result = huygens_mtf(
+            simple_system,
+            pupil_sampling=pupil_sampling,
+            image_sampling=image_sampling,
+            image_delta=image_delta,
+            mtftype=mtftype,
+            maximum_frequency=maximum_frequency,
+        )
+
+        assert_frame_equal(result.Data.astype(float), expected_data.Data.astype(float))