dodal.devices.fast_grid_scan.GridScanParamsCommon#

class dodal.devices.fast_grid_scan.GridScanParamsCommon[source]#

Common holder class for the parameters of a grid scan in a similar layout to EPICS. The parameters and functions of this class are common to both the zebra and panda triggered fast grid scans.

The grid specified is where data is taken e.g. it can be assumed the first frame is at x_start, y1_start, z1_start and subsequent frames are N*step_size away.

Parameters:: data (Any)

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

Parameters:: data (Any)

Methods

get_num_images()

get_param_positions()

rtype:: dict

grid_position_to_motor_position(grid_position)

Converts a grid position, given as steps in the x, y, z grid, to a real motor position.

Attributes

`is_3d_grid_scan`
`x_steps`
`y_steps`
`z_steps`
`x_step_size`
`y_step_size`
`z_step_size`
`x_start`
`y1_start`
`y2_start`
`z1_start`
`z2_start`
`x_axis`
`y_axis`
`z_axis`
`set_stub_offsets`
`transmission_fraction`

grid_position_to_motor_position(grid_position: ndarray) → ndarray[source]#

Converts a grid position, given as steps in the x, y, z grid, to a real motor position.

Parameters:: grid_position (ndarray) – The x, y, z position in grid steps
Return type:: ndarray
Returns:: The motor position this corresponds to.
Raises:: IndexError if the desired position is outside the grid.