pcdsdevices.slits.Slits

class pcdsdevices.slits.Slits(*args, nominal_aperture=5.0, **kwargs)

Ophyd Device Components
Attribute	Class	Suffix	Kind	Notes
lightpath_summary	`SummarySignal`		omitted	Inherited from `LusiSlits`
nominal_aperture	`Signal`		normal	Inherited from `LusiSlits`
xwidth	`LusiSlitPositioner`		hinted	Inherited from `LusiSlits`
ywidth	`LusiSlitPositioner`		hinted	Inherited from `LusiSlits`
xcenter	`LusiSlitPositioner`		normal	Inherited from `LusiSlits`
ycenter	`LusiSlitPositioner`		normal	Inherited from `LusiSlits`
blade_top	`PCDSMotorBase`	`:TOP`	normal	Inherited from `LusiSlits`
blade_bottom	`PCDSMotorBase`	`:BOTTOM`	normal	Inherited from `LusiSlits`
blade_north	`PCDSMotorBase`	`:NORTH`	normal	Inherited from `LusiSlits`
blade_south	`PCDSMotorBase`	`:SOUTH`	normal	Inherited from `LusiSlits`
blocked	`EpicsSignalRO`	`:BLOCKED`	omitted	Inherited from `LusiSlits`
open_cmd	`EpicsSignal`	`:OPEN`	omitted	Inherited from `LusiSlits`
close_cmd	`EpicsSignal`	`:CLOSE`	omitted	Inherited from `LusiSlits`
block_cmd	`EpicsSignal`	`:BLOCK`	omitted	Inherited from `LusiSlits`

Methods

block(): Overlap the slits to block the beam.

calc_lightpath_state(xwidth_readback: float, ywidth_readback: float) → LightpathState: widths have different names due to different positioner class

camonitor()

Shows a live-updating motor position in the terminal.

This will be the value that is returned by the position attribute.

This method ends cleanly at a ctrl+c or after a call to end_monitor_thread(), which may be useful when this is called in a background thread.

close(): Close the slits to have an aperture of 0mm on each side.

configure(d: Dict[str, Any]) → Tuple[Dict[str, Any], Dict[str, Any]]

Configure the device for something during a run

This default implementation allows the user to change any of the configuration_attrs. Subclasses might override this to perform additional input validation, cleanup, etc.

Parameters:

d (dict) – The configuration dictionary. To specify the order that the changes should be made, use an OrderedDict.

Returns:

(old, new) tuple of dictionaries
Where old and new are pre- and post-configure configuration states.

describe() → OrderedDictType[str, Dict[str, Any]]

Provide schema and meta-data for read().

This keys in the OrderedDict this method returns must match the keys in the OrderedDict return by read().

This provides schema related information, (ex shape, dtype), the source (ex PV name), and if available, units, limits, precision etc.

Returns:: data_keys (OrderedDict) – The keys must be strings and the values must be dict-like with the event_model.event_descriptor.data_key schema.

end_monitor_thread(): Stop a camonitor() or wm_update() that is running in another thread.

get(**kwargs)

Get the value of all components in the device

Keyword arguments are passed onto each signal.get(). Components beginning with an underscore will not be included.

get_lightpath_state(use_cache: bool = True) → LightpathState

Return the current LightpathState

Returns:: LightpathState – a dataclass containing the Lightpath state

move(width, height=None, *, wait=False, moved_cb=None, timeout=None)

Set the dimensions of the width/height of the slits gap.

Parameters:

size (float or tuple of float) – Target size for slits in both x and y axis. If a square gap is desired, a single value can be entered. Otherwise, the width and height can both be entered, either as separate arguments or as a tuple.
wait (bool, optional) – If True, block until move is completed. Defaults to False.
timeout (float, optional) – Maximum time for the motion. If None is given, the default value of xwidth and ywidth positioners is used.
moved_cb (callable, optional) – Function to be run when the operation finishes. This callback should not expect any arguments or keywords.

Returns:

status (AndStatus) – Logical combination of the request to both horizontal and vertical motors.

mv(position, timeout=None, wait=False, log=True)

Absolute move to a position.

Parameters:

position – Desired end position.
timeout (float, optional) – If provided, the mover will throw an error if motion takes longer than timeout to complete. If omitted, the mover’s default timeout will be use.
wait (bool, optional) – If True, wait for motion completion before returning. Defaults to False.
log (bool, optional) – If True, logs the move at INFO level.

open(): Uses the built-in ‘OPEN’ record to move open the aperture.

post_elog_status(): Post device status to the primary elog, if possible.

read() → OrderedDictType[str, Dict[str, Any]]

Read data from the device.

This method is expected to be as instantaneous as possible, with any substantial acquisition time taken care of in trigger().

The OrderedDict returned by this method must have identical keys (in the same order) as the OrderedDict returned by describe().

By convention, the first key in the return is the ‘primary’ key and maybe used by heuristics in bluesky.

The values in the ordered dictionary must be dict (-likes) with the keys {'value', 'timestamp'}. The 'value' may have any type, the timestamp must be a float UNIX epoch timestamp in UTC.

Returns:: data (OrderedDict) – The keys must be strings and the values must be dict-like with the keys {'value', 'timestamp'}

read_configuration() → OrderedDictType[str, Dict[str, Any]]

Dictionary mapping names to value dicts with keys: value, timestamp

To control which fields are included, change the Component kinds on the device, or modify the configuration_attrs list.

remove(size=None, wait=False, timeout=None, **kwargs)

Open the slits to unblock the beam.

Parameters:

size (float, optional) – Open the slits to a specific size. Defaults to .nominal_aperture.
wait (bool, optional) – Wait for the status object to complete the move before returning.
timeout (float, optional) – Maximum time to wait for the motion. If None, the default timeout for this positioner is used.

Returns:

Status – ~ophyd.Status object based on move completion.