pcdsdevices.lasers.zoomtelescope.ZoomTelescope

class pcdsdevices.lasers.zoomtelescope.ZoomTelescope(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

Zoom telescope

Device for the zoom telescope used in the MODS TILEs.

Parameters:

  • prefix (str) – Base prefix of the zoom telescope

  • name (str) – Name of zoom telescope object

Examples

zt = ZoomTelescope(‘LAS:ZOOM:01’, name=’LAS Zoom 1’)

zt.req_zoom.put(1.5) # set the zoom factor to 1.5

zt.tweak_val.put(0.05) # set tweak parameter to 0.05

zt.tweak_plus.put(1) # tweak the zoom by +zt.tweak_val

zt.tweak_minus.put(1) # tweak the zoom by +zt.tweak_val

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

_l2_p0

EpicsSignalRO

:CAL:L2:P0

omitted

_l2_p1

EpicsSignalRO

:CAL:L2:P1

omitted

_l3_p0

EpicsSignalRO

:CAL:L3:P0

omitted

_l3_p1

EpicsSignalRO

:CAL:L3:P1

omitted

_l3_p2

EpicsSignalRO

:CAL:L3:P2

omitted

_l3_p3

EpicsSignalRO

:CAL:L3:P3

omitted

_l3_p4

EpicsSignalRO

:CAL:L3:P4

omitted

_l3_p5

EpicsSignalRO

:CAL:L3:P5

omitted

min_zoom

EpicsSignalRO

:CAL:MIN_ZOOM

config

max_zoom

EpicsSignalRO

:CAL:MAX_ZOOM

config

req_zoom

EpicsSignal

:REQ_ZOOM

normal

tweak_plus

EpicsSignal

:TWEAK_ZOOM_PLUS.PROC

normal

tweak_minus

EpicsSignal

:TWEAK_ZOOM_MINUS.PROC

normal

tweak_val

EpicsSignal

:TWEAK

normal

permission

EpicsSignalRO

:PERMISSION_STATUS

normal

Methods

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.

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.

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
subscriptions: ClassVar[FrozenSet[str]] = frozenset({'acq_done'})