mxcubecore.HardwareObjects.ESRF.ESRFBeamDefiner#

Generic ESRF Beam Definer.

Example xml configuration:

<object class="ESRF.ESRFBeamDefiner"
  <username>Beam Definer</username>
  <beam_config>
     <name>4x4 um</name>
     <beam_size>0.004, 0.004</beam_size>
  </beam_config>
  <beam_config>
     <name>4x8 um</name>
     <beam_size>0.004, 0.008</beam_size>
  </beam_config>
  <default_size_name>4x4 um</default_size_name>
</object>

Classes

ESRFBeamDefiner(*args)

Generic ESRF beam definer implementation

class mxcubecore.HardwareObjects.ESRF.ESRFBeamDefiner.ESRFBeamDefiner(*args)[source]#

Bases: AbstractNState

Generic ESRF beam definer implementation

get_current_position_name()[source]#: Get the current beam size name. :returns: Current beam size name. :rtype: (str)

get_limits()[source]#: Return actuator low and high limits. :returns: two elements (low limit, high limit) tuple. :rtype: (tuple)

get_predefined_positions_list()[source]#: Get the list of all the beam size names. :returns: List of strings with the beam size names. :rtype: (list)

get_size()[source]#: Get the current beam size (horozontal and vertical). :returns: Curren beam size (horizontal, vertical) [mm]. :rtype: (tuple)

get_value()[source]#: Get the device value :returns: The current position Enum. :rtype: (Enum)

init()[source]#: Initilise the predefined values

init_config()[source]#: Get the configutarion from the file