from collections.abc import Hashable
import bluesky.plan_stubs as bps
from dodal.common import inject
from dodal.common.types import MsgGenerator
from dodal.devices.i10.rasor.rasor_motors import DetSlits, PaStage
from dodal.devices.i10.slits import I10Slits
from dodal.devices.motors import XYStage
from sm_bluesky.beamlines.i10.configuration.default_setting import (
DSD_DSU_OPENING_POS,
PIN_HOLE_OPEING_POS,
S5S6_OPENING_SIZE,
)
from sm_bluesky.common.plan_stubs import set_slit_size
from sm_bluesky.log import LOGGER
[docs]
def open_s5s6(
size: float = S5S6_OPENING_SIZE,
wait: bool = True,
group: Hashable | None = None,
slits: I10Slits = inject("slits"),
) -> MsgGenerator:
"""Open up clean up slits s5 and s6.
Parameters
----------
size: float
The size of their opening both x and y will set to the same value.
wait: bool
If this is true it will set both slits to move and wait until it get to
position.
group (optional): Hashable
If given this will be the group name that pass along to bluesky, which
can be use at a later time.
slits (optional): I10Stils
Slit to set tje soze of the opening to.
"""
if wait and group is None:
group = f"{slits.name}__wait"
yield from set_slit_size(slits.s5, size, wait=False, group=group)
yield from set_slit_size(slits.s6, size, wait=False, group=group)
if wait:
LOGGER.info("Waiting for s5 and s6 to finish move.")
yield from bps.wait(group=group)
[docs]
def open_dsd_dsu(
open_position: float = DSD_DSU_OPENING_POS,
wait: bool = True,
group: Hashable | None = None,
det_slits: DetSlits = inject("det_slits"),
) -> MsgGenerator:
"""Remove both detector slits
Parameters
----------
open_position: float
The position of the opening.
wait: bool
If this is true it will wait until all motions are done.
group (optional): Hashable
If given this will be the group name that pass along to bluesky, which
can be use at a later time.
det_slits (optional): DetSlits
slits to move open_position to.
"""
if wait and group is None:
group = f"{det_slits.name}_wait"
LOGGER.info("Opening Dsd and dsu, very slow motor may take minutes.")
yield from bps.abs_set(det_slits.upstream, open_position, group=group)
yield from bps.abs_set(det_slits.downstream, open_position, group=group)
if wait:
LOGGER.info("Waiting for dsd and dsu to finish move.")
yield from bps.wait(group=group)
[docs]
def remove_pin_hole(
open_position: float = PIN_HOLE_OPEING_POS,
wait: bool = True,
group: Hashable | None = None,
pin_hole: XYStage = inject("pin_hole"),
) -> MsgGenerator:
"""Move pin hole out of the way of the pin
Parameters
----------
open_position: float
The position of the opening.
wait: bool
If this is true it will wait until all motions are done.
group (optional): Hashable
If given this will be the group name that pass along to bluesky, which
can be use at a later time.
pin_hole (optional): XYStage
pin hole device to move.
"""
if wait and group is None:
group = f"{pin_hole.name}_wait"
LOGGER.info("Removing pin hole.")
yield from bps.abs_set(pin_hole.x, open_position, wait=False, group=group)
if wait:
LOGGER.info(f"Waiting for {pin_hole.name} to finish move.")
yield from bps.wait(group=group)
[docs]
def direct_beam_polan(
wait: bool = True,
group: Hashable | None = None,
pa_stage: PaStage = inject("pa_stage"),
) -> MsgGenerator:
"""Move polarization analyzer out of the way of the beam.
Parameters
----------
wait: bool
If this is true it will wait until all motions are done.
group (optional): Hashable
If given this will be the group name that pass along to bluesky, which
can be use at a later time.
pa_stage (optional): PaStage
Polarisation analyser stage to move.
"""
if wait and group is None:
group = f"{pa_stage.name}_wait"
LOGGER.info(f"Removing {pa_stage.name}.")
yield from bps.abs_set(pa_stage.eta, 0, wait=False, group=group)
yield from bps.abs_set(pa_stage.py, 0, wait=False, group=group)
yield from bps.abs_set(pa_stage.ttp, 0, wait=False, group=group)
yield from bps.abs_set(pa_stage.thp, 0, wait=False, group=group)
if wait:
LOGGER.info(f"Waiting for {pa_stage.name} to finish move.")
yield from bps.wait(group=group)
[docs]
def clear_beam_path(
wait: bool = True,
group: Hashable | None = None,
slits: I10Slits = inject("slits"),
det_slits: DetSlits = inject("det_slits"),
pin_hole: XYStage = inject("pin_hole"),
pa_stage: PaStage = inject("pa_stage"),
) -> MsgGenerator:
"""Move everything out of the way of the direct beam
Parameters
----------
wait: bool
If this is true it will wait until all motions are done.
group (optional): Hashable
If given this will be the group name that pass along to bluesky, which
can be use at a later time.
slits (optional): I10Slits
Slits to open.
det_selts (optional): DetSlits
Detector slits to open.
pin_hole (optional): XYStage
Pin hole to move out of the way of pin.
pa_stage (optional): PaStage
Polarisation analyser stage to move out of the way of the beam.
"""
if group is None:
group = "clear_beam_path"
yield from open_s5s6(wait=False, group=group, slits=slits)
yield from open_dsd_dsu(wait=False, group=group, det_slits=det_slits)
yield from remove_pin_hole(wait=False, group=group, pin_hole=pin_hole)
yield from direct_beam_polan(wait=False, group=group, pa_stage=pa_stage)
if wait:
yield from bps.wait(group=group)
