Files
Jungfraujoch/docs/python_client/docs/GridScan.md
2025-05-28 18:49:27 +02:00

1.5 KiB

GridScan

Definition of a grid scan (mutually exclusive with rotation_axis)

Properties

Name Type Description Notes
n_fast int Number of elements in the fast direction
step_x_um float Step in grid along the fast direction. Can be negative. Positive number: left to right Negative number: right to left
step_y_um float Step in grid along the slow direction. Can be negative. Positive number: top to bottom Negative number: bottom to top
vertical bool If disabled: fast direction = X, slow direction = Y If enabled: fast direction = Y, slow direction = X [optional] [default to False]
snake bool Flip fast direction for every second row [optional] [default to False]

Example

from jfjoch_client.models.grid_scan import GridScan

# TODO update the JSON string below
json = "{}"
# create an instance of GridScan from a JSON string
grid_scan_instance = GridScan.from_json(json)
# print the JSON string representation of the object
print(GridScan.to_json())

# convert the object into a dict
grid_scan_dict = grid_scan_instance.to_dict()
# create an instance of GridScan from a dict
grid_scan_from_dict = GridScan.from_dict(grid_scan_dict)

[Back to Model list] [Back to API list] [Back to README]