User Select

user_select

Standard selectors for going from user inputs to various scan resources and settings.

Re-usable in many different sorts of scans.

Attributes

MP_KEY module-attribute

MP_KEY = 'mirror_pitch'

UNDP_KEY_X module-attribute

UNDP_KEY_X = 'undp_x'

UNDP_KEY_Y module-attribute

UNDP_KEY_Y = 'undp_y'

Classes

Functions

select_diagnostic

select_diagnostic(device_type: Devices, location: Diagnostics) -> Union[YagCamera, Wave8]

Standard selector used to assemble the blop/xopt scans.

From some standard set of options, return the diagnostic device we'll be use using in the optimization.

Parameters:

Name	Type	Description	Default
device_type	Devices	One of "yag" or "wave8"	required
location	Diagnostics	One of "xcs1", "dg1", "dg2", "ip"	required

Source code in mfx/optimize/user_select.py

@validate_w_lowercase_args
def select_diagnostic(
    device_type: Devices,
    location: Diagnostics,
) -> Union[YagCamera, Wave8]:
    """
    Standard selector used to assemble the blop/xopt scans.

    From some standard set of options, return the
    diagnostic device we'll be use using in the optimization.

    Parameters
    ----------
    device_type : Devices
        One of "yag" or "wave8"
    location : Diagnostics
        One of "xcs1", "dg1", "dg2", "ip"
    """
    devices = init_devices()
    if device_type == "yag":
        if location == "xcs1":
            return devices["xcs_yag1"]
        else:
            return devices[f"mfx_{location}_yag"]
    elif device_type == "wave8":
        if location in ("dg1", "dg2"):
            return devices[f"mfx_{location}_wave8"]
        else:
            return devices["xcs_wave8"]
    else:
        raise RuntimeError(
            f"Invalid device_type {device_type} selected, pydantic broke?"
        )

select_goal

select_goal(device_type: Devices, location: Diagnostics, goal: Optional[float] = None, goal_2d: Optional[tuple[float, float]] = None, use_2d_markers: bool = False) -> Union[float, tuple[float, float]]

Select a goal for the alignment.

The goal is either a specific point on a 2d plane or on a 1d line.

Exactly one of goal, goal_2d, and use_2d_markers must be provided.

Some other combinations of arguments are not allowed and will raise ValueError.

Parameters:

Name	Type	Description	Default
device_type	Devices	One of "yag" or "wave8"	required
location	Diagnostics	One of "xcs1", "dg1", "dg2", "ip"	required
goal	float	1D goal to align to	None
goal_2d	tuple[float, float]	2D goal to align to	None
use_2d_markers	bool	Set to True to automatically select the goal from the camviewer makers.	False

Returns:

Name	Type	Description
goal	float or tuple[float, float]	The location to align to, given the settings.

Source code in mfx/optimize/user_select.py

@validate_w_lowercase_args
def select_goal(
    device_type: Devices,
    location: Diagnostics,
    goal: Optional[float] = None,
    goal_2d: Optional[tuple[float, float]] = None,
    use_2d_markers: bool = False,
) -> Union[float, tuple[float, float]]:
    """
    Select a goal for the alignment.

    The goal is either a specific point on a 2d plane or on
    a 1d line.

    Exactly one of goal, goal_2d, and use_2d_markers must be
    provided.

    Some other combinations of arguments are not allowed
    and will raise ValueError.

    Parameters
    ----------
    device_type : Devices
        One of "yag" or "wave8"
    location : Diagnostics
        One of "xcs1", "dg1", "dg2", "ip"
    goal : float, optional
        1D goal to align to
    goal_2d : tuple[float, float], optional
        2D goal to align to
    use_2d_markers : bool, optional
        Set to True to automatically select the goal from the
        camviewer makers.

    Returns
    -------
    goal : float or tuple[float, float]
        The location to align to, given the settings.
    """
    goal_count = sum((goal is not None, goal_2d is not None, use_2d_markers))
    if goal_count != 1:
        raise ValueError(f"Exactly one goal position must be chosen! Recieved {goal_count} goals!")

    # goal is compatible with any hardware
    if goal is not None:
        return goal

    # goal_2d is compatible with yags and wave8
    if goal_2d is not None:
        if device_type in ("yag", "wave8"):
            return goal_2d
        else:
            raise ValueError(
                f"goal_2d is only compatible with yag or wave8, not with {device_type}! "
                "Try providing goal (float) instead."
            )

    # use_2d_markers is compatible only with yags
    if use_2d_markers:
        if device_type == "yag":
            yag_camera = select_diagnostic(device_type=device_type, location=location)
            if location == "xcs1":
                # Shared YAG: uses marker2 at the goal
                return yag_camera.coords.specific_marker_target(2)
            # MFX YAG: uses marker1, marker2 at opposite slit corners
            return yag_camera.coords.standard_two_corners_target()
        else:
            raise ValueError(
                f"use_2d_markers is only compatible with yag, not with {device_type}! "
                "Try providing goal (float) instead."
            )

    raise RuntimeError("Invalid codepath in select_goal, how did you get here?")