gratinglab 0.1.8__tar.gz → 0.1.9__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {gratinglab-0.1.8/src/gratinglab.egg-info → gratinglab-0.1.9}/PKG-INFO +92 -13
- {gratinglab-0.1.8 → gratinglab-0.1.9}/README.md +87 -11
- {gratinglab-0.1.8 → gratinglab-0.1.9}/pyproject.toml +20 -2
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/__init__.py +1 -1
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/app.py +1 -1
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/icon.py +1 -1
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/core/processing.py +26 -8
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/icon.py +1 -1
- gratinglab-0.1.9/src/gratinglab/metrology/wiki/flattening.md +245 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9/src/gratinglab.egg-info}/PKG-INFO +92 -13
- gratinglab-0.1.8/src/gratinglab/metrology/wiki/flattening.md +0 -109
- {gratinglab-0.1.8 → gratinglab-0.1.9}/LICENSE +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/setup.cfg +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/checks.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/compare.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/convergence.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/geometry.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/diagram.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/diagram3d.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/docs.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/integral_options.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/mathtext.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/orders.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/provenance.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/gc_guard.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/geometry_panel.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/geometry_tab.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/integral_tab.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/main_window.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/profile_plot_panel.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/scalar_tab.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/scene3d_panel.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/setup_tab.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/sizing.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/theory_viewer.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/qt/worker.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/richtext.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/scalar_options.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/gui/state.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/illumination.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/io/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/io/boundary.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/io/efficiency_table.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/io/ggp.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/materials/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/materials/data/SOURCES.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/materials/fresnel.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/materials/optical.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/materials/refractiveindex.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/analyzer.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/boundary/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/boundary/average.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/boundary/pipeline.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/boundary/swaths.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/cli.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/config.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/core/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/core/analysis.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/core/image_flatten.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/core/tip.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/data/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/data/aggregation.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/app.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/boundary_view.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/canvas.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/efficiency_dialog.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/import_view.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/main_window.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/swath_dialog.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/wiki_view.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/qt/worker.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/gui/state.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/io/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/io/file_io.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/io/metrics.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/io/spm.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/settings.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/stats/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/stats/analysis.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/stats/icc.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/visualization/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/visualization/diagnostics.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/visualization/profiles.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/visualization/statistics.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/facet-fitting.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/file-formats.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/icc-correction.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/overview.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/reading-outputs.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/row-groups.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/swath-statistics.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/wiki/tip-correction.md +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/metrology/workflows.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/problem.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/profiles.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/resolution.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/result.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/base.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/__init__.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_boundary.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_core.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_finite.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_greens.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_kernels.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/integral/_nystrom.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab/solvers/scalar.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab.egg-info/SOURCES.txt +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab.egg-info/dependency_links.txt +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab.egg-info/entry_points.txt +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab.egg-info/requires.txt +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/src/gratinglab.egg-info/top_level.txt +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_changelog.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_checks.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_compare.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_convergence.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_cross_method.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_efficiency_table.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_fresnel.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_geometry.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_ggp.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_diagram.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_diagram3d.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_docs.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_integral_options.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_mathtext.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_orders.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_provenance.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_qt.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_richtext.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_scalar_options.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_gui_state.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_illumination.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_core.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_corpus.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_finite.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_greens.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_kernels.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_operators.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_integral_solver.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_io_boundary.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_materials.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_perturbation.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_profiles.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_refractiveindex.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_resolution.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_result.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_scalar.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_solver_conformance.py +0 -0
- {gratinglab-0.1.8 → gratinglab-0.1.9}/tests/test_solver_progress.py +0 -0
|
@@ -1,18 +1,21 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: gratinglab
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.9
|
|
4
4
|
Summary: Open platform for diffraction grating groove metrology and efficiency analysis
|
|
5
5
|
Author: Jake McCoy
|
|
6
6
|
License: BSD-3-Clause
|
|
7
7
|
Project-URL: Homepage, https://github.com/jamccoy/gratinglab
|
|
8
8
|
Project-URL: Changelog, https://github.com/jamccoy/gratinglab/blob/master/CHANGELOG.md
|
|
9
|
-
Keywords: diffraction,grating,efficiency,rcwa,
|
|
9
|
+
Keywords: diffraction,grating,diffraction grating,diffraction efficiency,optics,rcwa,integral method,spectroscopy,afm,metrology,blaze,groove profile,ultraviolet,infrared,x-ray
|
|
10
10
|
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
11
|
Classifier: Intended Audience :: Science/Research
|
|
12
12
|
Classifier: License :: OSI Approved :: BSD License
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
13
14
|
Classifier: Programming Language :: Python :: 3.11
|
|
14
15
|
Classifier: Programming Language :: Python :: 3.12
|
|
15
16
|
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Information Analysis
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering :: Visualization
|
|
16
19
|
Requires-Python: >=3.11
|
|
17
20
|
Description-Content-Type: text/markdown
|
|
18
21
|
License-File: LICENSE
|
|
@@ -227,12 +230,14 @@ does not install one. A subpackage that needs an optional extra names it when it
|
|
|
227
230
|
missing, instead of failing with a bare `ModuleNotFoundError`.
|
|
228
231
|
|
|
229
232
|
Apart from numpy, scipy and pydantic, the only dependency is
|
|
230
|
-
[endstation](https://
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
233
|
+
**[endstation](https://pypi.org/project/endstation/)**
|
|
234
|
+
([source](https://github.com/jamccoy/endstation)), a library of shared components for
|
|
235
|
+
desktop scientific applications by the same author, which gratinglab is built on.
|
|
236
|
+
gratinglab uses its guards for optional extras (the messages described above), form
|
|
237
|
+
validation, Qt layout sizing, test helpers, and the tools that build the icon and the
|
|
238
|
+
macOS application and publish the wiki. The core of endstation has no dependencies of
|
|
239
|
+
its own, so it adds nothing to a solver-only install; its Qt components are installed
|
|
240
|
+
only with the `gui` extra.
|
|
236
241
|
|
|
237
242
|
### Where the measurement data lives
|
|
238
243
|
|
|
@@ -295,9 +300,14 @@ contributed backend appears in the window once it is registered.
|
|
|
295
300
|
|
|
296
301
|
The Help menu contains the theory pages, rendered with typeset equations and tables.
|
|
297
302
|
|
|
298
|
-
A macOS `.app` can be built with `python tools/
|
|
299
|
-
|
|
300
|
-
`
|
|
303
|
+
A macOS `.app` can be built for either window with `python tools/apps.py bundle --app
|
|
304
|
+
gratinglab` (or `--app metrology`), on macOS 13 or later, the minimum supported by the
|
|
305
|
+
PySide6 wheels. `--dest ~/Applications` puts it where Finder will list it. The bundle
|
|
306
|
+
is a stub that execs the console script in this checkout's virtualenv rather than a
|
|
307
|
+
frozen application, so it is not portable to another machine; `python tools/apps.py
|
|
308
|
+
check --app gratinglab` reports when that virtualenv has moved, which is the one
|
|
309
|
+
failure a bundle cannot show from the outside. `python tools/apps.py icon --app
|
|
310
|
+
gratinglab` regenerates the icon from the artwork in `gratinglab.gui.icon`.
|
|
301
311
|
|
|
302
312
|
## Documentation
|
|
303
313
|
|
|
@@ -369,6 +379,75 @@ The test suite relies on three practices in particular:
|
|
|
369
379
|
.venv/bin/mutmut run
|
|
370
380
|
```
|
|
371
381
|
|
|
372
|
-
## License
|
|
382
|
+
## License, copyright and reuse
|
|
373
383
|
|
|
374
|
-
|
|
384
|
+
gratinglab is released under the
|
|
385
|
+
[BSD 3-Clause License](https://github.com/jamccoy/gratinglab/blob/master/LICENSE),
|
|
386
|
+
copyright (c) 2026 Jake McCoy. What follows is a plain summary for convenience; the
|
|
387
|
+
`LICENSE` file is what governs, and nothing here is legal advice.
|
|
388
|
+
|
|
389
|
+
**What you may do.** Use, modify and redistribute the code, in source or binary form,
|
|
390
|
+
for any purpose, including commercial use and inside closed-source work. There is no
|
|
391
|
+
copyleft obligation: software that imports gratinglab does not become BSD-licensed,
|
|
392
|
+
and you are not required to publish your modifications.
|
|
393
|
+
|
|
394
|
+
**What you must do.** Retain the copyright notice, the list of conditions and the
|
|
395
|
+
disclaimer when you redistribute — in the source for a source distribution, and in the
|
|
396
|
+
documentation or other accompanying materials for a binary one. The third clause
|
|
397
|
+
separately forbids using the author's or contributors' names to endorse or promote a
|
|
398
|
+
derived product without prior written permission.
|
|
399
|
+
|
|
400
|
+
**What you do not get.** The software is provided as is, without warranty of any kind,
|
|
401
|
+
and the author is not liable for any use of it. That disclaimer carries more weight
|
|
402
|
+
here than it does for most packages, because the efficiency solvers are experimental
|
|
403
|
+
(see Status): a number this software produces is evidence to be checked against
|
|
404
|
+
another method, not a result to be relied on because a computer printed it.
|
|
405
|
+
|
|
406
|
+
Contributions are accepted under the same licence. A pull request is taken as agreement
|
|
407
|
+
that the contribution may be distributed under BSD-3-Clause.
|
|
408
|
+
|
|
409
|
+
### Citing it
|
|
410
|
+
|
|
411
|
+
[`CITATION.cff`](https://github.com/jamccoy/gratinglab/blob/master/CITATION.cff) is
|
|
412
|
+
the citation of record, and GitHub's "Cite this repository" renders it as BibTeX or
|
|
413
|
+
APA. It names the version, which is checked against `gratinglab.__version__` on every
|
|
414
|
+
release, so a citation generated from it points at the code that produced the number
|
|
415
|
+
rather than at whatever is current. If a result depends on a solver backend or on an
|
|
416
|
+
optical constant table, cite those too: the method's own reference is in
|
|
417
|
+
[`docs/references.md`](https://github.com/jamccoy/gratinglab/blob/master/docs/references.md),
|
|
418
|
+
and `Provenance` records what a run actually used.
|
|
419
|
+
|
|
420
|
+
### The licences you inherit by installing it
|
|
421
|
+
|
|
422
|
+
| Installed with | Package | Licence |
|
|
423
|
+
|---|---|---|
|
|
424
|
+
| core | numpy, scipy | BSD-3-Clause |
|
|
425
|
+
| core | pydantic | MIT |
|
|
426
|
+
| core | [endstation](https://pypi.org/project/endstation/) | BSD-3-Clause |
|
|
427
|
+
| `[gui]`, `[metrology]` | matplotlib | PSF-based, BSD-compatible |
|
|
428
|
+
| `[gui]` | PySide6-Essentials | LGPL-3.0 |
|
|
429
|
+
| `[refractiveindex]` | PyYAML | MIT |
|
|
430
|
+
|
|
431
|
+
A solver-only install is permissive throughout. The `gui` extra is the one worth
|
|
432
|
+
knowing about: Qt for Python is LGPL-3.0, which is the reason this project depends on
|
|
433
|
+
PySide6 and not on PyQt6, whose licence is GPL and would reach your own code.
|
|
434
|
+
Importing an LGPL library dynamically does not change the licence of what you write,
|
|
435
|
+
but redistributing a bundled application that ships Qt inside it brings LGPL
|
|
436
|
+
obligations for that component — chiefly your users' right to substitute their own
|
|
437
|
+
build of it. Running the window yourself, or installing either extra from PyPI, raises
|
|
438
|
+
no such question.
|
|
439
|
+
|
|
440
|
+
### What this licence does not cover
|
|
441
|
+
|
|
442
|
+
**Optical constant tables.** None are distributed with the package, and a table you
|
|
443
|
+
add is governed by the terms of whoever published it, not by this licence. CXRO and
|
|
444
|
+
refractiveindex.info each state their own, and a table exported from another program
|
|
445
|
+
carries whatever that program's terms attach to it.
|
|
446
|
+
[`SOURCES.md`](https://github.com/jamccoy/gratinglab/blob/master/src/gratinglab/materials/data/SOURCES.md)
|
|
447
|
+
records where each kind comes from and why none ships here.
|
|
448
|
+
|
|
449
|
+
**Measurement data.** AFM scans and the reference efficiency corpus are the research
|
|
450
|
+
group's data and are deliberately absent from the repository, as described above under
|
|
451
|
+
Install. The code is open; the measurements it was validated against are not ours to
|
|
452
|
+
publish, and the documentation says which results are therefore not reproducible from
|
|
453
|
+
a bare clone.
|
|
@@ -186,12 +186,14 @@ does not install one. A subpackage that needs an optional extra names it when it
|
|
|
186
186
|
missing, instead of failing with a bare `ModuleNotFoundError`.
|
|
187
187
|
|
|
188
188
|
Apart from numpy, scipy and pydantic, the only dependency is
|
|
189
|
-
[endstation](https://
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
189
|
+
**[endstation](https://pypi.org/project/endstation/)**
|
|
190
|
+
([source](https://github.com/jamccoy/endstation)), a library of shared components for
|
|
191
|
+
desktop scientific applications by the same author, which gratinglab is built on.
|
|
192
|
+
gratinglab uses its guards for optional extras (the messages described above), form
|
|
193
|
+
validation, Qt layout sizing, test helpers, and the tools that build the icon and the
|
|
194
|
+
macOS application and publish the wiki. The core of endstation has no dependencies of
|
|
195
|
+
its own, so it adds nothing to a solver-only install; its Qt components are installed
|
|
196
|
+
only with the `gui` extra.
|
|
195
197
|
|
|
196
198
|
### Where the measurement data lives
|
|
197
199
|
|
|
@@ -254,9 +256,14 @@ contributed backend appears in the window once it is registered.
|
|
|
254
256
|
|
|
255
257
|
The Help menu contains the theory pages, rendered with typeset equations and tables.
|
|
256
258
|
|
|
257
|
-
A macOS `.app` can be built with `python tools/
|
|
258
|
-
|
|
259
|
-
`
|
|
259
|
+
A macOS `.app` can be built for either window with `python tools/apps.py bundle --app
|
|
260
|
+
gratinglab` (or `--app metrology`), on macOS 13 or later, the minimum supported by the
|
|
261
|
+
PySide6 wheels. `--dest ~/Applications` puts it where Finder will list it. The bundle
|
|
262
|
+
is a stub that execs the console script in this checkout's virtualenv rather than a
|
|
263
|
+
frozen application, so it is not portable to another machine; `python tools/apps.py
|
|
264
|
+
check --app gratinglab` reports when that virtualenv has moved, which is the one
|
|
265
|
+
failure a bundle cannot show from the outside. `python tools/apps.py icon --app
|
|
266
|
+
gratinglab` regenerates the icon from the artwork in `gratinglab.gui.icon`.
|
|
260
267
|
|
|
261
268
|
## Documentation
|
|
262
269
|
|
|
@@ -328,6 +335,75 @@ The test suite relies on three practices in particular:
|
|
|
328
335
|
.venv/bin/mutmut run
|
|
329
336
|
```
|
|
330
337
|
|
|
331
|
-
## License
|
|
338
|
+
## License, copyright and reuse
|
|
332
339
|
|
|
333
|
-
|
|
340
|
+
gratinglab is released under the
|
|
341
|
+
[BSD 3-Clause License](https://github.com/jamccoy/gratinglab/blob/master/LICENSE),
|
|
342
|
+
copyright (c) 2026 Jake McCoy. What follows is a plain summary for convenience; the
|
|
343
|
+
`LICENSE` file is what governs, and nothing here is legal advice.
|
|
344
|
+
|
|
345
|
+
**What you may do.** Use, modify and redistribute the code, in source or binary form,
|
|
346
|
+
for any purpose, including commercial use and inside closed-source work. There is no
|
|
347
|
+
copyleft obligation: software that imports gratinglab does not become BSD-licensed,
|
|
348
|
+
and you are not required to publish your modifications.
|
|
349
|
+
|
|
350
|
+
**What you must do.** Retain the copyright notice, the list of conditions and the
|
|
351
|
+
disclaimer when you redistribute — in the source for a source distribution, and in the
|
|
352
|
+
documentation or other accompanying materials for a binary one. The third clause
|
|
353
|
+
separately forbids using the author's or contributors' names to endorse or promote a
|
|
354
|
+
derived product without prior written permission.
|
|
355
|
+
|
|
356
|
+
**What you do not get.** The software is provided as is, without warranty of any kind,
|
|
357
|
+
and the author is not liable for any use of it. That disclaimer carries more weight
|
|
358
|
+
here than it does for most packages, because the efficiency solvers are experimental
|
|
359
|
+
(see Status): a number this software produces is evidence to be checked against
|
|
360
|
+
another method, not a result to be relied on because a computer printed it.
|
|
361
|
+
|
|
362
|
+
Contributions are accepted under the same licence. A pull request is taken as agreement
|
|
363
|
+
that the contribution may be distributed under BSD-3-Clause.
|
|
364
|
+
|
|
365
|
+
### Citing it
|
|
366
|
+
|
|
367
|
+
[`CITATION.cff`](https://github.com/jamccoy/gratinglab/blob/master/CITATION.cff) is
|
|
368
|
+
the citation of record, and GitHub's "Cite this repository" renders it as BibTeX or
|
|
369
|
+
APA. It names the version, which is checked against `gratinglab.__version__` on every
|
|
370
|
+
release, so a citation generated from it points at the code that produced the number
|
|
371
|
+
rather than at whatever is current. If a result depends on a solver backend or on an
|
|
372
|
+
optical constant table, cite those too: the method's own reference is in
|
|
373
|
+
[`docs/references.md`](https://github.com/jamccoy/gratinglab/blob/master/docs/references.md),
|
|
374
|
+
and `Provenance` records what a run actually used.
|
|
375
|
+
|
|
376
|
+
### The licences you inherit by installing it
|
|
377
|
+
|
|
378
|
+
| Installed with | Package | Licence |
|
|
379
|
+
|---|---|---|
|
|
380
|
+
| core | numpy, scipy | BSD-3-Clause |
|
|
381
|
+
| core | pydantic | MIT |
|
|
382
|
+
| core | [endstation](https://pypi.org/project/endstation/) | BSD-3-Clause |
|
|
383
|
+
| `[gui]`, `[metrology]` | matplotlib | PSF-based, BSD-compatible |
|
|
384
|
+
| `[gui]` | PySide6-Essentials | LGPL-3.0 |
|
|
385
|
+
| `[refractiveindex]` | PyYAML | MIT |
|
|
386
|
+
|
|
387
|
+
A solver-only install is permissive throughout. The `gui` extra is the one worth
|
|
388
|
+
knowing about: Qt for Python is LGPL-3.0, which is the reason this project depends on
|
|
389
|
+
PySide6 and not on PyQt6, whose licence is GPL and would reach your own code.
|
|
390
|
+
Importing an LGPL library dynamically does not change the licence of what you write,
|
|
391
|
+
but redistributing a bundled application that ships Qt inside it brings LGPL
|
|
392
|
+
obligations for that component — chiefly your users' right to substitute their own
|
|
393
|
+
build of it. Running the window yourself, or installing either extra from PyPI, raises
|
|
394
|
+
no such question.
|
|
395
|
+
|
|
396
|
+
### What this licence does not cover
|
|
397
|
+
|
|
398
|
+
**Optical constant tables.** None are distributed with the package, and a table you
|
|
399
|
+
add is governed by the terms of whoever published it, not by this licence. CXRO and
|
|
400
|
+
refractiveindex.info each state their own, and a table exported from another program
|
|
401
|
+
carries whatever that program's terms attach to it.
|
|
402
|
+
[`SOURCES.md`](https://github.com/jamccoy/gratinglab/blob/master/src/gratinglab/materials/data/SOURCES.md)
|
|
403
|
+
records where each kind comes from and why none ships here.
|
|
404
|
+
|
|
405
|
+
**Measurement data.** AFM scans and the reference efficiency corpus are the research
|
|
406
|
+
group's data and are deliberately absent from the repository, as described above under
|
|
407
|
+
Install. The code is open; the measurements it was validated against are not ours to
|
|
408
|
+
publish, and the documentation says which results are therefore not reproducible from
|
|
409
|
+
a bare clone.
|
|
@@ -14,15 +14,33 @@ readme = "README.md"
|
|
|
14
14
|
requires-python = ">=3.11"
|
|
15
15
|
license = { text = "BSD-3-Clause" }
|
|
16
16
|
authors = [{ name = "Jake McCoy" }]
|
|
17
|
-
|
|
18
|
-
|
|
17
|
+
# Wavelength-neutral on purpose. The off-plane work this package grew out of is
|
|
18
|
+
# soft x-ray, and that band is still named, but nothing in the solvers or the
|
|
19
|
+
# metrology assumes one: the grating equation carries no band, and the
|
|
20
|
+
# materials layer reads CXRO x-ray tables and refractiveindex.info
|
|
21
|
+
# ultraviolet-to-infrared tables alike. Leading with "x-ray" told a reader the
|
|
22
|
+
# in-plane half of the package was not meant for them.
|
|
23
|
+
#
|
|
24
|
+
# "pcgrate" is deliberately absent. It is a program this project validates
|
|
25
|
+
# against, not a feature of this one, and a search for it should not land here.
|
|
26
|
+
keywords = ["diffraction", "grating", "diffraction grating", "diffraction efficiency",
|
|
27
|
+
"optics", "rcwa", "integral method", "spectroscopy", "afm", "metrology",
|
|
28
|
+
"blaze", "groove profile", "ultraviolet", "infrared", "x-ray"]
|
|
29
|
+
# Only classifiers from the trove list, which PyPI rejects uploads over. Note
|
|
30
|
+
# that there is no `Topic :: Scientific/Engineering :: Optics`; Physics is the
|
|
31
|
+
# nearest, with Information Analysis for the metrology and Visualization for
|
|
32
|
+
# the windows. No Qt environment classifier: a classifier cannot be made
|
|
33
|
+
# conditional on an extra, and a default install pulls no toolkit at all.
|
|
19
34
|
classifiers = [
|
|
20
35
|
"Development Status :: 2 - Pre-Alpha",
|
|
21
36
|
"Intended Audience :: Science/Research",
|
|
22
37
|
"License :: OSI Approved :: BSD License",
|
|
38
|
+
"Operating System :: OS Independent",
|
|
23
39
|
"Programming Language :: Python :: 3.11",
|
|
24
40
|
"Programming Language :: Python :: 3.12",
|
|
25
41
|
"Topic :: Scientific/Engineering :: Physics",
|
|
42
|
+
"Topic :: Scientific/Engineering :: Information Analysis",
|
|
43
|
+
"Topic :: Scientific/Engineering :: Visualization",
|
|
26
44
|
]
|
|
27
45
|
dependencies = [
|
|
28
46
|
"numpy>=1.26",
|
|
@@ -21,7 +21,7 @@ from .illumination import Illumination, Polarization
|
|
|
21
21
|
from .resolution import ResolvingPower, resolving_power
|
|
22
22
|
from .result import EfficiencyScan, OrderEfficiency, Provenance
|
|
23
23
|
|
|
24
|
-
__version__ = "0.1.
|
|
24
|
+
__version__ = "0.1.9"
|
|
25
25
|
|
|
26
26
|
__all__ = [
|
|
27
27
|
"Illumination",
|
|
@@ -58,7 +58,7 @@ def _bring_to_front(window) -> None:
|
|
|
58
58
|
The fallback was therefore a `subprocess.run` on every launch, wrapped in
|
|
59
59
|
a bare `except`, which did nothing in the one case it was written for, and
|
|
60
60
|
it has been removed. The supported way to bring the window forward when
|
|
61
|
-
starting from a shell is to launch the bundle, which `tools/
|
|
61
|
+
starting from a shell is to launch the bundle, which `tools/apps.py bundle`
|
|
62
62
|
builds and the README describes.
|
|
63
63
|
"""
|
|
64
64
|
window.raise_()
|
|
@@ -9,7 +9,7 @@ is what this software computes. It uses a few thick elements so that it
|
|
|
9
9
|
remains legible at 16 px, the size at which icons most often become
|
|
10
10
|
unreadable.
|
|
11
11
|
|
|
12
|
-
``tools/
|
|
12
|
+
``tools/apps.py icon`` turns this into a macOS ``.icns``.
|
|
13
13
|
"""
|
|
14
14
|
|
|
15
15
|
from __future__ import annotations
|
|
@@ -186,7 +186,9 @@ def flatten_profile(x, y, method='linear', poly_order=2, exclude_edges=0.0,
|
|
|
186
186
|
Parameters:
|
|
187
187
|
method: 'linear', 'polynomial', 'groove_peaks', or 'level_grooves'
|
|
188
188
|
poly_order: polynomial order (for 'polynomial' and 'level_grooves' methods)
|
|
189
|
-
exclude_edges: fraction of data to exclude from edges (0.0 to 0.5)
|
|
189
|
+
exclude_edges: fraction of data to exclude from edges (0.0 to 0.5).
|
|
190
|
+
For 'level_grooves' it is skipped, with a warning, when excluding
|
|
191
|
+
the edges would leave too few features to fit the requested order.
|
|
190
192
|
feature: for 'level_grooves': 'peaks', 'troughs', or 'both'
|
|
191
193
|
period_nm: estimated period for finding grooves (for 'level_grooves')
|
|
192
194
|
|
|
@@ -262,13 +264,29 @@ def flatten_profile(x, y, method='linear', poly_order=2, exclude_edges=0.0,
|
|
|
262
264
|
x_min = x[0] + exclude_edges * (x[-1] - x[0])
|
|
263
265
|
x_max = x[-1] - exclude_edges * (x[-1] - x[0])
|
|
264
266
|
mask = (feature_x >= x_min) & (feature_x <= x_max)
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
267
|
+
kept = int(np.count_nonzero(mask))
|
|
268
|
+
# Edge exclusion is meant to improve the fit, so it must not be
|
|
269
|
+
# allowed to starve it. This used to keep the remnant and fit
|
|
270
|
+
# that while printing "using all": with two features left and a
|
|
271
|
+
# quadratic asked for, the background was rank-deficient and
|
|
272
|
+
# still looked like a fit.
|
|
273
|
+
if kept >= poly_order + 1:
|
|
274
|
+
feature_x = feature_x[mask]
|
|
275
|
+
feature_y = feature_y[mask]
|
|
276
|
+
else:
|
|
277
|
+
print(f" Warning: edge exclusion leaves {kept} feature(s), "
|
|
278
|
+
f"too few for a degree-{poly_order} background; "
|
|
279
|
+
"using all of them")
|
|
280
|
+
|
|
281
|
+
# A degree-k polynomial needs k+1 points to be determined. Reaching
|
|
282
|
+
# here guarantees two, so the order is reduced rather than letting
|
|
283
|
+
# polyfit return a rank-deficient answer behind a RankWarning.
|
|
284
|
+
order = min(poly_order, len(feature_x) - 1)
|
|
285
|
+
if order < poly_order:
|
|
286
|
+
print(f" Warning: {len(feature_x)} feature(s) support only a "
|
|
287
|
+
f"degree-{order} background, not degree-{poly_order}")
|
|
288
|
+
|
|
289
|
+
poly_coeffs = np.polyfit(feature_x, feature_y, order)
|
|
272
290
|
background = np.polyval(poly_coeffs, x)
|
|
273
291
|
else:
|
|
274
292
|
raise ValueError(f"Unknown flattening method: {method}")
|
|
@@ -19,7 +19,7 @@ importing ``gratinglab.metrology.gui`` must stay cheap, since that is what
|
|
|
19
19
|
raises the friendly "PySide6 is an optional extra" message.
|
|
20
20
|
``tests/test_gui_boundary.py`` checks it.
|
|
21
21
|
|
|
22
|
-
``tools/
|
|
22
|
+
``tools/apps.py icon`` turns this into a macOS ``.icns``.
|
|
23
23
|
"""
|
|
24
24
|
|
|
25
25
|
from __future__ import annotations
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
# Flattening
|
|
2
|
+
|
|
3
|
+
AFM data arrives with a background, because the sample sits at an angle under
|
|
4
|
+
the scanner and the scan lines drift in Z relative to one another. Removing this
|
|
5
|
+
background is called *flattening*. This software flattens at three separate
|
|
6
|
+
points, which are easily confused.
|
|
7
|
+
|
|
8
|
+
| | Acts on | When | Changes the blaze angle? |
|
|
9
|
+
|---|---|---|---|
|
|
10
|
+
| **Image flattening** | the 2-D scan | before rows are averaged | **No** (for the methods offered) |
|
|
11
|
+
| **Profile flattening** | one averaged 1-D trace | per row group | **Yes, about 0.49°** |
|
|
12
|
+
| **Endpoint flattening** | the normalised groove | only on PCGrate export | n/a — a different job |
|
|
13
|
+
|
|
14
|
+
The first two are set in the Import tab, where the profile preview draws the
|
|
15
|
+
background that is about to be removed. The third is not a setting: it is part
|
|
16
|
+
of writing a `.ggp` file, and it is described at the end of this page.
|
|
17
|
+
|
|
18
|
+
## Why a background has to be removed at all
|
|
19
|
+
|
|
20
|
+
A blaze angle is a facet slope *measured against the substrate plane*. The
|
|
21
|
+
substrate plane is not in the data — the scanner records height above whatever
|
|
22
|
+
plane the sample happened to be sitting in — so flattening is what supplies the
|
|
23
|
+
reference the angle is quoted against. An error of δ in that reference is an
|
|
24
|
+
error of δ in every facet angle on the scan, in the same direction. This is why
|
|
25
|
+
the choice of profile-flattening method matters as much as the fit that follows
|
|
26
|
+
it, and why it is recorded in every summary file.
|
|
27
|
+
|
|
28
|
+
## Image flattening (2-D)
|
|
29
|
+
|
|
30
|
+
Image flattening acts on the image as it came off the instrument and corrects
|
|
31
|
+
the scan lines relative to each other.
|
|
32
|
+
|
|
33
|
+
| Method | What it does |
|
|
34
|
+
|---|---|
|
|
35
|
+
| `none` | Leave the image alone. The behaviour before August 2026. |
|
|
36
|
+
| `plane` | Subtract one tilted plane fitted to the whole image. Corrects the sample sitting at an angle. |
|
|
37
|
+
| `align_rows` | Subtract each row's median, putting every scan line on a common level. **The default.** |
|
|
38
|
+
|
|
39
|
+
`align_rows` uses the median because a grating profile is not symmetric about
|
|
40
|
+
its own mean: a row that catches more groove bottom than land would shift the
|
|
41
|
+
mean noticeably, while the median barely moves.
|
|
42
|
+
|
|
43
|
+
The Import tab reports the *row-offset spread*, defined as the standard
|
|
44
|
+
deviation of the per-row medians, before and after flattening, so that the
|
|
45
|
+
choice of method can be based on evidence. Across this project's data the spread
|
|
46
|
+
ranges over 0.44–2.74 nm, against groove depths near 100 nm.
|
|
47
|
+
|
|
48
|
+
### Why it doesn't change the answer
|
|
49
|
+
|
|
50
|
+
This result is stated explicitly because it could otherwise be mistaken for a
|
|
51
|
+
bug.
|
|
52
|
+
|
|
53
|
+
On `20250820_280C_00004.txt`, the scan with the largest row-offset spread in the
|
|
54
|
+
dataset, `none`, `plane` and `align_rows` all give 30.8524°, agreeing to within
|
|
55
|
+
5×10⁻¹⁵. Across all eight compare-mode samples, enabling `align_rows` changed
|
|
56
|
+
the mean by 0.0000°.
|
|
57
|
+
|
|
58
|
+
The reason is structural, and it is worth following through, because it is what
|
|
59
|
+
makes the default free.
|
|
60
|
+
|
|
61
|
+
1. Rows are averaged into a profile. `align_rows` removes a constant from each
|
|
62
|
+
row, so after averaging a band it has removed **one constant**. `plane`
|
|
63
|
+
removes `a + bx + cy`, so after averaging over rows it has removed **a
|
|
64
|
+
constant and a linear ramp in x**. Both are polynomials in x of degree at
|
|
65
|
+
most 1.
|
|
66
|
+
2. Profile flattening then fits a polynomial to that averaged profile and
|
|
67
|
+
subtracts it. A least-squares polynomial fit is linear in the data, and it
|
|
68
|
+
reproduces exactly any polynomial up to its own order. Every profile-
|
|
69
|
+
flattening method fits at least a first-order polynomial.
|
|
70
|
+
3. So adding `a + bx` to the profile adds exactly `a + bx` to the fitted
|
|
71
|
+
background, and the difference — the flattened profile — is unchanged.
|
|
72
|
+
|
|
73
|
+
Whatever the image stage removes, the profile stage would have removed anyway.
|
|
74
|
+
For this reason `align_rows` could be made the default without any stored number
|
|
75
|
+
changing, and this is guarded by `test_affine_methods_give_identical_blaze_angles`
|
|
76
|
+
in `tests/metrology/test_image_flatten.py`. That test asserts a tolerance rather
|
|
77
|
+
than exact equality on purpose: subtracting medians perturbs the last bits, and
|
|
78
|
+
the averaging that follows is not associative, so the results differ by around
|
|
79
|
+
5×10⁻¹⁵ degrees against a sigma near 2.
|
|
80
|
+
|
|
81
|
+
### Where that argument stops
|
|
82
|
+
|
|
83
|
+
Two limits are worth knowing, because the guarantee is narrower than "flattening
|
|
84
|
+
is harmless".
|
|
85
|
+
|
|
86
|
+
**It covers affine methods only.** A per-row *quadratic* fits coefficients to
|
|
87
|
+
each row's own data and changes the shape within the row, not merely its offset
|
|
88
|
+
and tilt. That survives the averaging: it was measured at 0.0003°, which is
|
|
89
|
+
small but not zero. The registry in `core/image_flatten.py` is where such a
|
|
90
|
+
method would be added, and it would need its own measurement rather than
|
|
91
|
+
inheriting this one.
|
|
92
|
+
|
|
93
|
+
**Step 3 assumes the same features are found.** `level_grooves` and
|
|
94
|
+
`groove_peaks` fit through detected features, and detection uses topographic
|
|
95
|
+
prominence. Prominence is unchanged by adding a constant, so `align_rows` cannot
|
|
96
|
+
disturb it. It is *not* unchanged by adding a tilt, so with `plane` a large
|
|
97
|
+
enough sample tilt could in principle shift which peaks clear the prominence
|
|
98
|
+
threshold, and the two methods would then diverge for that reason rather than
|
|
99
|
+
through the arithmetic above. On this project's data it does not happen — hence
|
|
100
|
+
the 5×10⁻¹⁵ agreement — but on a markedly more tilted scan it is the thing to
|
|
101
|
+
check first.
|
|
102
|
+
|
|
103
|
+
### So what is it for
|
|
104
|
+
|
|
105
|
+
- **Seeing the data.** A raw image with sample tilt renders as a gradient in
|
|
106
|
+
which the grating is barely visible. After levelling, it is recognisable as a
|
|
107
|
+
grating.
|
|
108
|
+
- **Methods that aren't affine.** As above: the registry is the place for one,
|
|
109
|
+
and the invariance result does not extend to it.
|
|
110
|
+
- **Being explicit.** The step is now performed in a named and recorded place.
|
|
111
|
+
Previously it was done in Gwyddion before export, and nothing recorded that it
|
|
112
|
+
had been done.
|
|
113
|
+
|
|
114
|
+
## Profile flattening (1-D)
|
|
115
|
+
|
|
116
|
+
Profile flattening acts on each row group's averaged height trace, immediately
|
|
117
|
+
before grooves are detected and facets are fitted. This is the flattening choice
|
|
118
|
+
that affects the result.
|
|
119
|
+
|
|
120
|
+
| Method | What it fits the background to |
|
|
121
|
+
|---|---|
|
|
122
|
+
| `linear` | A straight line through the whole profile |
|
|
123
|
+
| `polynomial` | A polynomial of `FLATTEN_POLY_ORDER`, optionally ignoring the edges |
|
|
124
|
+
| `groove_peaks` | A polynomial through the detected peaks only |
|
|
125
|
+
| `level_grooves` | A polynomial through chosen features. **The default.** |
|
|
126
|
+
|
|
127
|
+
The settings that go with it, with the values they ship as:
|
|
128
|
+
|
|
129
|
+
| Setting | Default | Meaning |
|
|
130
|
+
|---|---|---|
|
|
131
|
+
| `FLATTEN_METHOD` | `level_grooves` | which of the four methods above |
|
|
132
|
+
| `FLATTEN_FEATURE` | `peaks` | for `level_grooves`: `peaks` (the lands), `troughs` (groove bottoms), or `both` |
|
|
133
|
+
| `FLATTEN_POLY_ORDER` | `2` | order of the fitted background: 1 linear, 2 quadratic, 3 cubic |
|
|
134
|
+
| `FLATTEN_EXCLUDE_EDGES` | `0.05` | fraction of the trace ignored at each end when fitting |
|
|
135
|
+
|
|
136
|
+
Note that the default *feature* is `peaks`, not `both`: the background is fitted
|
|
137
|
+
through the lands alone unless asked otherwise.
|
|
138
|
+
|
|
139
|
+
On the same scan:
|
|
140
|
+
|
|
141
|
+
| Method | Mean angle | N |
|
|
142
|
+
|---|---|---|
|
|
143
|
+
| `level_grooves` | 30.8524° | 102 |
|
|
144
|
+
| `linear` | 30.9619° | 102 |
|
|
145
|
+
| `polynomial` | 31.1098° | 105 |
|
|
146
|
+
| `groove_peaks` | 31.3466° | 106 |
|
|
147
|
+
|
|
148
|
+
The methods span 0.49°, which is around 250× the image-flattening effect and
|
|
149
|
+
comparable to the differences between samples that this software is intended to
|
|
150
|
+
detect. The choice also changes how many grooves are found, because groove
|
|
151
|
+
detection runs on the flattened profile.
|
|
152
|
+
|
|
153
|
+
### Why the lands are the reference
|
|
154
|
+
|
|
155
|
+
`level_grooves` is the default because levelling on the lands places the
|
|
156
|
+
reference where the surface is genuinely flat. The lands are the original wafer
|
|
157
|
+
surface, the part the etch did not remove, so they are parallel to the substrate
|
|
158
|
+
by construction and are the one part of the profile whose height is not a
|
|
159
|
+
measurement of the thing being measured.
|
|
160
|
+
|
|
161
|
+
The alternative is to fit through a profile whose own asymmetry and curvature
|
|
162
|
+
are the quantity being measured. A sawtooth is not symmetric about its own mean
|
|
163
|
+
line, so a fit through the whole trace is pulled by the facet, and the
|
|
164
|
+
background absorbs part of the slope the facet fit is about to report. That is
|
|
165
|
+
the mechanism behind the 0.49° in the table: `linear` and `polynomial` are not
|
|
166
|
+
noisier than `level_grooves`, they are *biased*, and in a direction set by the
|
|
167
|
+
groove shape rather than by anything about the instrument.
|
|
168
|
+
|
|
169
|
+
`groove_peaks` fits through peaks too, but it finds them with a bare separation
|
|
170
|
+
criterion (one twentieth of the trace) and no prominence requirement, so it
|
|
171
|
+
accepts noise maxima on a facet as readily as lands. It is kept because it was
|
|
172
|
+
the historical method and its number is needed to interpret older output.
|
|
173
|
+
|
|
174
|
+
### How the features are found
|
|
175
|
+
|
|
176
|
+
For `level_grooves`, each requested feature set is detected with `find_peaks`
|
|
177
|
+
on the profile — troughs by running the same detection on the negated trace —
|
|
178
|
+
under two criteria:
|
|
179
|
+
|
|
180
|
+
- **Separation** of at least half a period, `0.5 · period_nm / dx`, so that one
|
|
181
|
+
groove cannot contribute two lands.
|
|
182
|
+
- **Prominence** of at least 20% of the profile's full height range, which is
|
|
183
|
+
what excludes noise maxima part-way up a facet.
|
|
184
|
+
|
|
185
|
+
The surviving points, from one or both sets, are fitted with a polynomial of
|
|
186
|
+
`FLATTEN_POLY_ORDER` and that polynomial is the background.
|
|
187
|
+
|
|
188
|
+
### The period comes first
|
|
189
|
+
|
|
190
|
+
`level_grooves` requires an estimated period: it raises rather than guessing if
|
|
191
|
+
one is not supplied, because the separation criterion above is expressed in
|
|
192
|
+
periods. So the order is period estimate → flattening → groove detection →
|
|
193
|
+
measured period, and the period used to level the profile is not independent of
|
|
194
|
+
the period the run reports.
|
|
195
|
+
|
|
196
|
+
This is not vicious — the separation criterion is a loose gate at half a period,
|
|
197
|
+
and a period estimate wrong by a few percent does not change which maxima clear
|
|
198
|
+
it — but it is a real dependency, and it is the reason a badly wrong period
|
|
199
|
+
estimate degrades the flattening rather than only the detection.
|
|
200
|
+
|
|
201
|
+
### When detection fails
|
|
202
|
+
|
|
203
|
+
If fewer than two features survive, `level_grooves` falls back to `linear` and
|
|
204
|
+
says so; `groove_peaks` falls back to `polynomial` below three peaks. Either
|
|
205
|
+
fallback means the background for that row group was fitted by a method other
|
|
206
|
+
than the one requested, and from the table above that is worth up to a few
|
|
207
|
+
tenths of a degree.
|
|
208
|
+
|
|
209
|
+
Edge exclusion is checked separately, because it runs *after* detection and can
|
|
210
|
+
starve a fit that detection had already satisfied. If excluding the edges would
|
|
211
|
+
leave fewer features than the requested order needs — three, for the default
|
|
212
|
+
quadratic — the exclusion is skipped and every detected feature is used
|
|
213
|
+
instead. If the feature set is too small for the order even then, the order is
|
|
214
|
+
reduced to what those features support, rather than fitting a polynomial the
|
|
215
|
+
data cannot determine. Both are announced.
|
|
216
|
+
|
|
217
|
+
The fallback is announced on standard output rather than recorded in the
|
|
218
|
+
summary, so in a batch run over many files it is easy to miss. If a row group's
|
|
219
|
+
angle is an outlier, the console is the place to check whether its background
|
|
220
|
+
was fitted the way the others' were.
|
|
221
|
+
|
|
222
|
+
### Judge it by eye
|
|
223
|
+
|
|
224
|
+
The Import tab draws three curves: the averaged profile, the background that is
|
|
225
|
+
about to be removed, and the result. A background that follows the grating
|
|
226
|
+
instead of the underlying tilt is removing signal, and this is immediately
|
|
227
|
+
visible in the plot in a way that a number in a configuration file is not.
|
|
228
|
+
|
|
229
|
+
Because this parameter affects the answer, the value used is written into every
|
|
230
|
+
summary file alongside the result. What matters for a comparison is that the
|
|
231
|
+
same choice is applied to every sample being compared.
|
|
232
|
+
|
|
233
|
+
## Endpoint flattening (export only)
|
|
234
|
+
|
|
235
|
+
The boundary profile written for PCGrate is levelled a third way, and this one
|
|
236
|
+
is not a choice. The straight line through the first and last sample is
|
|
237
|
+
subtracted, so that the trace starts and ends at exactly zero.
|
|
238
|
+
|
|
239
|
+
The reason is that a `.ggp` profile is one period, repeated by the solver. A
|
|
240
|
+
background fitted the way the blaze-angle path fits one leaves the two ends at
|
|
241
|
+
slightly different heights, which on repetition is a step at every period
|
|
242
|
+
boundary. That step makes the computed efficiency curve wrong while the file
|
|
243
|
+
still looks entirely reasonable, which is the worst combination. Substituting
|
|
244
|
+
one kind of flattening for the other here is a known way to produce a confidently
|
|
245
|
+
wrong answer, and the boundary-export path keeps them apart deliberately.
|