pcdsdevices.lasers.qmini.QminiSpectrometer

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

Qmini Spectrometer

Device for the Qmini spectrometer by RGB Photonics.

Parameters:

• prefix (str) – Base prefix of the Qmini

• name (str) – Name of Qmini object

Ophyd Device Components

Attribute	Class	Suffix	Docs	Kind	Notes
status	EpicsSignalRO	:STATUS		normal
temperature	EpicsSignalRO	:TEMP		config
exposure	EpicsSignal	:GET_EXPOSURE_TIME		config
trig_mode	EpicsSignal	:TRIG_MODE_RBV		config
trig_delay	EpicsSignal	:GET_TRIG_DELAY		config
trig_pin	EpicsSignal	:TRIG_PIN_RBV		config
trig_edge	EpicsSignal	:TRIG_EDGE_RBV		config
trig_enable	EpicsSignal	:GET_TRIG_ENABLE		config
acquisition_mode	EpicsSignal	:SOFT_TRIGGER_MODE		config
exposures_to_average	EpicsSignal	:SET_AVG_CNT		config
force_trig	EpicsSignal	:START_EXPOSURE.PROC		config
reset	EpicsSignal	:CLEAR_SPECTROMETER		config
spectrum	EpicsSignalRO	:SPECTRUM		normal
wavelengths	EpicsSignalRO	:WAVELENGTHS		normal
model	EpicsSignalRO	:MODEL_CODE		config
serial_number	EpicsSignalRO	:SERIAL_NUMBER		config
adjust_offset	EpicsSignal	:ADJUST_OFFSET		omitted
correct_nonlinearity	EpicsSignal	:CORRECT_NONLINEARITY		omitted
remove_bad_pixels	EpicsSignal	:REMOVE_BAD_PIXELS		omitted
subtract_dark	EpicsSignal	:SUBTRACT_DARK		omitted
remove_temp_bad_pixels	EpicsSignal	:REMOVE_TEMP_BAD_PIXELS		omitted
normalize_exposure	EpicsSignal	:NORMALIZE_EXPOSURE		omitted
sensitivity_cal	EpicsSignal	:SENSITIVITY_CAL		omitted
correct_prnu	EpicsSignal	:CORRECT_PRNU		omitted
additional_filtering	EpicsSignal	:ADDITIONAL_FILTERING		omitted
scale_to_16_bit	EpicsSignal	:SCALE_TO_16BIT		omitted
set_processing_steps	EpicsSignal	:SET_PROCESSING_STEPS		omitted
get_processing_steps	EpicsSignalRO	:GET_PROCESSING_STEPS		omitted
fit_on	EpicsSignal	:FIT_ON		config
fit_width	EpicsSignal	:WIDTH		config
w0_guess	EpicsSignal	:W0_GUESS		config
w0_fit	EpicsSignalRO	:W0_FIT		normal
fit_fwhm	EpicsSignalRO	:FWHM		config
fit_amplitude	EpicsSignalRO	:AMPLITUDE		config
fit_stdev	EpicsSignalRO	:STDEV		config
fit_chisq	EpicsSignalRO	:CHISQ		config

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