dodal.devices.fast_grid_scan.GridScanParamsCommon

class dodal.devices.fast_grid_scan.GridScanParamsCommon

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 in 2d or 3d.

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][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

Methods

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

model_config	Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
x_axis
y_axis
z_axis
x_steps
y_steps
x_step_size_mm
y_step_size_mm
x_start_mm
y1_start_mm
z1_start_mm
set_stub_offsets
transmission_fraction

grid_position_to_motor_position(grid_position: ndarray) → ndarray

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. The origin is at the centre of the first grid box

Return type:

ndarray

Returns:

The motor position this corresponds to.

Raises:

IndexError if the desired position is outside the grid. –