Dectris EIGER2 User Manual
  1. Manuals
  2. Brands
  3. Dectris Manuals
  4. Laboratory Equipment
  5. EIGER2 X 500K
  6. User manual

Dectris EIGER2 User Manual

Hide thumbs Also See for EIGER2:
Table of Contents

Advertisement

Quick Links

Download this manual
User Manual
EIGER2
Document Version v1.6.0
DECTRIS Ltd.
5405 Baden-Daettwil
Switzerland
www.dectris.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the EIGER2 and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Dectris EIGER2

Summary of Contents for Dectris EIGER2

  • Page 1 User Manual EIGER2 Document Version v1.6.0 DECTRIS Ltd. 5405 Baden-Daettwil Switzerland www.dectris.com...
  • Page 2 Document Version v1.6.0 © Copyright 2020 DECTRIS Ltd.

  • Page 3: Table Of Contents

    EXTE - Externally Enabled Exposure Series ....... . . 20 EIGER2 User Manual v1.6.0...
  • Page 4 Python Example ..........27 EIGER2 User Manual v1.6.0...

  • Page 5: Document History

    Changes v1.0.0 2017-04-09 First release. v1.2.0 2017-09-04 EIGER2 R 500K integration. v1.3.2 2017-09-04 PILATUS3 and EIGER2 R 500K API documentation integration. v1.4.0 2018-06-19 EIGER2 Si detector series integration v1.5.0 2020-03-02 New layout and rework of the technical specifications. v1.5.1 2020-06-08 Fixed EIGER2 16M image of ground plate.

  • Page 6: General Information

    Should you have questions concerning the system or its use, please contact us via telephone, mail or fax. 1.2. Explanation of Symbols Caution Caution blocks are used to indicate danger or risk to equipment. Information Information blocks are used to highlight important information. EIGER2 User Manual v1.6.0 1 | 28...

  • Page 7: Warranty Information

    DECTRIS is the sole owner of all user rights related to the contents of the manual (in particular information, images or ma- terials), unless otherwise indicated. Without the written permission of DECTRIS it is prohibited to integrate the protected contents in this publication into other programs or other websites or to use them by any other means.

  • Page 8: Safety Instructions

    • Place the protective cover on the detector when it is not in use to prevent the detector from accidental damage. • Opening the detector or the power supply housing without explicit instructions from DECTRIS will void the warranty. • Do not install additional software or change the operating system.

  • Page 9: System Description

    3.2.2. Continuous Readout One of the hallmark features of EIGER2 is its continuous readout that enables high frame rates at high duty cycles. Every pixel of an EIGER2 ASIC features two digital counters for each of its two energy discriminating thresholds. After acquisition of a frame, the pixels switch from counting in one digital counter to the other.

  • Page 10: Auto-Summation

    3.2.3. Auto-Summation EIGER2 auto-summation mode is a further benefit of continuous readout with high duty cycle. While a single frame is limited to the 16 bit of the digital counter, auto-summation extends the data depth up to 32 bit, or more than 4.2 billion counts per pixel, depending on the number of summed frames in an image.

  • Page 11: Quick Start Guide

    4.1. Accessing the Detector Control Unit The EIGER2 detector is controlled via the network interface of the detector control unit. Hence, the IP network address of the detector control unit has to be known to be able to connect to the API. Depending on the network structure, there are several ways of determining the IP network address, which are described below.

  • Page 12: Using A Fixed Ip

    If you use e.g., a laptop to access the detector control unit directly for the initial configuration, you can use the following network settings on the laptop: Table 4.1: Network Settings IP Adress 169.254.254.100 Subnet Mask 255.255.0.0 Default Gateway not required EIGER2 User Manual v1.6.0 7 | 28...

  • Page 13: Getting Started

    Some detectors do not require a dry air connection. Consult the Technical Specifications for more information. Some detectors do not require water cooling. Consult the Technical Specifications for more information. EIGER2 User Manual v1.6.0 8 | 28...

  • Page 14: Web Interface

    6. WEB INTERFACE 6.1. Overview The EIGER2 web interface (figure 6.1) provides simple access to basic functions and settings of the detector system for installation, debugging, and system updates. For productive operation of the detector, please refer to the API Reference.

  • Page 15: System Settings And Administration

    6.2. System Settings and Administration To access the EIGER2 system settings, click on the corresponding tab on the homepage. The system tab allows to config- ure the detector control unit network settings and get some status and system informations. Figure 6.2: Screenshot of the system settings showing the network configuration page.

  • Page 16: General Usage Of The Detector System

    7.1. Detector Control and Output The EIGER2 detector system is controlled through the SIMPLON API, an interface to the detector that is based on the http protocol and implemented on the detector control unit. The API Reference supplied with the system describes this interface in detail and allows for easy integration of detector control into instrument control or similar software.

  • Page 17: Control Of The Detector From A Specific Environment

    In external enable modes the parameter nimages is ignored (i.e. always 1) and the number of frames therefore has to be configured using the detector configuration parameter ntrigger. EIGER2 User Manual v1.6.0 12 | 28...

  • Page 18: Additional Configuration Parameters

    • detector | config | threshold/difference/mode The EIGER2 detectors provide two independent thresholds and it is possible to read out either one threshold, all of them at once or the difference of the thresholds. To read out more than one threshold at once, it is necessary to use the monitor interface.

  • Page 19: Interdependency Of Configuration Parameters

    The flatfield applied for a given photon_energy and threshold_energy is an artefact of the detector calibration. During the calibration a multitude of flatfields at different settings have been recorded to ensure optimal data quality of the flatfield for all common settings. EIGER2 User Manual v1.6.0 14 | 28...

  • Page 20: Interdependency Of Timing Parameters

    first set count_time to the inverse of the frame rate and subsequently frame_time to the inverse of the frame rate. EIGER2 User Manual v1.6.0 15 | 28...

  • Page 21: Region Of Interest (Roi)

    8. REGION OF INTEREST (ROI) The Region Of Interest (ROI) feature enables the user to read out a reduced area of an EIGER2 X 16M or EIGER2 X 9M detector at higher frame rates. Information Please consult the API reference for further details concerning the usage of the region of interest detector configuration parameter (roi_mode).

  • Page 22: Trigger Usage Introduction

    In order to record an image or a series of images, the EIGER2 detector has to be initialized, configured, armed, and the exposure(s) started by a trigger signal. The steps necessary to record an image series are comprehensively described in chapter 5 and section 7.2.

  • Page 23: Inte - Internal (Software) Enable

    | command | trigger {”value”: 2.1} detector | command | trigger {”value”: 0.7} As the trigger command is sent over an TCP/IP connection the exact latency of the start of the exposure is hard to predict. EIGER2 User Manual v1.6.0 18 | 28...

  • Page 24: Exts - Externally Triggered Exposure Series

    Consult the Technical Specifications for details about the required electrical characteristics of the trigger signal. The EIGER2 detector systems also support external triggering. In the trigger_mode ’exts’, nimages are recorded per trigger until ntrigger are received. Both count_time as well as frame_time are defined by the configuration.

  • Page 25: Exte - Externally Enabled Exposure Series

    The EIGER2 detector systems also support external enabling. In the external enable mode ’exte’ a series of ntrigger frames can be recorded. The count time as well as the period of individual frames of a series are defined by the duration of the high state of the external trigger/enable signal.
  • Page 26 (according to the specifications) enable pulses are received until the value set for ntrigger is reached. Figure 9.4 illustrates a externally enabled series. ntrigger Enable Out External In Time Figure 9.4: Exposures defined by external enable EIGER2 User Manual v1.6.0 21 | 28...

  • Page 27: Hdf5 And Albula Albula Overview

    10. HDF5 AND ALBULA 10.1. ALBULA Overview ALBULA is a cross-platform image viewer developed and maintained by DECTRIS. The Linux and Windows versions also provide an image library for the Python language. ALBULA can be downloaded for free at www.dectris.com. Scripts written in Python using ALBULA can be used to read, display and store data taken by the EIGER2 detectors.

  • Page 28: Albula Hdf5 Python Library (Linux And Windows Only)

    10.2. ALBULA HDF5 Python Library (Linux and Windows only) The following examples illustrate how the data stored in HDF5 files by the EIGER2 detector can be manipulated with ALBULA. 10.2.1. Getting Started []$_ Example ALBULA #!/usr/bin/python ### import the dectris.albula image library ### import sys.path.insert(0,"/usr/local/dectris/python")

  • Page 29: Reading Data

    ## extract wavelength ## wavelength = neXusRoot.childElement('/entry/instrument/monochromator/wavelength') ## print value ## print "wavelength value: ",wavelength.value() ## extract threshold ## threshold_energy = neXusRoot.childElement('/entry/instrument/detector/threshold_energy') ## print value ## print "threshold_energy value: ",threshold_energy.value() EIGER2 User Manual v1.6.0 24 | 28...

  • Page 30: Writing Data

    "testImage_{0:05d}.tif".format(i)) 10.3. Third Party HDF5 Libraries The EIGER2 HDF5 data can also be directly read with programs using the HDF5 library. By default the EIGER2 data is compressed using the BSLZ4 algorithm. In order to decompress the data, the HDF5 plug-in filter can be used, see https://github.com/dectris/HDF5Plugin.

  • Page 31: Pixel Mask

    11.2. Updating the pixel mask 11.2.1. Overview Updating the pixel mask of an EIGER2 detector system involves four basic steps: 1. Retrieving the current pixel mask from the detector system via the SIMPLON API. 2. Manipulating the pixel mask to add or update pixels.

  • Page 32: Python Example

    11.2.5. Python Example The following Python code using common libraries provides a simple example for updating the pixel mask: EIGER2 User Manual v1.6.0 27 | 28...
  • Page 33 = set_mask(mask, ip=IP, port=PORT) # reply.status_code should be 200, then arm and disarm to test the system reply.status_code == 200: command ('arm', 'disarm'): url = 'http://{}:{}/detector/api/1.8.0/command/%s'.format(IP, PORT, command) requests.put(url) else: print reply.content EIGER2 User Manual v1.6.0 28 | 28...

Table of Contents