Welcome to slsDetectorPackage’s documentation!

Note

This is the documentation for the latest development version of slsDetectorPackage. For further documentation, visit the official page: https://www.psi.ch/en/detectors/documentation

Installation:

• Installation
  • Install binaries using conda
  • Build from source
    • 1. Download Source Code from github
    • 2. Build from Source
    • Build using CMake
    • Build using in-built cmk.sh script
    • Build on old distributions
    • Build slsDetectorGui (Qt5)
    • Build this documentation
    • Pybind and Zeromq
• Dependencies
  • Core
  • Python bindings
  • ZeroMQ
  • GUI
  • Moench executables
  • Documentation
  • Packaged in libs/
• Consuming slsDetectorPackage
  • CMake: slsDetectorPackage as submodule in your project
  • CMake: find_package(slsDetectorPackage)
  • CMake: find_package and conda
  • No tools minimal approach

C++ API

• Detector
• Result
• Receiver
• Examples
  • Setup
  • Compile examples
  • Running a config file [e1]
  • Using the return type sls::Result [e2]
  • Setting exposure time [e3]

Python API

• Getting Started
  • Which Python?
  • Building from Source
  • PYTHONPATH
  • Which detector class should I use?
  • Hey, there seems to be two APIs?
  • Finding functions
  • Finding out what the function does
  • Where are the ENUMs?
• Detector
  • Detector
• Enums
  • runStatus
  • detectorType
  • frameDiscardPolicy
  • fileFormat
  • dimension
  • externalSignalFlag
  • timingMode
  • dacIndex
  • detectorSettings
  • clockIndex
  • speedLevel
  • readoutMode
  • burstMode
  • timingSourceType
  • M3_GainCaps
  • portPosition
  • streamingInterface
  • vetoAlgorithm
  • gainMode
• Examples
  • Setting exposure time
  • Converting numbers to hex
  • Simple threshold scan
  • Reading temperatures
  • Non blocking acquire
  • Setting and getting times
  • Reading dacs

Command line

• Command line interface
  • Usage
  • Help
  • Commands
  • Deprecated commands
• Quick Start Guide
  • Detector
  • Receiver
  • Client
  • Gui

Developer

• ContainerUtils
• TypeTraits
• ToString

Firmware

• Firmware Upgrade
  • Eiger
  • Jungfrau
  • Gotthard I
  • Mythen III
  • Gotthard II
  • Moench
  • Ctb
  • Firmware Troubleshooting with blackfin

Detector Server

• Getting Started
  • Location
  • Arguments
  • Automatic start
• Upgrade
  • 6.1.1+ (no tftp required)
  • 5.0.0 - 6.1.1
  • < 5.0.0
• Simulators
  • Compilation
  • Arguments
  • Client
  • Receivers
  • Gui
  • Limitations
• Default Values
  • Mythen3
  • Gotthard2
  • Moench
  • Ctb
  • Eiger
  • Jungfrau
  • Gotthard

Detector UDP Header

• Format
  • Current Version
  • Description
  • Detector Enum
  • Previous Versions
• Config file
  • Source Port
  • udp_srcip - Source IP
  • udp_srcmac - Source MAC
  • udp_dstport - Desintation Port
  • udp_dstip - Destination IP
  • udp_dstmac - Destination MAC
• Detector Specific Fields
  • Eiger
  • Jungfrau
  • Gotthard2
  • Mythen3

Receiver

• Receivers
  • Custom Receiver
• slsReceiver/ slsMultiReceiver
  • Client Commands
  • Performance
  • Using Callbacks

Receiver Files

• File format
  • Number of Files
  • Naming
  • Formats
• SLS Receiver Header Format
• Master File Attributes
  • Eiger
  • Jungfrau
  • Gotthard II
  • Mythen3
  • Moench
  • Gotthard I
  • Chip Test Board
• Binary File Format
  • Master File
  • Data File
  • JSON Master File Examples
    • Eiger
    • Jungfrau
    • Gotthard2
    • Mythen3
    • Moench
    • Gotthard I
    • Chip Test Board
• HDF5 File Format
  • Compilation
  • Setup
  • Master File
  • Data File
  • Virtual Data File

Receiver ZMQ Stream

• ZMQ: Json Header Format

Troubleshooting

• Troubleshooting
  • Common
    • 1. Total Failure of Packet Delivery
    • 2. Partial or Random Packet Loss (Performance)
    • Receiver PC Tuning Options
    • slsReceiver Tuning
    • Shared memory error
    • Cannot connect to detector
    • Cannot connect to receiver
    • Receiver: cannot bind socket
    • Cannot get multi module data
    • Cannot ping module (Nios)
  • Gotthard2
    • Cannot get data without a module attached
  • Gotthard
    • Missing first frame or next frame after a delay
  • Mythen3
    • Detector status is waiting even in auto timing mode
  • Jungfrau
    • Temperature event occured
    • Cannot get multi module data
    • Cannot stop slaves in sync mode