dodal.beamlines.i03#

Functions

`aperture_scatterguard`([wait_for_connection, ...])	Get the i03 aperture and scatterguard device, instantiate it if it hasn't already been.
`attenuator`([wait_for_connection, ...])	Get the i03 attenuator device, instantiate it if it hasn't already been.
`backlight`([wait_for_connection, ...])	Get the i03 backlight device, instantiate it if it hasn't already been.
`dcm`([wait_for_connection, fake_with_ophyd_sim])	Get the i03 DCM device, instantiate it if it hasn't already been.
`detector_motion`([wait_for_connection, ...])	Get the i03 detector motion device, instantiate it if it hasn't already been.
`eiger`([wait_for_connection, ...])	Get the i03 Eiger device, instantiate it if it hasn't already been.
`flux`([wait_for_connection, fake_with_ophyd_sim])	Get the i03 flux device, instantiate it if it hasn't already been.
`lower_gonio_positioner`([...])	Get the i03 lower gonio device, instantiate it if it hasn't already been.
`oav`([wait_for_connection, ...])	Get the i03 OAV device, instantiate it if it hasn't already been.
`panda`([wait_for_connection, fake_with_ophyd_sim])	Get the i03 panda device, instantiate it if it hasn't already been.
`panda_fast_grid_scan`([wait_for_connection, ...])	Get the i03 panda_fast_grid_scan device, instantiate it if it hasn't already been.
`pin_tip_detection`([wait_for_connection, ...])	Get the i03 pin tip detection device, instantiate it if it hasn't already been.
`qbpm1`([wait_for_connection, fake_with_ophyd_sim])	param wait_for_connection:
`robot`([wait_for_connection, fake_with_ophyd_sim])	Get the i03 robot device, instantiate it if it hasn't already been.
`s4_slit_gaps`([wait_for_connection, ...])	Get the i03 s4_slit_gaps device, instantiate it if it hasn't already been.
`sample_shutter`([wait_for_connection, ...])	Get the i03 sample shutter device, instantiate it if it hasn't already been.
`smargon`([wait_for_connection, ...])	Get the i03 Smargon device, instantiate it if it hasn't already been.
`synchrotron`([wait_for_connection, ...])	Get the i03 synchrotron device, instantiate it if it hasn't already been.
`thawer`([wait_for_connection, ...])	Get the i03 thawer, instantiate it if it hasn't already been.
`undulator`([wait_for_connection, ...])	Get the i03 undulator device, instantiate it if it hasn't already been.
`undulator_dcm`([wait_for_connection, ...])	Get the i03 undulator DCM device, instantiate it if it hasn't already been.
`vfm`([wait_for_connection, fake_with_ophyd_sim])	param wait_for_connection:
`vfm_mirror_voltages`([wait_for_connection, ...])	param wait_for_connection:
`webcam`([wait_for_connection, ...])	Get the i03 webcam, instantiate it if it hasn't already been.
`xbpm_feedback`([wait_for_connection, ...])	Get the i03 XBPM feeback device, instantiate it if it hasn't already been.
`xspress3mini`([wait_for_connection, ...])	Get the i03 Xspress3Mini device, instantiate it if it hasn't already been.
`zebra`([wait_for_connection, fake_with_ophyd_sim])	Get the i03 zebra device, instantiate it if it hasn't already been.
`zebra_fast_grid_scan`([wait_for_connection, ...])	Get the i03 zebra_fast_grid_scan device, instantiate it if it hasn't already been.
`zocalo`([wait_for_connection, ...])	Get the i03 ZocaloResults device, instantiate it if it hasn't already been.

dodal.beamlines.i03.aperture_scatterguard(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False, aperture_positions: AperturePositions | None = None) → ApertureScatterguard[source]#

Get the i03 aperture and scatterguard device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, it will return the existing object. If aperture_positions is specified, it will update them.

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)
aperture_positions (AperturePositions | None, default: None)

Return type:

ApertureScatterguard

dodal.beamlines.i03.attenuator(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Attenuator[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Attenuator

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

Get the i03 DCM device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, 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.i03.qbpm1(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → QBPM1[source]#

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

QBPM1

dodal.beamlines.i03.vfm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → FocusingMirrorWithStripes[source]#

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

FocusingMirrorWithStripes

dodal.beamlines.i03.vfm_mirror_voltages(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → VFMMirrorVoltages[source]#

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

VFMMirrorVoltages

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

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Backlight

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

Get the i03 detector motion device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, 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.i03.eiger(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False, params: DetectorParams | None = None) → EigerDetector[source]#

Get the i03 Eiger device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, 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.i03.zebra_fast_grid_scan(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → ZebraFastGridScan[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

ZebraFastGridScan

dodal.beamlines.i03.panda_fast_grid_scan(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → PandAFastGridScan[source]#

Get the i03 panda_fast_grid_scan device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, it will return the existing object. This is used instead of the zebra_fast_grid_scan device when using the PandA.

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

PandAFastGridScan

dodal.beamlines.i03.oav(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False, params: OAVConfigParams | None = None) → OAV[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)
params (OAVConfigParams | None, default: None)

Return type:

OAV

dodal.beamlines.i03.pin_tip_detection(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → PinTipDetection[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

PinTipDetection

dodal.beamlines.i03.smargon(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Smargon[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Smargon

dodal.beamlines.i03.s4_slit_gaps(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → S4SlitGaps[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

S4SlitGaps

dodal.beamlines.i03.synchrotron(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Synchrotron[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Synchrotron

dodal.beamlines.i03.undulator(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Undulator[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Undulator

dodal.beamlines.i03.undulator_dcm(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → UndulatorDCM[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

UndulatorDCM

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

Get the i03 zebra device, instantiate it if it hasn’t already been. If this is called when already instantiated in i03, 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.i03.xspress3mini(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Xspress3[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Xspress3

dodal.beamlines.i03.panda(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → HDFPanda[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

HDFPanda

dodal.beamlines.i03.sample_shutter(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → ZebraShutter[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

ZebraShutter

dodal.beamlines.i03.flux(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Flux[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Flux

dodal.beamlines.i03.xbpm_feedback(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → XBPMFeedback[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

XBPMFeedback

dodal.beamlines.i03.zocalo(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → ZocaloResults[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

ZocaloResults

dodal.beamlines.i03.robot(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → BartRobot[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

BartRobot

dodal.beamlines.i03.webcam(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Webcam[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Webcam

dodal.beamlines.i03.thawer(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → Thawer[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

Thawer

dodal.beamlines.i03.lower_gonio_positioner(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → XYZPositioner[source]#

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

Parameters:

wait_for_connection (bool, default: True)
fake_with_ophyd_sim (bool, default: False)

Return type:

XYZPositioner