mxcubecore.HardwareObjects.ESRF.ID232BeamDefiner

ID23-2 Beam Definer.

Example xml configuration:

<object class="ESRF.ESRFBeamDefiner"
  <username>Beam Definer</username>
  <object href="/bliss" role="controller"/>
  # bliss tranfocator object names
  <tf1>tf</tf1>
  <tf2>tf2</tf2>
  <beam_config>
     <name>4x4 um</name>
     <beam_size>0.004, 0.004</beam_size>
     <tf1>0 0 0 0 0 0 0 0 0</tf1>
     <tf2>0 0 1 1 0 0 0 0 0</tf2>
  </beam_config>
  <beam_config>
     <name>4x8 um</name>
     <beam_size>0.004, 0.008</beam_size>
     <tf1>0 0 0 0 0 0 0 0 0</tf1>
     <tf2>0 0 1 0 1 0 0 0 0</tf2>
  </beam_config>
  <default_size_name>4x4 um</default_size_name>
</object>

Classes

ID232BeamDefiner(*args)

ID23-2 beam definer implementattion

class mxcubecore.HardwareObjects.ESRF.ID232BeamDefiner.ID232BeamDefiner(*args)

Bases: ESRFBeamDefiner

ID23-2 beam definer implementattion

get_current_position_name()

Get the current beam size name. :returns: Current beam size name. :rtype: (str)

get_current_status()

Get the status of the transfocators. :returns: Tuple of two lists, giving the state for each lense :rtype: (tuple)

get_state()

Get the device state. :returns: Device state. :rtype: (enum ‘HardwareObjectState’)

init()

Initialisation

set_value(value, timeout=None)

Set the beam size. :param value: name of the beam size to set. :type value: str :param timeout: Timeout to wait for the execution to finish [s]. :type timeout: float

Raises:

RuntimeError – Cannot change beam size.

wait_status(status, timeout=None)

Wait timeout seconds until status reached :param status: Transfocator status to be reached. :type status: tuple :param timeout: Timeout [s]. Defaults to None. :type timeout: float