https://github.com/diamondlightsource/adexternal
areaDetector plugin to process a frame in an external program
https://github.com/diamondlightsource/adexternal
epics-support-module from-dls-controls
Last synced: 3 months ago
JSON representation
areaDetector plugin to process a frame in an external program
- Host: GitHub
- URL: https://github.com/diamondlightsource/adexternal
- Owner: DiamondLightSource
- License: apache-2.0
- Created: 2023-01-25T13:33:05.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T13:19:56.000Z (5 months ago)
- Last Synced: 2024-12-13T14:23:30.457Z (5 months ago)
- Topics: epics-support-module, from-dls-controls
- Language: C++
- Homepage:
- Size: 256 KB
- Stars: 2
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ADExternal
ADExternal is an areaDetector plugin to process a frame in an external
process minimising data copying by using shared memory.
The processing side (external process) is called `worker`, examples of it
can be found under folder `worker/python`.
A worker can be implemented in any language, the protocol is documented in
[PROTOCOL](PROTOCOL.md)
## Features
- The EPICS side is assolated of the processing side and therefore a failure
in the processing task will not affect EPICS stability
- Frame is passed to the worker using shared memory, therefore, minimising
overhead
- A worker can add attributes to the frame
- A worker can update PV values
- A worker can process a frame in place or might prefer to create a new frame
- There can be more than one worker to process in parallel
## Limitations
- ADCore version 3-13 or newer is required.
- There can only be one shared memory per IOC (given that it is used for every
frame allocation), if there are multiple ADExternal instances, only the first
instance will create the shared memory and the rest will use the same one,
make sure that memory size is big enough for all the area detector plugins
and drivers used.
- Each ADExternal instance must use a different socket path
- The asyn parameters that are updated by the worker should have a name that
starts with a letter indicating the type (`i` for integer, `d` for double or
`s` for string)
- Asyn parameters' initial values are determined by workers and all of them
should use the same values (this could be changed if needed)
- A worker that creates a new frame can only do it with size equals or less than
the input frame size, that is a consequence of reusing the same shared memory
area for the output frame.
## Quickstart
- Configure the plugin in the target IOC
```c
# ADExternalConfig(
# portName, socketPath, shmName, className, identity,
# queueSize, blockingCallbacks, NDArrayPort, NDArrayAddr, maxMemory,
# priority, stackSize)
ADExternalConfig(
"ad.ext", "/tmp/unix_sock_name.sock", "shm_name1", "Template", "",
5, 1, "ad.cam", 0, 67108864,
0, 0)
```
In this case, it uses an example worker type called `Template`.
`maxMemory` specifies shared memory size.
- Run the worker passing the path to the unix socket
```bash
$ python worker/python/Template.py /tmp/unix_sock_name.sock
```