pcdsdevices.lasers.qmini.QminiWithEvr

class pcdsdevices.lasers.qmini.QminiWithEvr(prefix, *args, evr_pv=None, evr_ch=None, **kwargs)

A class for Qmini spectrometers that use an EVR for hardware triggering.

Ophyd Device Components

Attribute

Class

Suffix

Docs

Kind

Notes

status

EpicsSignalRO

:STATUS

normal

Inherited from QminiSpectrometer

temperature

EpicsSignalRO

:TEMP

config

Inherited from QminiSpectrometer

exposure

EpicsSignal

:GET_EXPOSURE_TIME

config

Inherited from QminiSpectrometer

trig_mode

EpicsSignal

:TRIG_MODE_RBV

config

Inherited from QminiSpectrometer

trig_delay

EpicsSignal

:GET_TRIG_DELAY

config

Inherited from QminiSpectrometer

trig_pin

EpicsSignal

:TRIG_PIN_RBV

config

Inherited from QminiSpectrometer

trig_edge

EpicsSignal

:TRIG_EDGE_RBV

config

Inherited from QminiSpectrometer

trig_enable

EpicsSignal

:GET_TRIG_ENABLE

config

Inherited from QminiSpectrometer

acquisition_mode

EpicsSignal

:SOFT_TRIGGER_MODE

config

Inherited from QminiSpectrometer

exposures_to_average

EpicsSignal

:SET_AVG_CNT

config

Inherited from QminiSpectrometer

force_trig

EpicsSignal

:START_EXPOSURE.PROC

config

Inherited from QminiSpectrometer

reset

EpicsSignal

:CLEAR_SPECTROMETER

config

Inherited from QminiSpectrometer

spectrum

EpicsSignalRO

:SPECTRUM

normal

Inherited from QminiSpectrometer

wavelengths

EpicsSignalRO

:WAVELENGTHS

normal

Inherited from QminiSpectrometer

model

EpicsSignalRO

:MODEL_CODE

config

Inherited from QminiSpectrometer

serial_number

EpicsSignalRO

:SERIAL_NUMBER

config

Inherited from QminiSpectrometer

adjust_offset

EpicsSignal

:ADJUST_OFFSET

omitted

Inherited from QminiSpectrometer

correct_nonlinearity

EpicsSignal

:CORRECT_NONLINEARITY

omitted

Inherited from QminiSpectrometer

remove_bad_pixels

EpicsSignal

:REMOVE_BAD_PIXELS

omitted

Inherited from QminiSpectrometer

subtract_dark

EpicsSignal

:SUBTRACT_DARK

omitted

Inherited from QminiSpectrometer

remove_temp_bad_pixels

EpicsSignal

:REMOVE_TEMP_BAD_PIXELS

omitted

Inherited from QminiSpectrometer

normalize_exposure

EpicsSignal

:NORMALIZE_EXPOSURE

omitted

Inherited from QminiSpectrometer

sensitivity_cal

EpicsSignal

:SENSITIVITY_CAL

omitted

Inherited from QminiSpectrometer

correct_prnu

EpicsSignal

:CORRECT_PRNU

omitted

Inherited from QminiSpectrometer

additional_filtering

EpicsSignal

:ADDITIONAL_FILTERING

omitted

Inherited from QminiSpectrometer

scale_to_16_bit

EpicsSignal

:SCALE_TO_16BIT

omitted

Inherited from QminiSpectrometer

set_processing_steps

EpicsSignal

:SET_PROCESSING_STEPS

omitted

Inherited from QminiSpectrometer

get_processing_steps

EpicsSignalRO

:GET_PROCESSING_STEPS

omitted

Inherited from QminiSpectrometer

fit_on

EpicsSignal

:FIT_ON

config

Inherited from QminiSpectrometer

fit_width

EpicsSignal

:WIDTH

config

Inherited from QminiSpectrometer

w0_guess

EpicsSignal

:W0_GUESS

config

Inherited from QminiSpectrometer

w0_fit

EpicsSignalRO

:W0_FIT

normal

Inherited from QminiSpectrometer

fit_fwhm

EpicsSignalRO

:FWHM

config

Inherited from QminiSpectrometer

fit_amplitude

EpicsSignalRO

:AMPLITUDE

config

Inherited from QminiSpectrometer

fit_stdev

EpicsSignalRO

:STDEV

config

Inherited from QminiSpectrometer

fit_chisq

EpicsSignalRO

:CHISQ

config

Inherited from QminiSpectrometer

save_spectrum

AttributeSignal

omitted

Inherited from QminiSpectrometer

file_dest

Signal

omitted

Inherited from QminiSpectrometer

event_code (FCpt)

EpicsSignal

{self._evr_pv}:TRIG{self._evr_ch}:EC_RBV

config

evr_width (FCpt)

EpicsSignal

{self._evr_pv}:TRIG{self._evr_ch}:BW_TWIDCALC

config

evr_delay (FCpt)

EpicsSignal

{self._evr_pv}:TRIG{self._evr_ch}:BW_TDES

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.

save_data(file_dest: str = '')

Save the wavelength and spectrum PVs to a text file

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