pcdsdevices.ipm.IPMMotion

class pcdsdevices.ipm.IPMMotion(*args, **kwargs)

Standard intensity position monitor.

This contains two state devices, a target and a diode.

Ophyd Device Components
Attribute	Class	Suffix	Kind	Notes
lightpath_summary	`SummarySignal`		omitted	Inherited from `LightpathMixin`
target	`IPMTarget`	`:TARGET`	normal
diode	`IPMDiode`	`:DIODE`	normal

Methods

calc_lightpath_state(target_state: int | str, diode_state_state: int | str) → LightpathState

Create and return a LightpathState object containing information needed for lightpath, given a set of signal values

kwargs should be the same as the signal names provided in lightpath_cpts

Device logic goes here.

Returns:: LightpathState – a dataclass containing the Lightpath state

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.

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

insert(moved_cb=None, timeout=None, wait=False): Move both the target and diode in.

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(moved_cb=None, timeout=None, wait=False): Moves the target out of the beam and removes the diode if it is in an unknown state.

screen()

Open a screen for controlling the device.

Default behavior is the typhos screen, but this method can be overridden for more specialized screens.

stage_group_instances() → Iterator[OphydObject]: Yields an iterator of subdevices that should be staged.

status() → str: Returns a str with the current pv values for the device.

stop(*, success=False): Stop the Device and all (instantiated) subdevices

summary()

target_in(target_num, moved_cb=None, timeout=None, wait=False)

Moves the target to one of the target positions. There are 4 targets with different thickness and absorption/signal. The targets move vertically. To drive them in, use presets: ipm.target_in(x), where x = target number

Parameters:

target (int) – Number of which target to move in. Must be one of the valid target states: 1-4 or out: 5 (TARGET1, TARGET2, TARGET3, TARGET4, OUT) respectively
moved_cb (callable, optional) – Function to be run when the operation finishes. This callback should not expect any arguments or keywords.
timeout (float, optional) – Maximum time for the motion. If None is given, the default value of this positioner is used.
wait (bool) – If True, block until move is completed.

Returns:

status (MoveStatus)

trigger() → StatusBase

Trigger the device and return status object.

This method is responsible for implementing ‘trigger’ or ‘acquire’ functionality of this device.

If there is an appreciable time between triggering the device and it being able to be read (via the read() method) then this method is also responsible for arranging that the StatusBase object returned by this method is notified when the device is ready to be read.

If there is no delay between triggering and being readable, then this method must return a StatusBase object which is already completed.

Returns:: status (StatusBase) – StatusBase object which will be marked as complete when the device is ready to be read.

Attributes

configuration_attrs

connected

hints

kind

lightpath_cpts = ['target.state', 'diode.state.state']

md

needs_parent: list[type[OphydObject]] = [<class 'ophyd.signal.AttributeSignal'>, <class 'ophyd.signal.DerivedSignal'>, <class 'ophyd.areadetector.plugins.PluginBase'>, <class 'ophyd.pseudopos.PseudoSingle'>, <class 'pcdsdevices.signal.PVStateSignal'>, <class 'pcdsdevices.signal.AggregateSignal'>]

stage_group: list[Component] = None

subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})

transmission: Returns the combined transmission value of the target and diode.