docs(flomni): fix flomni_fermat_scan parameter table to match code
CI for csaxs_bec / test (push) Failing after 2m5s
CI for csaxs_bec / test (push) Failing after 2m5s
Reorders parameters to match the actual signature, adds the undocumented burst_at_each_point parameter, and corrects the corridor_size default (None/auto-estimated, not a literal 3 um). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FFeiCHv3qUxxssmP9Qzhom
This commit is contained in:
@@ -222,12 +222,13 @@ The basic scan function can be called by `scans.flomni_fermat_scan()` and offers
|
||||
| fovy (float) | Fov in the piezo plane (i.e. piezo range). Max 100 um |
|
||||
| cenx (float) | center position in x |
|
||||
| ceny (float) | center position in y |
|
||||
| exp_time (float) | exposure time per frame |
|
||||
| frames_per_trigger(int) | Number of burst frames per position |
|
||||
| step (float) | stepsize |
|
||||
| zshift (float) | shift in z |
|
||||
| angle (float) | rotation angle (will rotate first) |
|
||||
| corridor_size (float) | corridor size for the corridor optimization. Default 3 um |
|
||||
| corridor_size (float) | corridor size for the corridor optimization. Default `None` (auto-estimated; capped at 3 um) |
|
||||
| exp_time (float) | exposure time per frame |
|
||||
| frames_per_trigger (int) | Number of burst frames per position |
|
||||
| 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)`
|
||||
|
||||
Reference in New Issue
Block a user