bec/csaxs_bec
0
0
Fork 2
Code Issues 17 Pull Requests 3 Actions Packages Projects Releases Wiki Activity

docs(flomni): fix stale example call in flomni_fermat_scan doc
CI for csaxs_bec / test (push) Successful in 2m16s
Details

Browse Source 
The Example: line was left out of sync with the parameter table fix
in 5141854 - argument order didn't match, and burst_at_each_point was
missing. Now mirrors the code docstring's example.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
x12sa
2026-09-15 16:52:06 +02:00
co-authored by Claude Sonnet 5
parent acdca82137
commit 2fc724d32d
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user/ptychography/flomni.md
+1 -1
View File
@@ -231,7 +231,7 @@ The basic scan function can be called by `scans.flomni_fermat_scan()` and offers
| burst_at_each_point (int) | Number of triggers and readouts at each point |
Example:
`scans.flomni_fermat_scan(fovx=20, fovy=25, cenx=0.02, ceny=0, zshift=0, angle=0, step=0.5, exp_time=0.01, frames_per_trigger=1)`
`scans.flomni_fermat_scan(fovx=10, fovy=10, cenx=0, ceny=0, step=1, zshift=0, angle=0, exp_time=0.1, frames_per_trigger=1, burst_at_each_point=1)`
`frames_per_trigger` controls burst acquisition for detectors generally.
Separately, the OMNY PandABox is configured as one of two distinct devices in