pcdsdevices.lodcm.CrystalTower1
- class pcdsdevices.lodcm.CrystalTower1(prefix, *args, **kwargs)
LODCM Crystal Tower 1.
Has the Si and C crystals with 2 angles and 5 linear motions. The
h1n_statebrings the crystal into the beam, moving horizontally (normal to the beam and parallel to the ground). It is also the only axis that can fully clear the crystal assembly from the beam. If h1n state isOUTand if we were to insert into the beam, we would be aligned to the C crystal. They1_statebrings the crystal into the beam, moving vertically (normal to the beam and normal to the ground). Thechi1_staterotates the crystal assembly.- Parameters:
Ophyd Device Components Attribute
Class
Suffix
Docs
Kind
Notes
z1 (FCpt)
{self._hutch_prefix}:MON:MMS:04LOM Xtal1 Z
normal
x1 (FCpt)
{self._hutch_prefix}:MON:MMS:05LOM Xtal1 X
normal
y1 (FCpt)
{self._hutch_prefix}:MON:MMS:06LOM Xtal1 Y
normal
th1 (FCpt)
{self._hutch_prefix}:MON:MMS:07LOM Xtal1 Theta
normal
chi1 (FCpt)
{self._hutch_prefix}:MON:MMS:08LOM Xtal1 Chi
normal
h1n (FCpt)
{self._hutch_prefix}:MON:MMS:09LOM Xtal1 Hn
normal
h1p (FCpt)
{self._hutch_prefix}:MON:MMS:20LOM Xtal1 Hp
normal
h1n_state
:H1Nhinted
y1_state
:Y1normal
chi1_state
:CHI1normal
diamond_reflection
EpicsSignalRO:T1C:REFTower 1 Diamond crystal reflection
normal
silicon_reflection
EpicsSignalRO:T1Si:REFTower 1 Silicon crystal reflection
normal
x1C (FCpt)
X1 motor offset for C [mm]
normal
x1Si (FCpt)
X1 motor offset for Si [mm]
normal
y1C (FCpt)
Y1 motor offset for C [mm]
normal
y1Si (FCpt)
Y1 motor offset for Si [mm]
normal
chi1C (FCpt)
Chi 1 motor offset for C [deg]
normal
chi1Si (FCpt)
Chi 1 motor offset for Si [deg]
normal
h1nC (FCpt)
H1n motor offset for C [mm]
normal
h1nSi (FCpt)
H1n motor offset for Si [mm]
normal
h1pC (FCpt)
H1p motor offset for C [mm]
normal
h1pSi (FCpt)
H1p motor offset for Si [mm]
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
OrderedDictthis method returns must match the keys in theOrderedDictreturn byread().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_keyschema.
- 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_material()
Get the current material.
- Returns:
material (str) – Material of the crystal.
- Raises:
ValueError – When the material could not be determined or is something else other than
SiorC.
- get_reflection()
Get crystal’s reflection.
Tries to get the reflection depending on the material in use.
- Returns:
reflection (tuple)
- Raises:
ValueError – When cannot determine the reflection.
- is_diamond()
Check if tower 1 is with Diamond (C) material.
- is_silicon()
Check if tower 1 is with Silicon (Si) material.
- 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
OrderedDictreturned by this method must have identical keys (in the same order) as theOrderedDictreturned bydescribe().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_attrslist.
- 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.
- 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 theStatusBaseobject 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
StatusBaseobject which is already completed.- Returns:
status (StatusBase) –
StatusBaseobject which will be marked as complete when the device is ready to be read.
Attributes
- configuration_attrs
- connected
- hints
- kind