pcdsdevices.mirror.XOffsetMirrorXYState

class pcdsdevices.mirror.XOffsetMirrorXYState(*args, x_ranges: list[list[int]] = [], y_ranges: list[list[int]] = [], pitch_ranges: list[list[list[int]]] = [], **kwargs)

X-ray Offset Mirror with state positioners for both coating (y) and insertion (x). Thus, lightpath state calcs only require pitch ranges.

Currently (09/28/2022) services: mr1l3, mr1l4.

Parameters:

pitch_thresholds –

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
lightpath_summary	SummarySignal			omitted	Inherited from XOffsetMirrorState
coating	TwinCATMirrorStripe	:COATING:STATE	Control of the coating states via saved positions.	hinted	Inherited from XOffsetMirrorState
y_up	BeckhoffAxisNoOffset	:MMS:YUP	Yupstream master axis [um]	hinted	Inherited from XOffsetMirrorState
x_up	BeckhoffAxisNoOffset	:MMS:XUP	Xupstream master [um]	hinted	Inherited from XOffsetMirrorState
pitch	BeckhoffAxisNoOffset	:MMS:PITCH	Pitch stepper and piezo axes [urad]	hinted	Inherited from XOffsetMirrorState
bender	BeckhoffAxisNoOffset	:MMS:BENDER	Bender motor [um]	normal	Inherited from XOffsetMirrorState
y_dwn	BeckhoffAxisNoOffset	:MMS:YDWN	Ydwnstream slave axis [um]	config	Inherited from XOffsetMirrorState
x_dwn	BeckhoffAxisNoOffset	:MMS:XDWN	Xdwnstream slave axis [um]	config	Inherited from XOffsetMirrorState
gantry_x	PytmcSignal	:GANTRY_X	X gantry difference [um]	normal	Inherited from XOffsetMirrorState
gantry_y	PytmcSignal	:GANTRY_Y	Y gantry difference [um]	normal	Inherited from XOffsetMirrorState
couple_y	PytmcSignal	:COUPLE_Y	Couple Y motors [bool]	config	Inherited from XOffsetMirrorState
couple_x	PytmcSignal	:COUPLE_X	Couple X motors [bool]	config	Inherited from XOffsetMirrorState
decouple_y	PytmcSignal	:DECOUPLE_Y	Decouple Y motors [bool]	config	Inherited from XOffsetMirrorState
decouple_x	PytmcSignal	:DECOUPLE_X	Decouple X motors [bool]	config	Inherited from XOffsetMirrorState
couple_status_y	PytmcSignal	:ALREADY_COUPLED_Y		normal	Inherited from XOffsetMirrorState
couple_status_x	PytmcSignal	:ALREADY_COUPLED_X		normal	Inherited from XOffsetMirrorState
y_enc_rms	PytmcSignal	:ENC:Y:RMS	Yup encoder RMS deviation [um]	normal	Inherited from XOffsetMirrorState
x_enc_rms	PytmcSignal	:ENC:X:RMS	Xup encoder RMS deviation [um]	normal	Inherited from XOffsetMirrorState
pitch_enc_rms	PytmcSignal	:ENC:PITCH:RMS	Pitch encoder RMS deviation [urad]	normal	Inherited from XOffsetMirrorState
bender_enc_rms	PytmcSignal	:ENC:BENDER:RMS	Bender encoder RMS deviation [um]	normal	Inherited from XOffsetMirrorState
insertion	MirrorInsertState	:MMS:XUP:STATE	Control of mirror insertion via saved positions	normal

Methods

calc_lightpath_state(insertion_state: int, coating_state: int, pitch: float) → 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

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.

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()

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 = ['insertion.state', 'coating.state', 'pitch.user_readback']

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'})