diff --git a/ophyd_devices/devices/device_list.md b/ophyd_devices/devices/device_list.md index 2369353..cbc92ef 100644 --- a/ophyd_devices/devices/device_list.md +++ b/ophyd_devices/devices/device_list.md @@ -3,19 +3,20 @@ ### ophyd_devices | Device | Documentation | Module | | :----- | :------------- | :------ | -| Andor3DetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| AravisDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| AttributePlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| AttrPlotPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| CamBase | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| CircularBuffPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| CodecPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ColorConvPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| Andor3DetectorCam |
ADAndor3 driver, https://github.com/areaDetector/ADAndor3

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(Andor3DetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| AravisDetectorCam |
ADAravis driver, https://github.com/areaDetector/ADAravis

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(AravisDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| AttributePlugin_V35 |
Plugin to extract NDArray attributes and publish their values over channel access,
https://areadetector.github.io/areaDetector/ADCore/NDPluginAttribute.html.

::
class MyDetector(ADBase):
attr = Cpt(AttributePlugin_V35, 'Attr1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| AttrPlotPlugin_V35 |
Plugin to retrieve NDAttribute values, cache them and expose them as a waveform,
https://areadetector.github.io/areaDetector/ADCore/NDPluginAttrPlot.html.

::
class MyDetector(ADBase):
attrplot = Cpt(AttrPlotPlugin_V35, 'AttrPlot1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| BadPixelPlugin |
Plugin to replace bad pixels in an NDArray,
https://areadetector.github.io/areaDetector/ADCore/NDPluginBadPixel.html.

::
class MyDetector(ADBase):
baxpixel = Cpt(BadPixelPlugin, 'BadPix1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| CamBase |
Base class for all camera drivers.
| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| CircularBuffPlugin_V35 |
Plugin to check a user-defined trigger condition has been met and output triggering NDArray,
https://areadetector.github.io/areaDetector/ADCore/NDPluginCircularBuff.html.

::
class MyDetector(ADBase):
cb = Cpt(CircularBuffPlugin_V35, 'CB1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| CodecPlugin_V35 |
Plugin to compress and decompress NDArray data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginCodec.html.

::
class MyDetector(ADBase):
codec = Cpt(CodecPlugin_V35, 'Codec1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ColorConvPlugin_V35 |
Plugin to convert the color mode of NDArray data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginColorConvert.html.

::

class MyDetector(ADBase):
cc = Cpt(ColorConvPlugin_V35, 'CC1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | | DelayGenerator | Delay Generator Stanford Research DG645. This implements an interface for the DG645 delay generator.

The DG645 has 8 channels, each with a delay and pulse width. The channels are implemented as DelayPair objects (AB etc.).

Signal pairs, e.g. AB, CD, EF, GH, are implemented as DelayPair objects. They
have a TTL pulse width, delay and a reference signal to which they are being triggered.
In addition, the io layer allows setting amplitude, offset and polarity for each pair.

Detailed information can be found in the manual:
https://www.thinksrs.com/downloads/pdfs/manuals/DG645m.pdf
| [ophyd_devices.devices.delay_generator_645](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/delay_generator_645.py) | | DelayPair |
Delay pair interface

Virtual motor interface to a pair of signals (on the frontpanel - AB/CD/EF/GH).
It offers a simple delay and pulse width interface.
| [ophyd_devices.devices.delay_generator_645](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/delay_generator_645.py) | | DelayStatic |
Static axis for the T0 output channel

It allows setting the logic levels, but the timing is fixed.
The signal is high after receiving the trigger until the end
of the holdoff period.
| [ophyd_devices.devices.delay_generator_645](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/delay_generator_645.py) | | DummyPositioner | Dummy Positioner to set AO, AI and ReferenceMO. | [ophyd_devices.devices.delay_generator_645](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/delay_generator_645.py) | -| EigerDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| EigerDetectorCam |
ADEiger driver, https://github.com/areaDetector/ADEiger

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(EigerDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | | EpicsDXPFalcon | All high-level DXP parameters for each channel | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | | EpicsDxpFalconMapping | Mapping mode parameters as defined in dxpMapping.template | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | | EpicsDXPFalconMultiElementSystem | System-wide parameters as defined in dxpMED.template | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | @@ -23,41 +24,43 @@ | EpicsMCARecord | EpicsMCARecord with addtional fields | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | | EpicsMotorEx | Extend EpicsMotor with extra configuration fields.
motor_done_move
motor_is_moving
| [ophyd_devices.devices.epics_motor_ex](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/epics_motor_ex.py) | | Falcon | Falcon base device | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | -| FFTPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| FileBase | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| FilePlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| GenICam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| HDF5Plugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ImagePlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| JPEGPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| MagickPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| FFTPlugin_V35 |
Plugin to compute 1-D or 2-D Fast Fourier Transforms,
https://areadetector.github.io/areaDetector/ADCore/NDPluginFFT.html.

::
class MyDetector(ADBase):
fft = Cpt(FFTPlugin_V35, 'FFT1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| FileBase |
File saving parameters.

It is not meant to be used directly, but rather through inheritance by camera drivers
with file saving support, e.g. PilatusDetectorCam and SLSDetectorCam
| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| FilePlugin_V35 |
Base class for all file plugins.
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| GatherNPlugin_V35 |
Part of GatherPlugin.
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| GatherPlugin_V35 |
Plugin to to gather NDArrays from multiple upstream plugins and merge them into a single stream,
https://areadetector.github.io/areaDetector/ADCore/NDPluginGather.html.

::
class MyGatherPlugin(GatherPlugin_V35):
gather1 = Cpt(GatherNPlugin_V35, '', index=1)
gather2 = Cpt(GatherNPlugin_V35, '', index=2)

class MyDetector(ADBase):
gather = Cpt(MyGatherPlugin, 'Gather1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| GenICam |
ADGenICam driver, https://github.com/areaDetector/ADGenICam

It is the base class for GenICam drivers and not meant to be used directly.
| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| HDF5Plugin_V35 |
Plugin to save data in HDF5 format,
https://areadetector.github.io/areaDetector/ADCore/NDFileHDF5.html.

::
class MyDetector(ADBase):
hdf = Cpt(HDF5Plugin_V35, 'HDF1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ImagePlugin_V35 |
Plugin to convert the NDArray data into a form accessible by EPICS Channel Access clients,
https://areadetector.github.io/areaDetector/ADCore/NDPluginStdArrays.html.

::

class MyDetector(ADBase):
image = Cpt(ImagePlugin_V35, 'image1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| JPEGPlugin_V35 |
Plugin to save data in JPEG format,
https://areadetector.github.io/areaDetector/ADCore/NDFileJPEG.html.

::

class MyDetector(ADBase):
jpeg = Cpt(JPEGPlugin_V35, 'JPEG1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| MagickPlugin_V35 |
Plugin to save data in any format supported by ImageMagick/GraphicsMagick,
https://areadetector.github.io/areaDetector/ADCore/NDFileMagick.html.

::

class MyDetector(ADBase):
magick = Cpt(MagickPlugin_V35, 'Magick1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | | Mercury | Mercury base device | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) | -| NetCDFPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| NexusPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| OverlayPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| PilatusDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| PluginBase_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| PosPluginPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ProcessPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ProsilicaDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| PvaPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| PylonDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| ROIPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ROIStatNPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ROIStatPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| ScatterPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| SimDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| SLSDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| NetCDFPlugin_V35 |
Plugin to save data in netCDF format,
https://areadetector.github.io/areaDetector/ADCore/NDFileNetCDF.html.

::

class MyDetector(ADBase):
netcdf = Cpt(NetCDFPlugin_V35, 'netCDF1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| NexusPlugin_V35 |
Plugin to save data in NeXus format,
https://areadetector.github.io/areaDetector/ADCore/NDFileNexus.html.

::

class MyDetector(ADBase):
nexus = Cpt(NexusPlugin_V35, 'Nexus1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| OverlayPlugin_V35 |
Plugin to add graphics overlay to image data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginOverlay.html.

::

class MyDetector(ADBase):
overlay = Cpt(OverlayPlugin_V35, 'Over1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| PilatusDetectorCam |
ADPilatus driver, https://github.com/areaDetector/ADPilatus

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(PilatusDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| PluginBase_V35 |
Base class for all plugins.
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| PosPluginPlugin_V35 |
Plugin to attach positional information to NDArrays in the form of NDAttributes,
https://areadetector.github.io/areaDetector/ADCore/NDPluginPos.html.

::
class MyDetector(ADBase):
pos = Cpt(PosPluginPlugin_V35, 'Pos1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ProcessPlugin_V313 |
Plugin to perform arithmetic processing on NDArray data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginProcess.html.

::

class MyDetector(ADBase):
process = Cpt(ProcessPlugin_V35, 'Proc1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ProsilicaDetectorCam |
ADProsilica driver, https://github.com/areaDetector/ADProsilica

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(ProsilicaDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| PvaPlugin_V35 |
Plugin to convert NDArray into NTNDArray accessible by PVAccess clients,
https://areadetector.github.io/areaDetector/ADCore/NDPluginPva.html.

::
class MyDetector(ADBase):
pva = Cpt(PvaPlugin_V35, 'Pva1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| PylonDetectorCam |
ADPylon driver, https://github.com/areaDetector/ADPylon

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(PylonDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| ROIPlugin_V35 |
Plugin to select a ROI from NDArray data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginROI.html.

::

class MyDetector(ADBase):
roi1 = Cpt(ROIPlugin_V35, 'ROI1:')
roi2 = Cpt(ROIPlugin_V35, 'ROI2:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ROIStatNPlugin_V35 |
Part of ROIStatPlugin
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ROIStatPlugin_V35 |
Plugin to calculate statistics for multiple ROIs,
https://areadetector.github.io/areaDetector/ADCore/NDPluginROIStat.html.

::

class MyROIStatPlugin(ROIStatPlugin_V35):
roi1 = Cpt(ROIStatNPlugin_V35, '1:')
roi2 = Cpt(ROIStatNPlugin_V35, '2:')

class MyDetector(ADBase):
roistat = Cpt(MyROIStatPlugin, 'ROIStat1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| ScatterPlugin_V35 |
Plugin to distribute the processing of NDArrays to multiple downstream plugins,
https://areadetector.github.io/areaDetector/ADCore/NDPluginScatter.html.

::
class MyDetector(ADBase):
scatter = Cpt(ScatterPlugin_V35, 'Scatter1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| SimDetectorCam |
ADSimDetector driver, https://github.com/areaDetector/ADSimDetector

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(SimDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| SLSDetectorCam |
slsDetector driver, https://github.com/paulscherrerinstitute/slsDetector

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(SLSDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | | SLSInfo | | [ophyd_devices.devices.sls_devices](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/sls_devices.py) | | SLSOperatorMessages | | [ophyd_devices.devices.sls_devices](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/sls_devices.py) | | SpmBase | Python wrapper for the Staggered Blade Pair Monitors

SPM's consist of a set of four horizontal tungsten blades and are
used to monitor the beam height (only Y) for the bending magnet
beamlines of SLS.

Note: EPICS provided signals are read only, but the users can
change the beam position offset.
| [ophyd_devices.devices.SpmBase](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/SpmBase.py) | | SpmSim | Python wrapper for simulated Staggered Blade Pair Monitors

SPM's consist of a set of four horizontal tungsten blades and are
used to monitor the beam height (only Y) for the bending magnet
beamlines of SLS.

This simulation device extends the basic proxy with a script that
fills signals with quasi-randomized values.
| [ophyd_devices.devices.SpmBase](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/SpmBase.py) | -| StatsPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| TIFFPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| TimeSeriesPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| TransformPlugin_V35 | | [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | -| URLDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | -| VimbaDetectorCam | | [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| StatsPlugin_V35 |
Plugin to calculate statistics on NDArray data,
https://areadetector.github.io/areaDetector/ADCore/NDPluginStats.html.

::

class MyDetector(ADBase):
stats = Cpt(StatsPlugin_V35, 'Stats1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| TIFFPlugin_V35 |
Plugin to save data in TIFF format,
https://areadetector.github.io/areaDetector/ADCore/NDFileTIFF.html.

::

class MyDetector(ADBase):
tiff = Cpt(TIFFPlugin_V35, 'TIFF1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| TimeSeriesPlugin_V35 |
Plugin to create time-series data of input signals,
https://areadetector.github.io/areaDetector/ADCore/NDPluginTimeSeries.html.

::
class MyDetector(ADBase):
ts = Cpt(TimeSeriesPlugin_V35, 'TS:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| TransformPlugin_V35 |
Plugin to rotate/flip the image,
https://areadetector.github.io/areaDetector/ADCore/NDPluginTransform.html.

::
class MyDetector(ADBase):
transform = Cpt(TransformPlugin_V35, 'Trans1:')
| [ophyd_devices.devices.areadetector.plugins](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/plugins.py) | +| URLDetectorCam |
ADURL driver, https://github.com/areaDetector/ADURL

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(AravisDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | +| VimbaDetectorCam |
ADVimba driver, https://github.com/areaDetector/ADVimba

::

from ophyd import Component as Cpt

class MyDetector(ADBase):
cam = Cpt(VimbaDetectorCam, 'cam1:')

| [ophyd_devices.devices.areadetector.cam](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/areadetector/cam.py) | | XbpmBase | Python wrapper for X-ray Beam Position Monitors

XBPM's consist of a metal-coated diamond window that ejects
photoelectrons from the incoming X-ray beam. These electons
are collected and their current is measured. Effectively
they act as four quadrant photodiodes and are used as BPMs
at the undulator beamlines of SLS.

Note: EPICS provided signals are read only, but the user can
change the beam position offset.
| [ophyd_devices.devices.XbpmBase](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/XbpmBase.py) | | XbpmSim | Python wrapper for simulated X-ray Beam Position Monitors

XBPM's consist of a metal-coated diamond window that ejects
photoelectrons from the incoming X-ray beam. These electons
are collected and their current is measured. Effectively
they act as four quadrant photodiodes and are used as BPMs
at the undulator beamlines of SLS.

Note: EPICS provided signals are read only, but the user can
change the beam position offset.

This simulation device extends the basic proxy with a script that
fills signals with quasi-randomized values.
| [ophyd_devices.devices.XbpmBase](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/XbpmBase.py) | | xMAP | xMAP base device | [ophyd_devices.devices.dxp](https://gitlab.psi.ch/bec/ophyd_devices/-/blob/main/ophyd_devices/devices/dxp.py) |