pcdsdevices.areadetector.detectors.PCDSAreaDetectorTyphosBeamStats

class pcdsdevices.areadetector.detectors.PCDSAreaDetectorTyphosBeamStats(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

Adds in some PVs related to beam statistics, as well as a cross hair. Primarily intended for use in the laser control system.

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
manufacturer	EpicsSignalRO	Manufacturer_RBV		config	Inherited from PCDSAreaDetectorTyphosTrigger
camera_model	EpicsSignalRO	Model_RBV		normal	Inherited from PCDSAreaDetectorTyphosTrigger
sensor_size_x	EpicsSignalRO	MaxSizeX_RBV		config	Inherited from PCDSAreaDetectorTyphosTrigger
sensor_size_y	EpicsSignalRO	MaxSizeY_RBV		config	Inherited from PCDSAreaDetectorTyphosTrigger
data_type	EpicsSignalWithRBV	DataType		config	Inherited from PCDSAreaDetectorTyphosTrigger
exposure	EpicsSignalWithRBV	AcquireTime		config	Inherited from PCDSAreaDetectorTyphosTrigger
gain	EpicsSignalWithRBV	Gain		config	Inherited from PCDSAreaDetectorTyphosTrigger
num_images	EpicsSignalWithRBV	NumImages		config	Inherited from PCDSAreaDetectorTyphosTrigger
image_mode	EpicsSignalWithRBV	ImageMode		config	Inherited from PCDSAreaDetectorTyphosTrigger
trigger_mode	EpicsSignalWithRBV	TriggerMode		config	Inherited from PCDSAreaDetectorTyphosTrigger
acquisition_period	EpicsSignalWithRBV	AcquirePeriod		config	Inherited from PCDSAreaDetectorTyphosTrigger
bin_x	EpicsSignalWithRBV	BinX		config	Inherited from PCDSAreaDetectorTyphosTrigger
bin_y	EpicsSignalWithRBV	BinY		config	Inherited from PCDSAreaDetectorTyphosTrigger
region_start_x	EpicsSignalWithRBV	MinX		config	Inherited from PCDSAreaDetectorTyphosTrigger
region_size_x	EpicsSignalWithRBV	SizeX		config	Inherited from PCDSAreaDetectorTyphosTrigger
region_start_y	EpicsSignalWithRBV	MinY		config	Inherited from PCDSAreaDetectorTyphosTrigger
region_size_y	EpicsSignalWithRBV	SizeY		config	Inherited from PCDSAreaDetectorTyphosTrigger
acquire	EpicsSignal	Acquire		normal	Inherited from PCDSAreaDetectorTyphosTrigger
acquire_rbv	EpicsSignalRO	DetectorState_RBV		normal	Inherited from PCDSAreaDetectorTyphosTrigger
image_counter	EpicsSignalRO	NumImagesCounter_RBV		normal	Inherited from PCDSAreaDetectorTyphosTrigger
cam_viewer	AttributeSignal			normal	Inherited from PCDSAreaDetectorTyphosTrigger
event_code	EpicsSignalWithRBV	CamEventCode	Code to determine beam synchronization rate.	config	Inherited from PCDSAreaDetectorTyphosTrigger
event_rate	EpicsSignalRO	CamRepRate_RBV	Current rate of the incoming triggers. Determined by event_code and the accelerator state.	config	Inherited from PCDSAreaDetectorTyphosTrigger
stats_enable	EpicsSignalWithRBV	Stats2:EnableCallbacks		config
centroid_x	EpicsSignalRO	Stats2:CentroidX_RBV		normal
centroid_y	EpicsSignalRO	Stats2:CentroidY_RBV		normal
sigma_x	EpicsSignalRO	Stats2:SigmaX_RBV		normal
sigma_y	EpicsSignalRO	Stats2:SigmaY_RBV		normal
centroid_threshold	EpicsSignalWithRBV	Stats2:CentroidThreshold		config
centroid_enable	EpicsSignal	Stats2:ComputeCentroid		config
target_x	EpicsSignalWithRBV	Cross4:MinX		normal
target_y	EpicsSignalWithRBV	Cross4:MinY		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.

open_viewer()

Launch the python camera viewer for this camera.

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

Lean on open_viewer method

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