Updated PixelResponseNonUniformity docstring; updated test to conditionally assert plot creation based on PLOTS flag. (like in test_PSF.py)

Author: ShannonS00

scopesim/effects/electronic/noise.py

@@ -135,11 +135,34 @@ def plot_hist(self, det, **kwargs):
 
 
 class PixelResponseNonUniformity(Effect):
-    """Per-pixel gain variation (PRNU).
+    """Pixel Response Non-Uniformity (PRNU).
+
+    Models the fixed pattern of per-pixel gain variations across the detector
+    arising from manufacturing differences in quantum efficiency. Each pixel is
+    multiplied by a gain factor drawn from N(1, ``prnu_std``) keyed by detector ID.
+    The gain map is generated once per detector on first use and reused identically 
+    across all subsequent exposures.
+
+    Parameters
+    ----------
+    prnu_std : float or dict
+        Standard deviation of the per-pixel gain distribution. 
+
+    prnu_seed : int, fixed 
+
+    include:  "!DET.include_prnu" 
+
+    Example
+    --------
+
+      - name: prnu
+        description: Pixel response non-uniformity
+        class: PixelResponseNonUniformity
+        kwargs:
+          prnu_std: 0.001
+          prnu_seed: 42
+          include: "!DET.include_prnu" 
 
-    Multiplies each pixel by a gain factor drawn from N(1, prnu_std).
-    The map is generated once per detector and reused across exposures.
-    ``prnu_std`` may be a float or a dict keyed by detector ID.
     """
 
     required_keys: ClassVar[set] = set()

scopesim/tests/tests_effects/test_prnu.py

@@ -1,11 +1,12 @@
-import matplotlib.pyplot as plt
+from matplotlib import pyplot as plt
 import numpy as np
 import pytest
 
 from scopesim.detector import Detector
 from scopesim.effects.electronic import PixelResponseNonUniformity
 from scopesim.optics.image_plane_utils import header_from_list_of_xy
 
+PLOTS = False
 
 def make_detector(value=1000, size=10):
     hdr = header_from_list_of_xy([-size/2, size/2], [-size/2, size/2], 1, "D")
@@ -68,4 +69,5 @@ def test_plot_raises_before_simulation(self):
     def test_plot_returns_figure(self):
         prnu = PixelResponseNonUniformity(prnu_std=0.01, prnu_seed=42)
         prnu.apply_to(make_detector())
-        assert isinstance(prnu.plot(), plt.Figure)
+        if PLOTS:
+            assert isinstance(prnu.plot(), plt.Figure)