The slsDetector package provides a way to interface with SLS detectors in the Karabo control system. More information on the detectors can be found on this webpage:
https://www.psi.ch/en/lxn/documentation
For questions, please contact [email protected].
This software is released by the European XFEL GmbH as is and without any warranty under the GPLv3 license. If you have questions on contributing to the project, please get in touch at [email protected].
The sources for this project can be found at https://github.com/European-XFEL/Karabo-slsDetectors
The Karabo slsDetector package depends on slsDetectorPackage, which is the SDK provided by the SLS detector group under the LGPL-3.0 license.
-
slsDetectorPackage v9.2.x
The device can further be installed from PyPI and ships in the form of a self-hosting device server. All the needed libaries are grafted in, including the ones from slsDetectorPackage.
To install, run
pip install karabo-sls-detectors
To run, make sure you initially prepared a Karabo environment using
pip install karabo.services
karabo-activate --init-to PATH/TO/KARABO
and have activated that Karabo environment using
source PATH/TO/KARABO/activate
and then start the self-hosting server with
karabo-sls-detector-server [serverId=, ... karabo-cpp-server options]
It happens sometimes that Gotthard starts sending data and cannot be stopped.
If you click stop the Karabo device will be stuck in "CHANGING".
Usually this problem occurs with short exposure time and period.
In this case, it is usually enough to execute the script gotthard_restart.py
and then reset the Karabo "detector" device.
If it does not help, you may need to:
- Shutdown or
karabo-kill -kthe cppServer - run the
sls_detector_get freecommand on the control server telneton the Gotthard andrebootit- restart Karabo servers and devices
In the SLS detector software, some of the parameters changed from v4.0.1 to v5.0.1. The Karabo device followed these changes, thus some of the keys have been renamed:
| Old Key Name | New Key Name |
|---|---|
| bitDepth | dynamicRange |
| detectorIp | udpSrcIp |
| detectorMac | udpSrcMac |
| detectorNumber | serialNumber |
| detectorVersion | firmwareVersion |
| numberOfCycles | numberOfTriggers |
| rxUdpIp | udpDstIp |
| rxUdpPort | udpDstPort |
| softwareVersion | detServerVersion |
| thisVersion | clientVersion |
| vHighVoltage | highVoltage |
| vHighVoltageMax | highVoltageMax |
The following parameters have been removed, as not available any more, or not available for the detectors we currently have at XFEL:
| Removed Key Name |
|---|
| angConv |
| angDir |
| binSize |
| detectorDeveloper |
| flatFieldCorrectionFile |
| globalOff |
| lock |
| master |
| maximumDetectorSize |
| moveFlag |
| numberOfGates |
| online |
| sync |
| threaded |
For some other properties the unit and type have changed:
| Key Name | Old Unit | New Unit | Old Type | New Type |
|---|---|---|---|---|
| exposureTime | s | ns | FLOAT | INT64 |
| exposurePeriod | s | ns | FLOAT | INT64 |
| delayAfterTrigger | s | ns | FLOAT | INT64 |