dodal.beamlines.i04#

Functions

`aperture_scatterguard`([wait_for_connection, ...])	Get the i04 aperture and scatterguard device, instantiate it if it hasn't already been.
`attenuator`([wait_for_connection, ...])	Get the i04 attenuator device, instantiate it if it hasn't already been.
`backlight`([wait_for_connection, ...])	Get the i04 backlight device, instantiate it if it hasn't already been.
`beamstop`([wait_for_connection, ...])	Get the i04 beamstop device, instantiate it if it hasn't already been.
`dcm`([wait_for_connection, fake_with_ophyd_sim])	Get the i04 DCM device, instantiate it if it hasn't already been.
`detector_motion`([wait_for_connection, ...])	Get the i04 detector motion device, instantiate it if it hasn't already been.
`diamond_filter`([wait_for_connection, ...])	Get the i04 diamond filter device, instantiate it if it hasn't already been.
`eiger`([wait_for_connection, ...])	Get the i04 Eiger device, instantiate it if it hasn't already been.
`flux`([wait_for_connection, fake_with_ophyd_sim])	Get the i04 flux device, instantiate it if it hasn't already been.
`gonio_positioner`([wait_for_connection, ...])	Get the i04 lower_gonio_stages device, instantiate it if it hasn't already been.
`ipin`([wait_for_connection, fake_with_ophyd_sim])	Get the i04 ipin device, instantiate it if it hasn't already been.
`oav`([wait_for_connection, ...])	Get the i04 OAV device, instantiate it if it hasn't already been.
`oav_to_redis_forwarder`([...])	Get the i04 OAV to redis forwarder, instantiate it if it hasn't already been.
`robot`([wait_for_connection, fake_with_ophyd_sim])	Get the i04 robot device, instantiate it if it hasn't already been.
`s4_slit_gaps`([wait_for_connection, ...])	Get the i04 s4_slit_gaps device, instantiate it if it hasn't already been.
`sample_delivery_system`([...])	Get the i04 sample_delivery_system device, instantiate it if it hasn't already been.
`sample_shutter`([wait_for_connection, ...])	Get the i04 sample shutter device, instantiate it if it hasn't already been.
`smargon`([wait_for_connection, ...])	Get the i04 Smargon device, instantiate it if it hasn't already been.
`synchrotron`([wait_for_connection, ...])	Get the i04 synchrotron device, instantiate it if it hasn't already been.
`thawer`([wait_for_connection, ...])	Get the i04 thawer, instantiate it if it hasn't already been.
`transfocator`([wait_for_connection, ...])	Get the i04 transfocator device, instantiate it if it hasn't already been.
`undulator`([wait_for_connection, ...])	Get the i04 undulator device, instantiate it if it hasn't already been.
`xbpm_feedback`([wait_for_connection, ...])	Get the i04 xbpm_feedback device, instantiate it if it hasn't already been.
`zebra`([wait_for_connection, fake_with_ophyd_sim])	Get the i04 zebra device, instantiate it if it hasn't already been.
`zebra_fast_grid_scan`([wait_for_connection, ...])	Get the i04 zebra_fast_grid_scan device, instantiate it if it hasn't already been.

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

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

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

Parameters:

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

Return type:

XYZPositioner

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

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

Parameters:

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

Return type:

XYZPositioner

dodal.beamlines.i04.ipin(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → IPin[source]#

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

Parameters:

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

Return type:

IPin

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

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

Parameters:

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

Return type:

XYZPositioner

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

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

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

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

Parameters:

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

Return type:

Transfocator

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

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

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

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

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

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

Parameters:

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

Return type:

ApertureScatterguard

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

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

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

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

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

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

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

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

Parameters:

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

Return type:

OAV

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

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

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

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

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

Parameters:

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

Return type:

OAVToRedisForwarder

dodal.beamlines.i04.diamond_filter(wait_for_connection: bool = True, fake_with_ophyd_sim: bool = False) → DiamondFilter[I04Filters][source]#

Get the i04 diamond filter 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:

DiamondFilter[I04Filters]