Dectris QUADRO User manual

User Manual
DECTRIS QUADRO®
Document Version v1.7.1
DECTRIS Ltd.
5405 Baden-Daettwil
Switzerland
www.dectris.com

Document Version v1.7.1
©Copyright 2021
DECTRIS Ltd.

CONTENT
CONTENT i
DOCUMENT HISTORY iii
CurrentDocument................................................... iii
Changes........................................................ iii
1 GENERAL INFORMATION 1
1.1 ContactandSupport............................................. 1
1.2 ExplanationofSymbols............................................ 1
1.3 WarrantyInformation ............................................. 2
1.4 Disclaimer................................................... 2
2 SAFETY INSTRUCTIONS 3
3 SYSTEM DESCRIPTION 4
3.1 Components ................................................. 4
3.2 HybridPixelTechnology ........................................... 4
3.2.1 BasicFunctionality........................................... 4
3.2.2 ContinuousReadout ......................................... 4
3.2.3 Auto-Summation ........................................... 4
3.2.4 Region-of-Interest(ROI) ........................................ 5
3.3 Software ................................................... 5
3.3.1 OverviewofSIMPLON......................................... 5
4 QUICK START GUIDE 6
4.1 Accessing the Detector Control Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
4.1.1 UsingDHCP.............................................. 6
4.1.2 UsingaFixedIP............................................ 7
5 GETTING STARTED 8
5.1 StartupProcedure .............................................. 8
6 WEB INTERFACE 9
6.1 Overview ................................................... 9
6.2 System Settings and Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
7 GENERAL USAGE OF THE DETECTOR SYSTEM 11
7.1 DetectorControlandOutput......................................... 11
7.2 Recording an Image or an Image Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
7.3 Control of the Detector from a Specic Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
7.3.1 MainCongurationParameters .................................... 12
7.3.2 Additional Conguration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
7.4 Interdependency of Conguration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7.4.1 Interdependency of Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
7.4.2 Interdependency of Timing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
8 TRIGGER USAGE 17
8.1 Introduction.................................................. 17
8.2 INTS - Internal (Software) Triggering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
8.3 INTE–Internal(Software)Enable....................................... 18
8.4 EXTS - Externally Triggered Exposure Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
8.5 EXTE - Externally Enabled Exposure Series . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
DECTRIS QUADRO®User Manual v1.7.1 i | 33

9 HDF5 AND ALBULA 22
9.1 ALBULAOverview .............................................. 22
9.2 ALBULA HDF5 Python Library (Linux and Windows only) . . . . . . . . . . . . . . . . . . . . . . . . . . 23
9.2.1 GettingStarted ............................................ 23
9.2.2 Readingdata ............................................. 24
9.2.3 WritingData .............................................. 25
9.3 ThirdPartyHDF5Libraries .......................................... 25
10 PIXEL MASK 26
10.1 Applyingthepixelmask............................................ 26
10.2 Updatingthepixelmask ........................................... 26
10.2.1 Overview................................................ 26
10.2.2 Retrieving the current mask from the detector system . . . . . . . . . . . . . . . . . . . . . . . . 26
10.2.3 Manipulatingthepixelmask...................................... 26
10.2.4 Uploading and storing the pixel mask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
10.2.5 PythonExample............................................ 27
11 FLATFIELD 29
11.1 Applyingtheateld.............................................. 29
11.2 Creatingaateld............................................... 29
11.2.1 Overview................................................ 29
11.2.2 Acquire uniformly-illuminated image . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
11.2.3 Upload pixel-wise correction factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
DECTRIS QUADRO®User Manual v1.7.1 ii | 33

DOCUMENT HISTORY
Current Document
Table 1: Current Version of this Document
Version Date Status Prepared Checked Released
v1.7.1 2021-03-25 release MM LP,TD LP, MM
Changes
Table 2: Changes to this Document
Version Date 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 specications.
v1.5.1 2020-06-08 Fixed EIGER2 16M image of ground plate.
v1.6.0 2020-09-08 EIGER2 CdTe detector series integration.
v1.7.1 2021-03-25 EM products integration.
DECTRIS QUADRO®User Manual v1.7.1 iii | 33

1. GENERAL INFORMATION
1.1. Contact and Support
Address: DECTRIS Ltd.
Taefernweg 1
5405 Baden-Daettwil
Switzerland
Phone: [phone]
Fax: [phone]
Homepage: http://www.dectris.com/
Email: [email protected]
Should you have questions concerning the system or its use, please contact us via telephone, mail or fax.
1.2. Explanation of Symbols
Warning #0
Warning blocks are used to indicate danger or risk to personnel or equipment.
Caution #0
Caution blocks are used to indicate danger or risk to equipment.
Information #0
Information blocks are used to highlight important information.
DECTRIS QUADRO®User Manual v1.7.1 1 | 33

1.3. Warranty Information
Caution #1
Do not ship the system back before you receive the necessary transport and shipping information.
1.4. Disclaimer
DECTRIS®has carefully compiled the contents of this manual according to the current state of knowledge. Damage and
warranty claims arising from missing or incorrect data are excluded.
DECTRIS®bears no responsibility or liability for damage of any kind, also for indirect or consequential damage resulting from
the use of this system.
DECTRIS®is the sole owner of all user rights related to the contents of the manual (in particular information, images or
materials), 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.
DECTRIS®reserves the right, at its own discretion and without liability or prior notice, to modify and/or discontinue this
publication in whole or in part at any time, and is not obliged to update the contents of the manual.
DECTRIS QUADRO®User Manual v1.7.1 2 | 33

