diff --git a/csaxs_bec/scans/LamNIFermatScan.py b/csaxs_bec/scans/LamNIFermatScan.py index 74f8a55..128e372 100644 --- a/csaxs_bec/scans/LamNIFermatScan.py +++ b/csaxs_bec/scans/LamNIFermatScan.py @@ -230,7 +230,7 @@ class LamNIFermatScan(ScanBase, LamNIMixin): Examples: >>> scans.lamni_fermat_scan(fov_size=[20], step=0.5, exp_time=0.1) - >>> scans.lamni_fermat_scan(fov_size=[20, 25], center_x=0.02, center_y=0, shift_x=0, shift_y=0, angle=0, step=0.5, fov_circular=0, exp_time=0.1) + >>> scans.lamni_fermat_scan(fov_size=[20, 25], center_x=0.02, center_y=0, shift_x=0, shift_y=0, angle=0, step=0.5, fov_circular=0, exp_time=0.1, frames_per_trigger=1) """ super().__init__(parameter=parameter, frames_per_trigger=frames_per_trigger, exp_time=exp_time,**kwargs) diff --git a/csaxs_bec/scans/flomni_fermat_scan.py b/csaxs_bec/scans/flomni_fermat_scan.py index 889d86e..0adc88a 100644 --- a/csaxs_bec/scans/flomni_fermat_scan.py +++ b/csaxs_bec/scans/flomni_fermat_scan.py @@ -63,7 +63,7 @@ class FlomniFermatScan(SyncFlyScanBase): fovy(float) [um]: Fov in the piezo plane (i.e. piezo range). Max 100 um cenx(float) [um]: center position in x. ceny(float) [um]: center position in y. - exp_time(float) [s]: exposure time + exp_time(float) [s]: exposure time per burst frame frames_per_trigger(int) : Number of burst frames per point step(float) [um]: stepsize zshift(float) [um]: shift in z @@ -73,7 +73,7 @@ class FlomniFermatScan(SyncFlyScanBase): Returns: Examples: - >>> scans.flomni_fermat_scan(fovx=20, fovy=25, cenx=0.02, ceny=0, zshift=0, angle=0, step=0.5, exp_time=0.01) + >>> 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) """ super().__init__(parameter=parameter, exp_time=exp_time, frames_per_trigger=frames_per_trigger, **kwargs) diff --git a/docs/user/ptychography/flomni.md b/docs/user/ptychography/flomni.md index 232af8f..185519b 100644 --- a/docs/user/ptychography/flomni.md +++ b/docs/user/ptychography/flomni.md @@ -193,14 +193,15 @@ 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 | +| 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 | 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)` +`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)` #### Overview of the alignment steps diff --git a/docs/user/ptychography/omny.md b/docs/user/ptychography/omny.md index 686ac84..a126d53 100644 --- a/docs/user/ptychography/omny.md +++ b/docs/user/ptychography/omny.md @@ -327,14 +327,15 @@ The basic scan function can be called by `scans.omny_fermat_scan()` and offers a | 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 | +| 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 | Example: -`scans.omny_fermat_scan(fovx=20, fovy=25, cenx=0.02, ceny=0, zshift=0, angle=0, step=0.5, exp_time=0.01)` +`scans.omny_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)` #### Overview of the alignment steps