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

4. QUICK START GUIDE
4.1. Accessing the Detector Control Unit
The QUADRO 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.
• See the Technical Specications for the default network port conguration of your detector control unit.
• The default network port conguration may be changed through the detector’s web interface (see section 6.2).
4.1.1. Using DHCP
If there is a DHCP server available on the network, plug the network cable into a port of the detector control unit pre-
congured for DHCP. See the Technical Specications for the default network port conguration of your detector control unit.
To determine the IP of your detector, plug in a keyboard and monitor to the detector control unit and power it up. Then follow
the following steps:
• Once the detector control unit is fully booted, a command line login prompt will appear.
• Type recovery and press return.
• If a password prompt appears, leave it empty and press return. The login name was most likely misspelled, restart
from point 1.
• Type ito select option (i) show ip addresses.
• The IP address will be displayed on the screen.
• If no IP is displayed, make sure that the DCU is properly connected to your network.
Alternatively, the IP network address can be retrieved by searching for the MAC address on the network. For network safety
reasons, please ask the network administrator for assistance in obtaining the IP address. If you are the network administrator
or have the required permission, the following Linux command can be used to retrieve the IP network address:
[]$_ Linux Command
sudo nmap -sP xxx.xxx.xxx.xxx/24 | awk '/^Nmap/{ip=$NF}/yy:yy:yy:yy:yy:zz/{print ip}'\\
where xxx.xxx.xxx.xxx/24 is the network address range to be scanned (e.g. 192.168.0.1/24) and yy:yy:yy:yy:yy:zz is the
MAC address of the DHCP network port in the back of the detector control unit. You can nd the MAC address of the port
using the method described below.
Determining the MAC Address of a Port
The MAC address of the rst network port can be found on the bottom of the service tag label (pull-out label in the front of the
detector control unit, the correct address is the EMBEDDED NIC 1 MAC ADDRESS). The MAC addresses of the second, third
and fourth ports are the same as the rst one, but with the last two digits incremented by zz+2, zz+4 and zz+6, respectively.
E.g. if the rst port is 01:23:45:67:89:ab, then the second port is 01:23:45:67:89:ad (make sure to use the hexadecimal
system).
DECTRIS QUADRO®User Manual v1.7.1 6 | 33

4.1.2. Using a Fixed IP
If you want to access the detector control unit using a xed IP network address, plug the network cable into the service port
of your detector control unit pre-congured for a xed IP. See the Technical Specications for the network port conguration
of your detector control unit and congure your network accordingly.
If you use e.g., a laptop to access the detector control unit directly for the initial conguration, 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
DECTRIS QUADRO®User Manual v1.7.1 7 | 33

5. GETTING STARTED
Information #1
Instructions on properly installing the detector system on a Transmission Electron Microscope can be found
in the Technical Specications. Before operating the detector, read the complete documentation.
Warning #1
Pay attention to POWER OFF the detector by disconnecting the power supply before pumping or venting
the detector chamber.
5.1. Startup Procedure
• Make sure the detector is properly mounted on the Transmission Electron Microscope and the detector chamber is
evacuated.
• Connect and turn on the thermal stabilization unit. Set the operation temperature as specied in the Technical Speci-
cations.
• Connect all the required cables for power, data, and trigger signals (if applicable) to the detector and the detector
control unit.
• Power on the detector. Pay attention not to power on the detector outside the specied temperature and pressure
range.
• Turn on the detector control unit. Please allow at least 5 minutes for the BIOS test procedures and startup of software
to complete.
• Check the web interface for system status or start using the SIMPLON API.
DECTRIS QUADRO®User Manual v1.7.1 8 | 33

