\(\renewcommand\AA{\unicode{x212B}}\)

GetLiveInstrumentValue v1

../_images/ImageNotFound.png

Enable screenshots using DOCS_SCREENSHOTS in CMake

Summary

Get a live data value from and instrument via EPICS

See Also

ReflectometryReductionOneLiveData

Properties

Name

Direction

Type

Default

Description

Instrument

Input

string

Mandatory

Instrument to find live value for. Allowed values: [‘ALF’, ‘ARGUS’, ‘CHRONUS’, ‘CRISP’, ‘EMU’, ‘ENGIN-X’, ‘ENGIN-X_EVENT’, ‘GEM’, ‘HET’, ‘HIFI’, ‘HRPD’, ‘IMAT’, ‘INES’, ‘INTER’, ‘IRIS’, ‘LARMOR’, ‘LET’, ‘LET_EVENT’, ‘LOQ’, ‘MAPS’, ‘MARI’, ‘MERLIN’, ‘MERLIN_EVENT’, ‘MUSR’, ‘MUT’, ‘NGEM’, ‘NIMROD’, ‘OFFSPEC’, ‘OFFSPEC_EVENT’, ‘OSIRIS’, ‘PEARL’, ‘POLARIS’, ‘POLREF’, ‘SANDALS’, ‘SANS2D’, ‘SANS2D_EVENT’, ‘SURF’, ‘SXD’, ‘TFXA’, ‘TOSCA’, ‘VESUVIO’, ‘WISH’, ‘ZOOM’]

PropertyType

Input

string

Run

The type of property to find. Allowed values: [‘Run’, ‘Block’]

PropertyName

Input

string

TITLE

Name of value to find.

Value

Output

string

The live value from the instrument, or an empty string if not found

GetLiveInstrumentValue

This algorithm gets live values such as run title or theta from an instrument.

CaChannel must be installed for this algorithm to work. See the instructions here.

The instrument must also be on IBEX or have additional processes installed to supply the EPICS values. If it does not, you will get an error that the requested value could not be found.

Usage

GetLiveInstrumentValue(Instrument=’INTER’,PropertyType=’Block’,PropertyName=’Theta’)

Categories: AlgorithmIndex | Utility

Source

Python: GetLiveInstrumentValue.py