mxcubecore.HardwareObjects.ESRF.ESRFBeam

BeamDefiner ESRF implementation class - methods to define the size and shape of the beam.

Classes

ESRFBeam(name)

Beam ESRF implementation

class mxcubecore.HardwareObjects.ESRF.ESRFBeam.ESRFBeam(name)

Bases: AbstractBeam

Beam ESRF implementation

get_available_size()

Get the available predefined beam definer configuration. :returns:

{“type”: [“apertures”], “values”: [labels]} or

{“type”: [“definer”], “values”: [labels]} or {“type”: [“width”, “height”], “values”:

[low_lim_w, high_lim_w, low_lim_h, high_lim_h]}

Return type:

(dict)

get_beam_position_on_screen()

Get the beam position :returns: Position (x, y) [pixel] :rtype: (tuple)

get_beam_size()

Returns:

two floats

Return type:

(tuple)

get_defined_beam_size()

Get the predefined beam labels and size. :returns:

Dictionary wiith list of avaiable beam size labels

and the corresponding size (width,height) tuples. {“label”: [str, str, …], “size”: [(w,h), (w,h), …]}

Return type:

(dict)

get_value()

Get the size (width and heigth) of the beam, its shape and

its label. The size is in mm.

Retunrs:

(tuple): (width, heigth, shape, name), with types

(float, float, Enum, str)

get_value_xml()

XMLRPC does not handle Enum, the shape is transformed to string

init()

Initialize hardware

set_value(size=None)

Set the beam size :param size: Width, heigth or

(str): Aperture or definer name.

Raises:

RuntimeError – Beam definer not configured Size out of the limits.