Skip to main content
Ctrl+K

dodal

  • Tutorials
  • How-to Guides
  • Explanations
  • Reference
  • GitHub
  • PyPI
  • Tutorials
  • How-to Guides
  • Explanations
  • Reference
  • GitHub
  • PyPI

Section Navigation

  • API
    • dodal.beamlines
      • dodal.beamlines.adsim
      • dodal.beamlines.aithre
      • dodal.beamlines.b01_1
      • dodal.beamlines.b07
      • dodal.beamlines.b07_1
      • dodal.beamlines.b07_shared
      • dodal.beamlines.b16
      • dodal.beamlines.b18
      • dodal.beamlines.b21
      • dodal.beamlines.i02_1
      • dodal.beamlines.i02_2
      • dodal.beamlines.i03
      • dodal.beamlines.i03_supervisor
      • dodal.beamlines.i04
      • dodal.beamlines.i05
      • dodal.beamlines.i05_1
      • dodal.beamlines.i05_shared
      • dodal.beamlines.i06_1
      • dodal.beamlines.i06_shared
      • dodal.beamlines.i07
      • dodal.beamlines.i09
      • dodal.beamlines.i09_1
      • dodal.beamlines.i09_1_shared
      • dodal.beamlines.i09_2
      • dodal.beamlines.i09_2_shared
      • dodal.beamlines.i10
      • dodal.beamlines.i10_1
      • dodal.beamlines.i10_shared
      • dodal.beamlines.i11
      • dodal.beamlines.i13_1
      • dodal.beamlines.i15
      • dodal.beamlines.i15_1
      • dodal.beamlines.i16
      • dodal.beamlines.i17
        • dodal.beamlines.i17.I17Grating
      • dodal.beamlines.i18
      • dodal.beamlines.i19_1
      • dodal.beamlines.i19_2
      • dodal.beamlines.i19_optics
      • dodal.beamlines.i20_1
      • dodal.beamlines.i21
      • dodal.beamlines.i22
      • dodal.beamlines.i23
        • dodal.beamlines.i23.I23DetectorPositions
      • dodal.beamlines.i24
      • dodal.beamlines.k07
        • dodal.beamlines.k07.Grating
      • dodal.beamlines.k11
      • dodal.beamlines.p38
      • dodal.beamlines.p45
      • dodal.beamlines.p60
      • dodal.beamlines.p99
      • dodal.beamlines.training_rig
    • dodal.common
      • dodal.common.EnabledDisabledUpper
      • dodal.common.InOutUpper
      • dodal.common.OnOffUpper
      • dodal.common.Rectangle2D
    • dodal.devices
      • dodal.devices.aithre_lasershaping
        • dodal.devices.aithre_lasershaping.goniometer
        • dodal.devices.aithre_lasershaping.laser_robot
      • dodal.devices.aperture
        • dodal.devices.aperture.Aperture
      • dodal.devices.aperturescatterguard
        • dodal.devices.aperturescatterguard.AperturePosition
        • dodal.devices.aperturescatterguard.ApertureScatterguard
        • dodal.devices.aperturescatterguard.ApertureValue
      • dodal.devices.areadetector
        • dodal.devices.areadetector.plugins
      • dodal.devices.attenuator
        • dodal.devices.attenuator.attenuator
        • dodal.devices.attenuator.filter
        • dodal.devices.attenuator.filter_selections
      • dodal.devices.backlight
        • dodal.devices.backlight.Backlight
      • dodal.devices.baton
        • dodal.devices.baton.Baton
      • dodal.devices.beamlines
        • dodal.devices.beamlines.b07
        • dodal.devices.beamlines.b07_1
        • dodal.devices.beamlines.b16
        • dodal.devices.beamlines.i02_1
        • dodal.devices.beamlines.i02_2
        • dodal.devices.beamlines.i03
        • dodal.devices.beamlines.i04
        • dodal.devices.beamlines.i05
        • dodal.devices.beamlines.i06_shared
        • dodal.devices.beamlines.i07
        • dodal.devices.beamlines.i09
        • dodal.devices.beamlines.i09_1
        • dodal.devices.beamlines.i09_1_shared
        • dodal.devices.beamlines.i09_2_shared
        • dodal.devices.beamlines.i10
        • dodal.devices.beamlines.i10_1
        • dodal.devices.beamlines.i11
        • dodal.devices.beamlines.i13_1
        • dodal.devices.beamlines.i15
        • dodal.devices.beamlines.i17
        • dodal.devices.beamlines.i18
        • dodal.devices.beamlines.i19
        • dodal.devices.beamlines.i20_1
        • dodal.devices.beamlines.i21
        • dodal.devices.beamlines.i22
        • dodal.devices.beamlines.i24
        • dodal.devices.beamlines.p60
        • dodal.devices.beamlines.p99
      • dodal.devices.beamsize
        • dodal.devices.beamsize.beamsize
      • dodal.devices.bimorph_mirror
        • dodal.devices.bimorph_mirror.BimorphMirror
        • dodal.devices.bimorph_mirror.BimorphMirrorChannel
        • dodal.devices.bimorph_mirror.BimorphMirrorMode
        • dodal.devices.bimorph_mirror.BimorphMirrorStatus
      • dodal.devices.collimation_table
        • dodal.devices.collimation_table.CollimationTable
      • dodal.devices.common_dcm
        • dodal.devices.common_dcm.DoubleCrystalMonochromator
        • dodal.devices.common_dcm.DoubleCrystalMonochromatorBase
        • dodal.devices.common_dcm.DoubleCrystalMonochromatorWithDSpacing
        • dodal.devices.common_dcm.PitchAndRollCrystal
        • dodal.devices.common_dcm.RollCrystal
        • dodal.devices.common_dcm.StationaryCrystal
      • dodal.devices.controllers
        • dodal.devices.controllers.ConstantDeadTimeController
      • dodal.devices.cryostream
        • dodal.devices.cryostream.CryoStreamGantry
        • dodal.devices.cryostream.CryoStreamSelection
        • dodal.devices.cryostream.OxfordCryoJet
        • dodal.devices.cryostream.OxfordCryoStream
        • dodal.devices.cryostream.TurboEnum
      • dodal.devices.current_amplifiers
        • dodal.devices.current_amplifiers.FemtoDDPCA
        • dodal.devices.current_amplifiers.Femto3xxGainTable
        • dodal.devices.current_amplifiers.Femto3xxRaiseTime
        • dodal.devices.current_amplifiers.CurrentAmp
        • dodal.devices.current_amplifiers.Femto3xxGainToCurrentTable
        • dodal.devices.current_amplifiers.CurrentAmpCounter
        • dodal.devices.current_amplifiers.CurrentAmpDet
        • dodal.devices.current_amplifiers.SR570
        • dodal.devices.current_amplifiers.SR570GainTable
        • dodal.devices.current_amplifiers.SR570FineGainTable
        • dodal.devices.current_amplifiers.SR570FullGainTable
        • dodal.devices.current_amplifiers.SR570GainToCurrentTable
        • dodal.devices.current_amplifiers.SR570RaiseTimeTable
        • dodal.devices.current_amplifiers.StruckScaler
      • dodal.devices.detector
        • dodal.devices.detector.DetectorParams
        • dodal.devices.detector.TriggerMode
        • dodal.devices.detector.DetectorDistanceToBeamXYConverter
      • dodal.devices.diamond_filter
        • dodal.devices.diamond_filter.DiamondFilter
        • dodal.devices.diamond_filter.I03Filters
        • dodal.devices.diamond_filter.I04Filters
      • dodal.devices.eiger
        • dodal.devices.eiger.EigerDetector
        • dodal.devices.eiger.EigerTimeouts
        • dodal.devices.eiger.InternalEigerTriggerMode
      • dodal.devices.eiger_odin
        • dodal.devices.eiger_odin.EigerFan
        • dodal.devices.eiger_odin.EigerOdin
        • dodal.devices.eiger_odin.OdinFileWriter
        • dodal.devices.eiger_odin.OdinMetaListener
        • dodal.devices.eiger_odin.OdinNode
        • dodal.devices.eiger_odin.OdinNodesStatus
      • dodal.devices.electron_analyser
        • dodal.devices.electron_analyser.base
        • dodal.devices.electron_analyser.specs
        • dodal.devices.electron_analyser.vgscienta
      • dodal.devices.eurotherm
        • dodal.devices.eurotherm.AutoManual
        • dodal.devices.eurotherm.EurothermAutotune
        • dodal.devices.eurotherm.EurothermGeneral
        • dodal.devices.eurotherm.EurothermPID
        • dodal.devices.eurotherm.EurothermUpdate
        • dodal.devices.eurotherm.UpdatingEurothermGeneral
        • dodal.devices.eurotherm.UpdatingEurothermPID
      • dodal.devices.fast_grid_scan
        • dodal.devices.fast_grid_scan.FastGridScanCommon
        • dodal.devices.fast_grid_scan.FastGridScanThreeD
        • dodal.devices.fast_grid_scan.GridAxis
        • dodal.devices.fast_grid_scan.GridScanParamsCommon
        • dodal.devices.fast_grid_scan.GridScanParamsThreeD
        • dodal.devices.fast_grid_scan.MotionProgram
        • dodal.devices.fast_grid_scan.PandAFastGridScan
        • dodal.devices.fast_grid_scan.PandAGridScanParams
        • dodal.devices.fast_grid_scan.WithDwellTime
        • dodal.devices.fast_grid_scan.ZebraFastGridScanThreeD
        • dodal.devices.fast_grid_scan.ZebraGridScanParamsThreeD
      • dodal.devices.fast_shutter
        • dodal.devices.fast_shutter.DualFastShutter
        • dodal.devices.fast_shutter.FastShutter
        • dodal.devices.fast_shutter.GenericFastShutter
      • dodal.devices.fluorescence_detector_motion
        • dodal.devices.fluorescence_detector_motion.FluorescenceDetector
      • dodal.devices.flux
        • dodal.devices.flux.Flux
      • dodal.devices.focusing_mirror
        • dodal.devices.focusing_mirror.FocusingMirror
        • dodal.devices.focusing_mirror.FocusingMirrorWithPiezo
        • dodal.devices.focusing_mirror.FocusingMirrorWithStripes
        • dodal.devices.focusing_mirror.MirrorStripe
        • dodal.devices.focusing_mirror.MirrorStripeConfiguration
        • dodal.devices.focusing_mirror.MirrorType
        • dodal.devices.focusing_mirror.MirrorVoltageDemand
        • dodal.devices.focusing_mirror.MirrorVoltages
        • dodal.devices.focusing_mirror.SimpleMirror
        • dodal.devices.focusing_mirror.SingleMirrorVoltage
      • dodal.devices.hutch_shutter
        • dodal.devices.hutch_shutter.HutchInterlock
        • dodal.devices.hutch_shutter.HutchShutter
        • dodal.devices.hutch_shutter.ShutterDemand
        • dodal.devices.hutch_shutter.ShutterState
      • dodal.devices.insertion_device
        • dodal.devices.insertion_device.Apple2
        • dodal.devices.insertion_device.Apple2Controller
        • dodal.devices.insertion_device.Apple2EnforceLHMoveController
        • dodal.devices.insertion_device.AppleKnotController
        • dodal.devices.insertion_device.AppleKnotPathFinder
        • dodal.devices.insertion_device.UndulatorGap
        • dodal.devices.insertion_device.UndulatorPhaseAxes
        • dodal.devices.insertion_device.UndulatorJawPhase
        • dodal.devices.insertion_device.Apple2Val
        • dodal.devices.insertion_device.Apple2PhasesVal
        • dodal.devices.insertion_device.LookupTable
        • dodal.devices.insertion_device.LookupTableColumnConfig
        • dodal.devices.insertion_device.InsertionDeviceEnergy
        • dodal.devices.insertion_device.InsertionDevicePolarisation
        • dodal.devices.insertion_device.BeamEnergy
        • dodal.devices.insertion_device.UndulatorLockedPhaseAxes
        • dodal.devices.insertion_device.EnergyCoverage
        • dodal.devices.insertion_device.Pol
        • dodal.devices.insertion_device.EnabledDisabledUpper
        • dodal.devices.insertion_device.UndulatorGateStatus
        • dodal.devices.insertion_device.Apple2LockedPhasesVal
        • dodal.devices.insertion_device.EnergyMotorLookup
        • dodal.devices.insertion_device.ConfigServerEnergyMotorLookup
        • dodal.devices.insertion_device.EnergyMotorConvertor
        • dodal.devices.insertion_device.UnstoppableMotor
        • dodal.devices.insertion_device.InsertionDeviceEnergyBase
      • dodal.devices.ipin
        • dodal.devices.ipin.IPin
        • dodal.devices.ipin.IPinGain
      • dodal.devices.linkam3
        • dodal.devices.linkam3.Linkam3
        • dodal.devices.linkam3.PumpControl
      • dodal.devices.motors
        • dodal.devices.motors.SixAxisGonio
        • dodal.devices.motors.SixAxisGonioKappaPhi
        • dodal.devices.motors.Stage
        • dodal.devices.motors.XThetaStage
        • dodal.devices.motors.XYPhiStage
        • dodal.devices.motors.XYPitchStage
        • dodal.devices.motors.XYRollStage
        • dodal.devices.motors.XYStage
        • dodal.devices.motors.XYZOmegaStage
        • dodal.devices.motors.XYZPitchYawRollStage
        • dodal.devices.motors.XYZPitchYawStage
        • dodal.devices.motors.XYZPolarAzimuthStage
        • dodal.devices.motors.XYZPolarAzimuthTiltStage
        • dodal.devices.motors.XYZPolarStage
        • dodal.devices.motors.XYZStage
        • dodal.devices.motors.XYZThetaStage
        • dodal.devices.motors.YZStage
      • dodal.devices.mx_phase1
        • dodal.devices.mx_phase1.beamstop
      • dodal.devices.oav
        • dodal.devices.oav.oav_calculations
        • dodal.devices.oav.oav_detector
        • dodal.devices.oav.oav_parameters
        • dodal.devices.oav.oav_to_redis_forwarder
        • dodal.devices.oav.pin_image_recognition
        • dodal.devices.oav.snapshots
        • dodal.devices.oav.utils
      • dodal.devices.p45
        • dodal.devices.p45.SampleTheta
        • dodal.devices.p45.SampleY
        • dodal.devices.p45.TomoStageWithStretchAndSkew
      • dodal.devices.pgm
        • dodal.devices.pgm.PlaneGratingMonochromator
      • dodal.devices.positioner
        • dodal.devices.positioner.Positioner1D
      • dodal.devices.pressure_jump_cell
        • dodal.devices.pressure_jump_cell.AllValvesControl
        • dodal.devices.pressure_jump_cell.BusyMock
        • dodal.devices.pressure_jump_cell.DoJump
        • dodal.devices.pressure_jump_cell.FastValveControlRequest
        • dodal.devices.pressure_jump_cell.FastValveState
        • dodal.devices.pressure_jump_cell.PressureJumpCell
        • dodal.devices.pressure_jump_cell.PressureJumpCellController
        • dodal.devices.pressure_jump_cell.PressureTransducer
        • dodal.devices.pressure_jump_cell.Pump
        • dodal.devices.pressure_jump_cell.PumpMotorDirectionState
        • dodal.devices.pressure_jump_cell.PumpState
        • dodal.devices.pressure_jump_cell.ValveControl
        • dodal.devices.pressure_jump_cell.ValveControlRequest
        • dodal.devices.pressure_jump_cell.ValveOpenSeqRequest
        • dodal.devices.pressure_jump_cell.ValveState
      • dodal.devices.qbpm
        • dodal.devices.qbpm.QBPM
      • dodal.devices.robot
        • dodal.devices.robot.BartRobot
        • dodal.devices.robot.BeamlineStatus
        • dodal.devices.robot.ErrorStatus
        • dodal.devices.robot.PinMounted
        • dodal.devices.robot.SampleLocation
      • dodal.devices.s4_slit_gaps
        • dodal.devices.s4_slit_gaps.S4SlitGaps
      • dodal.devices.scintillator
        • dodal.devices.scintillator.InOut
        • dodal.devices.scintillator.Scintillator
      • dodal.devices.selectable_source
        • dodal.devices.selectable_source.SelectedSource
        • dodal.devices.selectable_source.SourceSelector
      • dodal.devices.slits
        • dodal.devices.slits.MinimalSlits
        • dodal.devices.slits.Slits
        • dodal.devices.slits.SlitsY
      • dodal.devices.smargon
        • dodal.devices.smargon.CombinedMove
        • dodal.devices.smargon.DeferMoves
        • dodal.devices.smargon.Smargon
        • dodal.devices.smargon.StubOffsets
        • dodal.devices.smargon.StubPosition
      • dodal.devices.status
      • dodal.devices.synchrotron
        • dodal.devices.synchrotron.Prefix
        • dodal.devices.synchrotron.Suffix
        • dodal.devices.synchrotron.Synchrotron
        • dodal.devices.synchrotron.SynchrotronMode
      • dodal.devices.temperture_controller
        • dodal.devices.temperture_controller.Lakeshore336
        • dodal.devices.temperture_controller.Lakeshore340
        • dodal.devices.temperture_controller.Lakeshore
      • dodal.devices.tetramm
        • dodal.devices.tetramm.TetrammChannels
        • dodal.devices.tetramm.TetrammController
        • dodal.devices.tetramm.TetrammDatasetDescriber
        • dodal.devices.tetramm.TetrammDetector
        • dodal.devices.tetramm.TetrammDriver
        • dodal.devices.tetramm.TetrammGeometry
        • dodal.devices.tetramm.TetrammRange
        • dodal.devices.tetramm.TetrammResolution
        • dodal.devices.tetramm.TetrammTrigger
      • dodal.devices.thawer
        • dodal.devices.thawer.Thawer
      • dodal.devices.turbo_slit
        • dodal.devices.turbo_slit.TurboSlit
      • dodal.devices.undulator
        • dodal.devices.undulator.BaseUndulator
        • dodal.devices.undulator.UndulatorInKeV
        • dodal.devices.undulator.UndulatorInMm
        • dodal.devices.undulator.UndulatorOrder
      • dodal.devices.util
        • dodal.devices.util.adjuster_plans
        • dodal.devices.util.epics_util
        • dodal.devices.util.lookup_tables
      • dodal.devices.v2f
        • dodal.devices.v2f.QDV2F
        • dodal.devices.v2f.V2FGain
      • dodal.devices.watsonmarlow323_pump
        • dodal.devices.watsonmarlow323_pump.WatsonMarlow323Pump
        • dodal.devices.watsonmarlow323_pump.WatsonMarlow323PumpDirection
        • dodal.devices.watsonmarlow323_pump.WatsonMarlow323PumpState
      • dodal.devices.webcam
        • dodal.devices.webcam.Webcam
      • dodal.devices.xbpm_feedback
        • dodal.devices.xbpm_feedback.Pause
        • dodal.devices.xbpm_feedback.XBPMFeedback
      • dodal.devices.xspress3
        • dodal.devices.xspress3.xspress3
        • dodal.devices.xspress3.xspress3_channel
      • dodal.devices.zebra
        • dodal.devices.zebra.zebra
        • dodal.devices.zebra.zebra_constants_mapping
        • dodal.devices.zebra.zebra_controlled_shutter
      • dodal.devices.zocalo
        • dodal.devices.zocalo.ZocaloResults
        • dodal.devices.zocalo.XrcResult
        • dodal.devices.zocalo.ZocaloTrigger
        • dodal.devices.zocalo.ZocaloStartInfo
        • dodal.devices.zocalo.ZocaloSource
    • dodal.parameters
      • dodal.parameters.experiment_parameter_base
        • dodal.parameters.experiment_parameter_base.AbstractExperimentParameterBase
        • dodal.parameters.experiment_parameter_base.AbstractExperimentWithBeamParams
    • dodal.plan_stubs
    • dodal.plans
  • Device Standards
  • Glossary
  • Standards
  • Style Guide
  • Index
  • Release Notes
  • Reference

Reference#

Technical reference material including APIs and release notes.

  • API
  • Device Standards
  • Glossary
  • Standards
  • Style Guide
  • Index
  • Release Notes

previous

Approved Reviewers

next

API
Edit on GitHub

This Page

  • Show Source

Built with the PyData Sphinx Theme 0.16.1.