bobleesj commited on
Commit
a44e3d2
·
verified ·
1 Parent(s): 0017985

Add single-dose synthetic Au nanobeam calibration example

Browse files
4dstem/simulated_au_nanobeam_pg_dose1/README.md ADDED
@@ -0,0 +1,69 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Synthetic Au nanobeam: one dose, independent calibration
2
+
3
+ A compact example for calibrated 4D-STEM denoising with Denova TV and SHINE-PG.
4
+ **Synthetic data only. This is not a validated ARINA detector simulation or a demonstrated match to experimental data.**
5
+
6
+ The native scan is 32 × 32, with 192 × 192 detector pixels; 300 kV and 0.622 mrad.
7
+ One relative specimen dose (1.0; 90,000 assumed incident events per scan position)
8
+ shares a noiseless expectation with independent dark, flat and validation exposures.
9
+ The scientific files and maps occupy approximately 503.1 MiB before this small documentation.
10
+
11
+ ```python
12
+ from quantem.widget.io import hub
13
+ from quantem.gpu import io
14
+ folder = hub.download("simulated_au_nanobeam_pg_dose1", repo="bobleesj/quantem-data")
15
+ scan = io.load(folder / "dose-1.0_master.h5", representation="encoded", backend="cuda",
16
+ apply_mask=False, hot_pixel_correction="none")
17
+ ```
18
+
19
+ Use Denova's matching development tutorials `4dstem_2_tv.ipynb` and
20
+ `4dstem_3_shine.ipynb` to inspect a scan region, independently calibrate the
21
+ noise, denoise, inspect residuals and compare against truth. The revised Denova
22
+ API is a development workflow; an installable release containing it is not
23
+ asserted here. abTEM is needed only to regenerate the example.
24
+
25
+ ## What is included
26
+
27
+ | Files | Meaning |
28
+ | --- | --- |
29
+ | `dose-1.0_*` | One signed noisy ADU observation |
30
+ | `truth-events-dose-1.0_*` | Noiseless expected detected events; evaluation only |
31
+ | `dark_*` | 512 independent beam-off synthetic repeats |
32
+ | `flats_*` | Five illumination levels, 256 repeats per level for calibration |
33
+ | `check-flats_*` | Separate validation repeats: 128 per level |
34
+ | `detector-valid.pt` | Explicit mask: four invalid detector pixels |
35
+ | `detector-calibration.pt` | Parameters fitted from dark/flat repeats |
36
+ | `generator-only.pt` | Assumed generating parameters; evaluation only |
37
+ | `geometry.json`, `au-scene.extxyz` | Geometry, atoms, seeds and simulation provenance |
38
+ | `calibration-check.csv`, `validation.json` | Calibration and GPU I/O checks |
39
+ | `SHA256SUMS` | File integrity checksums |
40
+
41
+ Keep every HDF5 master together with its linked data shards. QuantEM.GPU wrote
42
+ lossless compressed float32 arrays. Signed fluctuations and invalid values are
43
+ preserved. Load tensor maps with `torch.load(..., weights_only=True)`.
44
+
45
+ ## Model and limits
46
+
47
+ For expected events u, draw K ~ Poisson(u), then Y = b + alpha K + Normal(0,s²).
48
+ Gain alpha varies around 1.5 ADU/event; pedestal b varies around 2 ADU;
49
+ read-noise standard deviation s = 0.6 ADU. These are assumed parameters, not
50
+ measured ARINA hardware coefficients. Calibration never uses specimen truth.
51
+ Five calibration illumination levels are needed even though the specimen dose
52
+ is single-valued. Dark frames alone cannot recover gain.
53
+
54
+ The static Au model uses infinite-projection Lobato potentials. Its assumed
55
+ 25% Gaussian angular redistribution (4 mrad width) illustrates a diffuse
56
+ background; it is not atomistic liquid/window scattering. Neither count-rate
57
+ correction nor charge-sharing covariance is modeled. Native ARINA counting
58
+ statistics need independent experimental characterization.
59
+
60
+ Native GPU abTEM and accelerated test patterns were bit-identical. The fresh
61
+ scan propagation, diffuse response and integration took 6.94 seconds
62
+ on one RTX PRO 6000 GPU; setup, import and display time are excluded.
63
+ Independent check-flat normalized residual energies were 1.007–1.010,
64
+ with detector row/column lag-1 correlations within ±0.0013. These tests validate
65
+ this synthetic generator/calibration example, not real-detector behavior or the
66
+ absence of added or missed peaks in any denoised output.
67
+
68
+ Credit: **Serin Lee and Andrew Barnum**, [Au liquid-cell reference](https://doi.org/10.5281/zenodo.18167694),
69
+ for experimental inspiration. No reference experimental measurements are included.
4dstem/simulated_au_nanobeam_pg_dose1/SHA256SUMS ADDED
@@ -0,0 +1,19 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ e31341e39f936c3ff7ba439aaa1562365165fdebd622ddefb3ea3583f1c84901 README.md
2
+ 529c00e8b9d8da1c8c4ab1bd13ca333a9fa7b1649d9a812d67e16469b92120a2 au-scene.extxyz
3
+ cb7bc6068743ca23e7f50508ee363b5d358baba3cc5fa7f1190f30793d0f5964 calibration-check.csv
4
+ e75baa6ebb06038f0f24e92f1367200a4eeae7a2563875c290d9b779b5ea28da check-flats_data_000001.h5
5
+ 08c725ec05c1fabb82976c3bf3cb0135c779340826e8717ceb8be26d0c384434 check-flats_master.h5
6
+ 4d515ea386e5878ebb4a6fd9d09556206344ee907c767d9a289ceab44de99ab3 dark_data_000001.h5
7
+ 1038ab62e1cccff9d27df5f85c7815b01fae953b94b124f24bf79ee1b96194bb dark_master.h5
8
+ 5df8decab7e50dfd618c0d096f8a415b511e0e497dbc9c03a869ab193fa0ffcd detector-calibration.pt
9
+ e8ea2f609d3c405abf7622b1ff7a0b2f114c3555d557dc98feed1ccd6951fade detector-valid.pt
10
+ 662ea88e2d9e70419cbff27747ffdcc70626ea2a13f172a34e4762acaa2a8305 dose-1.0_data_000001.h5
11
+ e5944af32f6f92a1cc7169df12e36408cc86c30f95719cae056b4a56e94d6c80 dose-1.0_master.h5
12
+ cffcf31e10678bcd5d91a6f750f3e6713d06a1a45aa312a414f1fee8137ee012 flats_data_000001.h5
13
+ d1f957c54cd623839040697342ef706397f56f16b098d0da08d9a223d8b7aebd flats_master.h5
14
+ b33e3820340add3a8f295279e06ba521579587e8893b2abd8e91d9ace0716b6e generator-only.pt
15
+ a517d38291b837fad683051874e3ab8b7b82d09e1888e1f45ff08910f1d19e13 geometry.json
16
+ 35095b4ea696cd4051bdd5882c18029915a9315a3a6e36823699f983d49b843f meta.json
17
+ 56b93a7558d0a22ece0701c1d8c3dd1b06d7d334c6ac603b7d623b537e9b34c5 truth-events-dose-1.0_data_000001.h5
18
+ 0307c2b0f26ada4ee8ec21fe0c0810daad591c367cf584eb1b43b122f240c0b0 truth-events-dose-1.0_master.h5
19
+ d0813e9696f36c74cf7c1a7cd0e5bc738d881452133794c84bdfa598774002b1 validation.json
4dstem/simulated_au_nanobeam_pg_dose1/au-scene.extxyz ADDED
The diff for this file is too large to render. See raw diff
 
4dstem/simulated_au_nanobeam_pg_dose1/calibration-check.csv ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ flat_level_events,pair_difference_mean_square,detector_row_lag1_correlation,detector_col_lag1_correlation
2
+ 1.0,1.0098814964294434,-0.0002520309644751251,-0.0004203271819278598
3
+ 16.0,1.0073602199554443,0.00010113576718140393,0.0009969888487830758
4
+ 256.0,1.0076667070388794,-0.0004012604185845703,9.079735173145309e-05
5
+ 4096.0,1.0081920623779297,0.0006474191322922707,0.0005197123973630369
6
+ 32768.0,1.0080114603042603,-0.0012782798148691654,-0.00038350303657352924
4dstem/simulated_au_nanobeam_pg_dose1/check-flats_data_000001.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:e75baa6ebb06038f0f24e92f1367200a4eeae7a2563875c290d9b779b5ea28da
3
+ size 70711264
4dstem/simulated_au_nanobeam_pg_dose1/check-flats_master.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:08c725ec05c1fabb82976c3bf3cb0135c779340826e8717ceb8be26d0c384434
3
+ size 8112
4dstem/simulated_au_nanobeam_pg_dose1/dark_data_000001.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:4d515ea386e5878ebb4a6fd9d09556206344ee907c767d9a289ceab44de99ab3
3
+ size 62401428
4dstem/simulated_au_nanobeam_pg_dose1/dark_master.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:1038ab62e1cccff9d27df5f85c7815b01fae953b94b124f24bf79ee1b96194bb
3
+ size 8112
4dstem/simulated_au_nanobeam_pg_dose1/detector-calibration.pt ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:5df8decab7e50dfd618c0d096f8a415b511e0e497dbc9c03a869ab193fa0ffcd
3
+ size 482591
4dstem/simulated_au_nanobeam_pg_dose1/detector-valid.pt ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:e8ea2f609d3c405abf7622b1ff7a0b2f114c3555d557dc98feed1ccd6951fade
3
+ size 38490
4dstem/simulated_au_nanobeam_pg_dose1/dose-1.0_data_000001.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:662ea88e2d9e70419cbff27747ffdcc70626ea2a13f172a34e4762acaa2a8305
3
+ size 125563481
4dstem/simulated_au_nanobeam_pg_dose1/dose-1.0_master.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:e5944af32f6f92a1cc7169df12e36408cc86c30f95719cae056b4a56e94d6c80
3
+ size 8560
4dstem/simulated_au_nanobeam_pg_dose1/flats_data_000001.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:cffcf31e10678bcd5d91a6f750f3e6713d06a1a45aa312a414f1fee8137ee012
3
+ size 141415984
4dstem/simulated_au_nanobeam_pg_dose1/flats_master.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:d1f957c54cd623839040697342ef706397f56f16b098d0da08d9a223d8b7aebd
3
+ size 8112
4dstem/simulated_au_nanobeam_pg_dose1/generator-only.pt ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:b33e3820340add3a8f295279e06ba521579587e8893b2abd8e91d9ace0716b6e
3
+ size 481827
4dstem/simulated_au_nanobeam_pg_dose1/geometry.json ADDED
@@ -0,0 +1,98 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "scan_shape": [
3
+ 32,
4
+ 32
5
+ ],
6
+ "detector_shape": [
7
+ 192,
8
+ 192
9
+ ],
10
+ "detector_center": [
11
+ 98.56053351439273,
12
+ 100.36161400706591
13
+ ],
14
+ "radius_100_percent": 96,
15
+ "scan_step_A": 6.875,
16
+ "cell_A": [
17
+ 220,
18
+ 220,
19
+ 60
20
+ ],
21
+ "energy_eV": 300000,
22
+ "semiangle_mrad": 0.622,
23
+ "defocus_A": 0,
24
+ "grid": [
25
+ 1728,
26
+ 1728
27
+ ],
28
+ "slice_thickness_A": [
29
+ 2.0,
30
+ 2.0,
31
+ 2.0,
32
+ 2.0,
33
+ 2.0,
34
+ 2.0,
35
+ 2.0,
36
+ 2.0,
37
+ 2.0,
38
+ 2.0,
39
+ 2.0,
40
+ 2.0,
41
+ 2.0,
42
+ 2.0,
43
+ 2.0,
44
+ 2.0,
45
+ 2.0,
46
+ 2.0,
47
+ 2.0,
48
+ 2.0,
49
+ 2.0,
50
+ 2.0,
51
+ 2.0,
52
+ 2.0,
53
+ 2.0,
54
+ 2.0,
55
+ 2.0,
56
+ 2.0,
57
+ 2.0,
58
+ 2.0
59
+ ],
60
+ "angular_sampling_mrad": 0.3579543435950485,
61
+ "detector_integration": "4x4 simulated angular samples; native 192x192 output",
62
+ "projection": "infinite",
63
+ "lattice": "static; no frozen phonon convergence",
64
+ "diffuse_fraction": 0.25,
65
+ "diffuse_sigma_mrad": 4,
66
+ "liquid_model": "assumed angular convolution, not atomistic liquid/window physics",
67
+ "abtem_parity": {
68
+ "bit_identical": true,
69
+ "max_abs_error": 0.0,
70
+ "relative_l2": 0.0
71
+ },
72
+ "scan_seconds": 6.936930592637509,
73
+ "timing_scope": "propagation, diffuse response, detector integration; excludes setup/parity",
74
+ "axis_convention": "abTEM x,y mapped to scan/detector row,col in this example",
75
+ "realism": "physically motivated synthetic; not validated ARINA or matched to Serin",
76
+ "relative_doses": [
77
+ 1.0
78
+ ],
79
+ "incident_events_per_position": 90000,
80
+ "science_seeds": [
81
+ 1000
82
+ ],
83
+ "calibration_seeds": {
84
+ "dark": 2000,
85
+ "flat": 2001,
86
+ "check": 2002
87
+ },
88
+ "noise_model": "independent Poisson arrivals plus additive Gaussian ADU",
89
+ "versions": {
90
+ "denova": "0.0.1.dev318+g0b24283c8",
91
+ "abtem": "1.0.9",
92
+ "quantem.gpu": "0.0.1rc15",
93
+ "cupy": "14.2.0",
94
+ "abtem_cuda_module_sha256": "3d7a59c30f32762dacfd482486ec32e25e1fc8e83792c52ac612b85820b10478"
95
+ },
96
+ "storage": "QuantEM.GPU bitshuffle/LZ4 HDF5; lossless float32; one dose-1 expectation",
97
+ "data_credit": "Serin Lee and Andrew Barnum, Zenodo 10.5281/zenodo.18167694 (inspiration only)"
98
+ }
4dstem/simulated_au_nanobeam_pg_dose1/meta.json ADDED
@@ -0,0 +1,39 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "name": "Synthetic Au nanobeam Poisson-Gaussian dose 1.0",
3
+ "source": "abTEM-cuda synthetic Au nanobeam scan; assumed independent Poisson-Gaussian detector; no experimental measurements",
4
+ "date": "2026-10-11",
5
+ "sample": "Four static Au nanoparticles and an illustrative diffuse angular response",
6
+ "shape": [
7
+ 32,
8
+ 32,
9
+ 192,
10
+ 192
11
+ ],
12
+ "dtype": "float32",
13
+ "permission": {
14
+ "received": true,
15
+ "from": [
16
+ "bobleesj"
17
+ ],
18
+ "collectors": [
19
+ "Synthetic generator; no microscope acquisition"
20
+ ],
21
+ "date": "2026-10-11"
22
+ },
23
+ "sampling": [
24
+ 6.875,
25
+ 6.875,
26
+ 0.3579543435950485,
27
+ 0.3579543435950485
28
+ ],
29
+ "units": [
30
+ "angstrom",
31
+ "angstrom",
32
+ "mrad",
33
+ "mrad"
34
+ ],
35
+ "voltage_kV": 300,
36
+ "semiangle_mrad": 0.622,
37
+ "relative_dose": 1.0,
38
+ "credit": "Serin Lee and Andrew Barnum, DOI 10.5281/zenodo.18167694, experimental inspiration only"
39
+ }
4dstem/simulated_au_nanobeam_pg_dose1/truth-events-dose-1.0_data_000001.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:56b93a7558d0a22ece0701c1d8c3dd1b06d7d334c6ac603b7d623b537e9b34c5
3
+ size 126072312
4dstem/simulated_au_nanobeam_pg_dose1/truth-events-dose-1.0_master.h5 ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:0307c2b0f26ada4ee8ec21fe0c0810daad591c367cf584eb1b43b122f240c0b0
3
+ size 8568
4dstem/simulated_au_nanobeam_pg_dose1/validation.json ADDED
@@ -0,0 +1,32 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "shape": [
3
+ 32,
4
+ 32,
5
+ 192,
6
+ 192
7
+ ],
8
+ "dtype": "torch.float32",
9
+ "device": "cuda:0",
10
+ "invalid_detector_pixels": 4,
11
+ "science_seed_replay_bit_exact": true,
12
+ "gpu_save_load_bit_exact": true,
13
+ "gain_relative_rmse": 0.08756064623594284,
14
+ "offset_adu_rmse": 0.026404233649373055,
15
+ "read_noise_adu_rmse": 0.018843846395611763,
16
+ "sampling": [
17
+ 6.875,
18
+ 6.875,
19
+ 0.3579543435950485,
20
+ 0.3579543435950485
21
+ ],
22
+ "units": [
23
+ "angstrom",
24
+ "angstrom",
25
+ "mrad",
26
+ "mrad"
27
+ ],
28
+ "calibration_sources": {
29
+ "flats": "4dstem-tutorial/flats_master.h5",
30
+ "dark": "4dstem-tutorial/dark_master.h5"
31
+ }
32
+ }