2. SAFETY INSTRUCTIONS
Caution #2
Please read these safety instructions before operating the detector system.
• Before turning the power supply on, check the supply voltage against the label on the power supply.
Using an improper main voltage will destroy the power supply and damage the detector.
• Power down the detector system before connecting or disconnecting any cable.
• Make sure the cables are connected and properly secured.
• Avoid pressure or tension on the cables.
• The detector system should have enough space for proper ventilation. Operating the detector outside
the specied ambient conditions could damage the system.
• Ensure that the detector is switched off before pumping or venting the detector head. Operating the
detector outside the specied pressure range could damage the system.
• 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.
• Do not touch the sensor or contaminate any vacuum related part.
DECTRIS QUADRO®User Manual v1.7.1 3 | 33

3. SYSTEM DESCRIPTION
3.1. Components
The QUADRO detector system consists of the following components:
• QUADRO detector
• Power supply for the detector1
• Detector control unit
• Thermal stabilization unit2
• Accessories
• Documentation
3.2. Hybrid Pixel Technology
3.2.1. Basic Functionality
DECTRIS®detectors provide direct detection of electrons with optimized solid-state sensors and CMOS readout ASICs in
hybrid pixel technology. Well-proven standard technologies are employed independently for both the sensor and the CMOS
readout ASIC. The detectors operate in single-electron counting mode and provide outstanding data quality. They feature
very high dynamic range, zero dark signal and zero readout noise and hence achieve optimal signal-to-noise ratio at short
readout time and high frame rates.
Key Advantages
• Direct detection of electrons
• Single-electron counting
• Excellent signal-to-noise ratio and very high dynamic range (zero dark signal, zero noise)
• Two 16 bit digital counters
• Short readout time and high frame rates
• Shutterless operation
The QUADRO hybrid pixel detector is composed of a sensor, a two-dimensional array of pn-diodes processed in a high-
resistivity semiconductor, connected to an array of readout channels designed in advanced CMOS technology.
3.2.2. Continuous Readout
One of the hallmark features of QUADRO is its continuous readout that enables high frame rates at high duty cycles. Every
pixel of an QUADRO ASIC features two digital counters. After acquisition of a frame, the pixels switch from counting in one
digital counter to the other. While one counter is being read out, data acquisition continues in the other counter.
3.2.3. Auto-Summation
QUADRO auto-summation mode is a further benet 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. At short exposure times and high frame rates, all counts
are captured in the digital counter of a pixel and directly read out as an image. If long exposure times are requested, frames
are still acquired at high rates on the pixel level, effectively avoiding any overows. The detector system sums the frames to
images on the y, extending the bit depth of the data by the number of summed frames.
1Some systems might be delivered without an external power supply unit. Please consult the Technical Specications for more information.
2Some systems might be delivered without a thermal stabilization unit. Please consult the Technical Specications for more information.
DECTRIS QUADRO®User Manual v1.7.1 4 | 33

3.2.4. Region-of-Interest (ROI)
QUADRO provides a readout mode that enables high frame rates by reducing the readout area to a region-of-interest (ROI)
and/or reducing the number of bits per pixel. The user can set the number of lines that will be read out symetrically around
the horizontal center line (roi_y_size). The resulting y-size of the ROI image is determined by y-size = 2 x roi_y_size + 2 with
a maximum of 512 pixels. The x-size of the image is kept constant. A schematic representation of the readout area is give
in gure 3.1.
2 virtual
pixels
roi_y_size
2 ∙ roi_y_size + 2
Region-of-iterest (ROI)
x_pixel_in_detector
y_pixel_in_detector
Figure 3.1: Readout area for ROI mode (not to scale)
A list of the highest achievable framerates at specic settigs is given in the table below.
Table 3.1: Highest achievable framerates in ROI mode
roi_y_size image size [w x h] roi_bit_depth highest framerate
256 512 x 512 16 2250 fps
256 512 x 512 8 4500 fps
128 512 x 258 16 4500 fps
128 512 x 258 8 9000 fps
64 512 x 130 16 9000 fps
64 512 x 130 8 18000 fps
For more information on how to enable this feature please refer to section 7.3.2.
3.3. Software
3.3.1. Overview of SIMPLON
The QUADRO detector system is controlled via the SIMPLON API, which relies on a http/REST interface. The API Reference
is provided as a separate document ”SIMPLON API Reference”.
The detector’s web interface (chapter 6) gives access to fundamental settings and status parameters and also enables a
rst test to see if the detector system has been set up properly (after installation and startup as described in chapters 4
and 5).
The QUADRO detector writes images in the HDF5 le format (chapter 9). DECTRIS®provides the image viewer ALBULA,
which is able to handle the HDF5 images, with the primary aim to display them. ALBULA is available free of charge for
the platforms Linux and Windows (for download please go to http://www.dectris.com). The ALBULA version for Linux and
Windows comes with a Python API for handling the HDF5 les that allows performing arithmetic operations on image data as
well as basic analysis. Furthermore, the API enables seamless integration of the viewer into an existing infrastructure. More
information on HDF5 and ALBULA is given in chapter 9.
DECTRIS QUADRO®User Manual v1.7.1 5 | 33