dodal.beamlines.i24#

Functions

`aperture`([wait_for_connection, ...])	Get the i24 aperture device, 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.
`oav`([wait_for_connection, fake_with_ophyd_sim])
`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 vgonio 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.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) → VGonio[source]#

Get the i24 vgonio 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:

VGonio

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