dodal.beamlines.i24#

Functions

aperture([wait_for_connection, ...])

Get the i24 aperture device, instantiate it if it hasn't already been.

attenuator([wait_for_connection, ...])

Get a read-only attenuator device for i24, instantiate it if it hasn't already been.

backlight([wait_for_connection, ...])

Get the i24 backlight device, instantiate it if it hasn't already been.

beamstop([wait_for_connection, ...])

Get the i24 beamstop device, instantiate it if it hasn't already been.

dcm([wait_for_connection, fake_with_ophyd_sim])

Get the i24 DCM device, instantiate it if it hasn't already been.

detector_motion([wait_for_connection, ...])

Get the i24 detector motion device, instantiate it if it hasn't already been.

eiger([wait_for_connection, ...])

Get the i24 Eiger device, instantiate it if it hasn't already been.

eiger_beam_center([wait_for_connection, ...])

A device for setting/reading the beamcenter from the eiger on i24.

focus_mirrors([wait_for_connection, ...])

Get the i24 focus mirror devise to find the beam size.

oav([wait_for_connection, fake_with_ophyd_sim])

pilatus_beam_center([wait_for_connection, ...])

A device for setting/reading the beamcenter from the pilatus on i24.

pilatus_metadata([wait_for_connection, ...])

A small pilatus driver device for figuring out the filename template.

pmac([wait_for_connection, fake_with_ophyd_sim])

Get the i24 PMAC device, instantiate it if it hasn't already been.

shutter([wait_for_connection, ...])

Get the i24 hutch shutter device, instantiate it if it hasn't already been.

vgonio([wait_for_connection, ...])

Get the i24 vertical goniometer device, instantiate it if it hasn't already been.

zebra([wait_for_connection, fake_with_ophyd_sim])

Get the i24 zebra device, instantiate it if it hasn't already been.
dodal.beamlines.i24.attenuator(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → ReadOnlyAttenuator[source]#

Get a read-only attenuator device for i24, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

ReadOnlyAttenuator

dodal.beamlines.i24.aperture(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Aperture[source]#

Get the i24 aperture device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

Aperture

dodal.beamlines.i24.beamstop(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Beamstop[source]#

Get the i24 beamstop device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

Beamstop

dodal.beamlines.i24.backlight(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DualBacklight[source]#

Get the i24 backlight device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

DualBacklight

dodal.beamlines.i24.detector_motion(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DetectorMotion[source]#

Get the i24 detector motion device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

DetectorMotion

dodal.beamlines.i24.dcm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DCM[source]#

Get the i24 DCM device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

DCM

dodal.beamlines.i24.eiger(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False, params: DetectorParams | None = None) → EigerDetector[source]#

Get the i24 Eiger device, instantiate it if it hasn’t already been. If this is called when already instantiated, it will return the existing object. If called with params, will update those params to the Eiger object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

  • params (DetectorParams | None, default: None)

Return type:

EigerDetector

dodal.beamlines.i24.pmac(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → PMAC[source]#

Get the i24 PMAC device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

PMAC

dodal.beamlines.i24.oav(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → OAV[source]#
Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

OAV

dodal.beamlines.i24.vgonio(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → VerticalGoniometer[source]#

Get the i24 vertical goniometer device, instantiate it if it hasn’t already been. If this is called when already instantiated, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

VerticalGoniometer

dodal.beamlines.i24.zebra(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Zebra[source]#

Get the i24 zebra device, instantiate it if it hasn’t already been. If this is called when already instantiated in i24, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

Zebra

dodal.beamlines.i24.shutter(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → HutchShutter[source]#

Get the i24 hutch shutter device, instantiate it if it hasn’t already been. If this is called when already instantiated, it will return the existing object.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

HutchShutter

dodal.beamlines.i24.focus_mirrors(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → FocusMirrorsMode[source]#

Get the i24 focus mirror devise to find the beam size.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

FocusMirrorsMode

dodal.beamlines.i24.eiger_beam_center(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DetectorBeamCenter[source]#

A device for setting/reading the beamcenter from the eiger on i24.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

DetectorBeamCenter

dodal.beamlines.i24.pilatus_beam_center(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DetectorBeamCenter[source]#

A device for setting/reading the beamcenter from the pilatus on i24.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

DetectorBeamCenter

dodal.beamlines.i24.pilatus_metadata(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → PilatusMetadata[source]#

A small pilatus driver device for figuring out the filename template.

Parameters:

  • wait_for_connection (bool, default: True)

  • fake_with_ophyd_sim (bool, default: False)

Return type:

PilatusMetadata