gratinglab 0.1.2__tar.gz → 0.1.3__tar.gz

{gratinglab-0.1.2/src/gratinglab.egg-info → gratinglab-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gratinglab
-Version: 0.1.2
+Version: 0.1.3
 Summary: Open platform for diffraction grating groove metrology and efficiency analysis
 Author: Jake McCoy
 License: BSD-3-Clause

{gratinglab-0.1.2 → gratinglab-0.1.3}/src/gratinglab/__init__.py

@@ -21,7 +21,7 @@ from .illumination import Illumination, Polarization
 from .resolution import ResolvingPower, resolving_power
 from .result import EfficiencyScan, OrderEfficiency, Provenance
 
-__version__ = "0.1.2"
+__version__ = "0.1.3"
 
 __all__ = [
     "Illumination",

{gratinglab-0.1.2 → gratinglab-0.1.3}/src/gratinglab/metrology/boundary/average.py

@@ -30,16 +30,24 @@ def flatten_endpoints(x, y):
 
 
 def average_grooves(x, y, groove_centers, period_nm, margin=0.0, n_points=2000,
-                    min_half_width=10):
+                    min_half_width=10, require_full_period=True):
     """
     Extract each groove symmetrically and average them onto a common axis.
 
     Parameters:
         min_half_width: skip grooves whose symmetric half-extent is at or below
-            this many samples. A groove near a scan edge cannot be extracted
-            symmetrically - the scan stops part-way through it - so including it
-            would distort the average. This is the boundary-profile equivalent of
-            EDGE_EXCLUSION_PERIODS in the blaze-angle path.
+            this many samples, a floor on how coarsely a groove may be sampled.
+        require_full_period: skip any groove whose full one-period window does
+            not fit inside the scan. The common axis below is the narrowest
+            window in the set, and normalize_profile stretches that window to a
+            full period, so a single groove the scan edge cuts into would
+            truncate every other groove to its window and then stretch the
+            result. On the synthetic sawtooth one partial groove narrowed the
+            window to 0.66 of a period, turned a 70 degree anti-blaze facet
+            into 58 and took 13% off the depth. EDGE_EXCLUSION_PERIODS upstream
+            usually keeps such grooves out, but it is a user setting, so this
+            check does not rely on it. False reproduces the retired rev3
+            script, which tests/metrology/test_ggp_equivalence.py pins.
 
     Returns:
         x_common, y_avg, y_std, n_used
@@ -50,6 +58,8 @@ def average_grooves(x, y, groove_centers, period_nm, margin=0.0, n_points=2000,
 
     for center in groove_centers:
         L = min(half_width, center, len(x) - 1 - center)
+        if require_full_period and L < half_width:
+            continue  # the scan edge cuts into this groove's period
         if L > min_half_width:
             x_g, y_g = extract_single_groove(x, y, center, period_nm, margin,
                                              allow_asymmetric=False)
@@ -59,7 +69,9 @@ def average_grooves(x, y, groove_centers, period_nm, margin=0.0, n_points=2000,
             grooves.append((x_g, y_g))
 
     if len(grooves) == 0:
-        raise ValueError("No grooves could be extracted.")
+        raise ValueError(
+            "No grooves could be extracted: none has a full period inside the "
+            "scan, or the sampling is coarser than min_half_width allows.")
 
     # Common symmetric extent = most restrictive of the set
     max_left = min(-g[0][0] for g in grooves)

{gratinglab-0.1.2 → gratinglab-0.1.3}/src/gratinglab/metrology/wiki/reading-outputs.md

@@ -117,17 +117,22 @@ plots the profile rather than only reporting numbers.
 | Max slope magnitude | Steepest gradient |
 | Max curvature | Sharpest bend, a proxy for how rounded the groove is |
 
-### Why edge exclusion matters especially here
+### Partial grooves are skipped
 
-`average_grooves` trims every groove to the **most restrictive** common extent,
-so one groove near a scan edge narrows the window shared by all of them. The
-normalisation step then stretches whatever window it has to span a full period.
+`average_grooves` averages every groove over the **narrowest** window in the set,
+and the normalisation step then stretches that window to span a full period. So a
+single groove the scan edge cuts into would narrow the window for all of them and
+distort the exported shape. It therefore skips any groove whose full period does
+not fit inside the scan, whatever the edge-exclusion setting is. The summary's
+"n of m grooves averaged" counts the skipped ones.
 
+Before this check, edge exclusion was the only protection, and it is a setting.
 On the TASTE scan the last groove sits 38 samples from the edge against a
 half-width of 40, which stretched the exported profile horizontally by **5.5%**.
-With the edge rule applied: **0.31%**. A 5% error in the groove's aspect ratio is
-a real error in the efficiency it predicts, and nothing about the file would have
-shown it.
+On the synthetic sawtooth, one partial groove narrowed the window to 0.66 of a
+period, turned a 70° anti-blaze facet into 58° and took 13% off the depth. A
+change that large in the groove's shape is a real change in the efficiency it
+predicts, and nothing in the file would show it.
 
 ### Controls worth understanding
 

{gratinglab-0.1.2 → gratinglab-0.1.3/src/gratinglab.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gratinglab
-Version: 0.1.2
+Version: 0.1.3
 Summary: Open platform for diffraction grating groove metrology and efficiency analysis
 Author: Jake McCoy
 License: BSD-3-Clause