dodal.devices.fast_grid_scan.GridAxis#

class dodal.devices.fast_grid_scan.GridAxis[source]#
Parameters:

  • __dataclass_self__ (PydanticDataclass)

  • args (Any)

  • kwargs (Any)

Methods

is_within(steps)

Determine whether a single axis coordinate is within the grid.

steps_to_motor_position(steps)

Gives the motor position based on steps, where steps are 0 indexed.

Attributes

end

Gives the point where the final frame is taken.

start

step_size_mm

full_steps

steps_to_motor_position(steps)[source]#

Gives the motor position based on steps, where steps are 0 indexed.

property end#

Gives the point where the final frame is taken.

is_within(steps: float)[source]#

Determine whether a single axis coordinate is within the grid. The coordinate is from a continuous coordinate space based on the XRC grid where the origin corresponds to the centre of the first grid box.

Parameters:

steps (float) – The coordinate to check.

Returns:

True if the coordinate falls within the grid.

Return type:

bool