6. WEB INTERFACE
6.1. Overview
The QUADRO web interface (gure 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.
Figure 6.1: QUADRO home page.
Table 6.1 summarizes the functions available through the left panel of the web system interface.
Table 6.1: Menu items of the QUADRO web interface.
Menu Point Content
System View the system information and access the detector control unit system settings (see
section 6.2)
Applications Manage the detector and calibration applications. This tab provides functions to start and
stop the detector software, change software versions and upgrade the detector software
to a new version.
Technical Support Simple interface to create a bug-report. The bug-report creates a tarball that can be
downloaded and sent to DECTRIS®support at [email protected]. The bug report is
not sent automatically.
DECTRIS QUADRO®User Manual v1.7.1 9 | 33

6.2. System Settings and Administration
To access the QUADRO system settings, click on the corresponding tab on the homepage. The system tab allows to
congure the detector control unit network settings and get some status and system informations.
Figure 6.2: Screenshot of the system settings showing the network conguration page.
Table 6.2 summarises menu items available for conguration
Table 6.2: Menu Items for Conguration/Testing
Detector See the detector status and initialize the detector. The detector status can
only be read out when the detector is initialized and the detector application is
running.
This tab also provides a way to quickly check the quality of the detector connec-
tion using the ”Check connections” button. Typical values are above 0.15 mW
for the TX power and above 0.3 mW for the RX power.
Network Congure the user accessible network interfaces.
Date & Time Congure date and time on the detector control unit. Provides the possibility
to add an NTP server.
About View system information.
DECTRIS QUADRO®User Manual v1.7.1 10 | 33

7. GENERAL USAGE OF THE DETECTOR SYSTEM
7.1. Detector Control and Output
The QUADRO 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. Please refer to the API
Reference for details.
The data recorded by the detector can be accessed in different ways. Images can be stored by the lewriter on the
detector control unit as HDF5 les (see chapter 9). HDF5 les include meta-data in a NeXus-compatible format. Buffered
les have to be regularly fetched and subsequently deleted on the detector control unit as buffer space is limited1). Data can
also be fetched through the stream API interface. The stream interface relies on ZeroMQ2, a distributed messaging protocol.
The stream has a low latency and offers utmost exibility. The meta-data is transferred as part of the header. Streamed data
is not buffered and will be lost if not fetched or incompletely fetched.
7.2. Recording an Image or an Image Series
Caution #3
Data might have to be fetched concurrently to a running image series. The lifespan of the data on the
detector control unit is dependent on the conguration of your system as well as the interface used for
collecting data. Data not fetched within this lifespan is permanently lost.
To record images or image series, the following steps need to be performed through the SIMPLON API (see the API Reference
for details).
1. Make sure the detector has been set up according to the steps described in chapter 5.
2. Initialize the detector if this has not yet been done. The detector does not need to be reinitialized unless the detector
entered an error status.
3. Set the detector parameters for data acquisition and specify and congure the desired output interface (le writer
and/or stream interface). A list of essential conguration parameters can be found in section 7.3.1.
4. Arm the detector
5. Record the image or image series.
• Send trigger(s) to record the image or image series as previously congured.
• Fetch data through the data interface(s).
6. Disarm the detector (to ensure les are nalized and closed).
7. Repeat from step 2 for further data acquisition with different settings or to step 3 for identical settings.
1Buffer space varies dependent on the conguration of your system, buffer overow will cause loss of data. See API Reference for further details.
2ZeroMQ distributed messaging (http://zeromq.org/)
DECTRIS QUADRO®User Manual v1.7.1 11 | 33

7.3. Control of the Detector from a Specic Environment
Integrating the detector into a specic environment requires understanding of the necessary detector functions. The API
reference will list all possible commands and features, but it does not give an explanation of the required functionality. Sec-
tions 7.3.1 and 7.3.2 cover a selection of essential and situational parameters respectively.
7.3.1. Main Conguration Parameters
The parameters described in this section allow control of the detector and data acquisition. Data will be acquired, however
further conguration of the interface for data retrieval might be necessary depending on your set up. For starting a data
acquisition, only the following parameters need to be adjusted.
• detector | cong | nimages
• detector | cong | count_time
• detector | cong | frame_time
• detector | cong | incident_energy
The detector conguration parameter incident_energy has to be set to the electron energy used for the experiment. The
difference between the timing parameters frame_time and count_time has to be greater than the detector_readout_time. The
detector_readout_time can be read back from the API. Count_time refers to the actual time the detector counts electrons
and frame_time is the interval between acquisitions of subsequent frames (i.e. period). The number of images in a series of
images, after a trigger, is congured with the parameter nimages. The detector always considers a trigger as the start of a
series of n images. For example a single image is considered as a series of images containing 1 image. Once the detector
has been armed a series can be started by issuing a trigger command or triggering the detector using an electronic pulse
on the external trigger input (ExtIn). To switch between the trigger modes (see chapter 8) one can use the conguration
parameter trigger_mode.
• detector | cong | trigger_mode
• detector | cong | ntrigger
Setting values greater than 1 for ntrigger allows several trigger commands or external trigger pulses per arm/disarm se-
quence. This mode allows recording several series of nimages with the same parameters. The resulting number of frames
is product of ntrigger and nimages. In external enable modes the parameter nimages is ignored (i.e. always 1) and the
number of frames therefore has to be congured using the detector conguration parameter ntrigger.
DECTRIS QUADRO®User Manual v1.7.1 12 | 33

Information #2
Please note that data be retrieved in different ways. For details, please see the API Reference.
With the lewriter enabled, the acquired data is written into HDF5 les. The lewriter has the following important conguration
parameters:
• lewriter | cong | name_pattern
• lewriter | cong | nimages_per_le
• lewriter | cong | compression_enabled
The lewriter parameter name_pattern sets the name template/pattern for the HDF5 les. The pattern ”$id” is replaced with
a sequence identication number and therefore can be used to discriminate between subsequent series. The sequence
identication number is reset after initializing the detector. The parameter nimages_per_le sets the number of images stored
per data le. A value of 1000 (default) means that for every 1000th image, a data le is created. If for example, 1800 images
are expected to be recorded, the arm, trigger, disarm sequence means that a master le is created in the data directory
after arming the detector. The trigger starts the image series and after 1000 recorded images one data container is made
available on the buffer of the detector control unit. No further les will made available until the series is nished either by
completing the nth image (nimages) of the nth trigger (ntrigger) or by ending the series using the detector command disarm.
As soon as either criteria is met the second data container is closed and made available for fetching.
7.3.2. Additional Conguration Parameters
Information #3
The following parameters are for special conditions and should be set with care and with understanding
of the consequences. Changing these parameters to non-default values can have a substantial negative
impact on data quality!
Corrections are enabled by default, but can be turned off using the following detector conguration parameters. In the vast
majority of experiments data quality benets from the data corrections. Therefore, disabling either correction will likely result
in inferior data quality.
• detector | cong | countrate_correction_applied
• detector | cong | ateld_correction_applied
• detector | cong | pixel_mask_applied
The ROI mode (see section 3.2.4) offers high framerate by reducing the readout area and/or the number of bits per pixel. It
is disabled by default. For using the ROI mode the following conguration parameters need to be adjusted:
• detector | cong | roi_mode
• detector | cong | roi_bit_depth
• detector | cong | roi_y_size
To enable the ROI mode, the parameter roi_mode has to be set to ”lines”. The roi_bit_depth parameter denes the number
of bits per pixel. It can be either set to 8 or 16. Operating the detector in 8 bit mode is necessary to reach the highest
specied framerate. The resulting y-size of the image is determined by the parameter roi_y_size and can be calculated by
y-size = 2 x roi_y_size + 2. The x-size of the image is the same as with disabled ROI mode. To disable the ROI mode, the
conguration parameter roi_mode has to be set to ”disabled”.
Information #4
Note: The counter in 8 bit mode does not have an overow protection. When exceeding the maximum
value of 255, the counter overows to zero and starts counting again. This might lead to uninterpretable
results.
A Python example on how to enable the ROI mode and take a single image with the lewriter interface is given below.
DECTRIS QUADRO®User Manual v1.7.1 13 | 33

[]$_ Example taking an image with ROI mode enabled
import json
import requests
# simple detector client
class DetectorClient:
def __init__(self, ip , port):
self._ip = ip
self._port = port
def set_config(self, param, value, iface = 'detector'):
url = 'http://%s:%s/%s/api/1.8.0/config/%s' % (self._ip, self._port, iface, param)
self._request(url, data = json.dumps({'value': value}))
def send_command(self, command):
url = 'http://%s:%s/detector/api/1.8.0/command/%s' % (self._ip, self._port, command)
self._ip, self._port, command
self._request(url)
def _request(self, url, data={}, headers={}):
reply = requests.put(url, data=data, headers=headers)
assert reply.status_code in range(200, 300), reply.reason
if __name__ == '__main__':
# create detector instance and initialize the detector
client = DetectorClient('169.254.254.1','80')
client.send_command('initialize')
# enable the filewriter interface
client.set_config('mode','enabled','filewriter')
client.set_config('name_pattern','roi_test_$id','filewriter')
# apply settings for roi feature
client.set_config('roi_mode','lines')
client.set_config('roi_bit_depth', 8)
client.set_config('roi_y_size', 128)
# set count and frame time
client.set_config('count_time', 1/9000)
client.set_config('frame_time', 1/9000)
# arms, triggers and disarm the detector
client.send_command('arm')
client.send_command('trigger')
client.send_command('disarm')
Further parameters and their function are described in the API Reference.
DECTRIS QUADRO®User Manual v1.7.1 14 | 33

7.4. Interdependency of Conguration Parameters
7.4.1. Interdependency of Calibration Parameters
The following calibration parameters have an implied or direct dependency. Changing either of the parameters might inu-
ence other parameters in the list.
detector | cong | incident_energy
detector | cong | counting_mode
Changing incident_energy or changing the counting_mode causes a reset of the ateld to unity.
detector | cong | ateld
The detector is shipped without atelds. To ensure optimal data quality the user is encouraged to upload custom atelds
on the detector. More information on how to upload custom atelds is given in chapter 11.
DECTRIS QUADRO®User Manual v1.7.1 15 | 33