pcdsdevices.lodcm.SimFirstTower

class pcdsdevices.lodcm.SimFirstTower(prefix, *args, **kwargs)

Crystal Tower 1 Simulator for Testing.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
z1	FastMotor			normal	Inherited from CrystalTower1
x1	FastMotor			normal	Inherited from CrystalTower1
y1	FastMotor			normal	Inherited from CrystalTower1
th1	FastMotor			normal	Inherited from CrystalTower1
chi1	FastMotor			normal	Inherited from CrystalTower1
h1n	FastMotor			normal	Inherited from CrystalTower1
h1p	FastMotor			normal	Inherited from CrystalTower1
h1n_state	H1N	:H1N		hinted	Inherited from CrystalTower1
y1_state	Y1	:Y1		normal	Inherited from CrystalTower1
chi1_state	CHI1	:CHI1		normal	Inherited from CrystalTower1
diamond_reflection	EpicsSignalRO	:T1C:REF	Tower 1 Diamond crystal reflection	normal	Inherited from CrystalTower1
silicon_reflection	EpicsSignalRO	:T1Si:REF	Tower 1 Silicon crystal reflection	normal	Inherited from CrystalTower1
x1C (FCpt)	OffsetMotor		X1 motor offset for C [mm]	normal	Inherited from CrystalTower1
x1Si (FCpt)	OffsetMotor		X1 motor offset for Si [mm]	normal	Inherited from CrystalTower1
y1C (FCpt)	OffsetIMSWithPreset		Y1 motor offset for C [mm]	normal	Inherited from CrystalTower1
y1Si (FCpt)	OffsetIMSWithPreset		Y1 motor offset for Si [mm]	normal	Inherited from CrystalTower1
chi1C (FCpt)	OffsetIMSWithPreset		Chi 1 motor offset for C [deg]	normal	Inherited from CrystalTower1
chi1Si (FCpt)	OffsetIMSWithPreset		Chi 1 motor offset for Si [deg]	normal	Inherited from CrystalTower1
h1nC (FCpt)	OffsetIMSWithPreset		H1n motor offset for C [mm]	normal	Inherited from CrystalTower1
h1nSi (FCpt)	OffsetIMSWithPreset		H1n motor offset for Si [mm]	normal	Inherited from CrystalTower1
h1pC (FCpt)	OffsetMotor		H1p motor offset for C [mm]	normal	Inherited from CrystalTower1
h1pSi (FCpt)	OffsetMotor		H1p motor offset for Si [mm]	normal	Inherited from CrystalTower1

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.

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 Si or C.

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

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