Related Manuals for Dectris PILATUS 4
Summary of Contents for Dectris PILATUS 4
- Page 1 User Manual ® DECTRIS PILATUS Document Version v1.0.2 DECTRIS Ltd. 5405 Baden-Daettwil Switzerland www.dectris.com...
- Page 2 Document Version v1.0.2 © Copyright 2025 DECTRIS Ltd.
-
Page 3: Table Of Contents
Gating Mode ”double” ........24 ® DECTRIS PILATUS 4 User Manual v1.0.2... - Page 4 Python Example ......... . . 32 ® DECTRIS PILATUS 4 User Manual v1.0.2...
-
Page 5: General Information
1. GENERAL INFORMATION 1.1. Contact and Support Address: DECTRIS Ltd. DECTRIS USA Inc. DECTRIS Japan K.K. Taefernweg 1 1500 Walnut Street, Suite 1630 Mitsuwa Building 1F 5405 Baden-Daettwil Philadelphia, PA 19102 Minamimachi 63, Himeji-shi Switzerland Hyogo 670-0912, Japan Phone: +41 56 500 21 02... -
Page 6: Warranty Information
(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. -
Page 7: Safety Instructions
• Do not install additional software or change the operating system of the Detector Control Unit. • Do not touch the front window of the detector or the sensor modules. ® DECTRIS PILATUS 4 User Manual v1.0.2 3 | 34... -
Page 8: System Description
3. SYSTEM DESCRIPTION 3.1. Components ® The DECTRIS PILATUS 4 detector system consists of the following components: • PILATUS4 detector • Power supply unit (PSU) • Detector control unit (DCU) • Thermal stabilization unit • Accessories • Documentation 3.2. Hybrid Photon Counting (HPC) Technology 3.2.1. -
Page 9: Continuous Readout
3.2.4. Instant Retrigger ® PILATUS4 X-ray detectors feature the DECTRIS INSTANT RETRIGGER technology for improved high-rate count- ing performance. The Instant Retrigger capability results in non-paralyzable counting and allows for enhanced count-rate correction. -
Page 10: 8-Bit Readout
3.2.5. 8-bit Readout Information ® The 8-bit readout mode is only available with DECTRIS PILATUS 4 X and XE detectors. The PILATUS4 ASIC allows the option to read out only the first 8 bits of every counter instead of the full 16 bits. -
Page 11: Software
ALBULA, which is able to handle the HDF5 images, with the primary aim to display them. ALBULA is available free of charge at www.dectris.com. The ALBULA Python API allows to handle HDF5 files and perform arithmetic operations on image data as well as basic analysis. Furthermore, the API enables seamless integration of the viewer into user-specific infrastructure. -
Page 12: Quick Start Guide
• Type i to 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. ® DECTRIS PILATUS 4 User Manual v1.0.2 8 | 34... -
Page 13: Getting Started
• Turn on the power switch at the back of the detector and press the power button on the front of the detector control unit. ® DECTRIS PILATUS 4 User Manual v1.0.2 9 | 34... -
Page 14: Web Interface Overview
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 support@dectris.com. The bug report is not sent automatically. ®... -
Page 15: System Settings And Administration
Select and view detector logs, including error, warning and debugging information. Health View system health information, such as temperature and humidity history, as well as board errors. About Display system details. ® DECTRIS PILATUS 4 User Manual v1.0.2 11 | 34... -
Page 16: General Usage Of The Detector System
7. Repeat from step 2 for further data acquisition with different settings or to step 3 for identical settings. Buffer space varies dependent on the configuration of your system, buffer overflow will cause loss of data. See API Reference for further details. ® DECTRIS PILATUS 4 User Manual v1.0.2 12 | 34... -
Page 17: Control Of The Detector From A Specific Environment
With the filewriter mode set to ”enabled”, the acquired data is written to HDF5 files. The filewriter has the following important configuration parameters: • filewriter | config | mode • filewriter | config | name_pattern • filewriter | config | nimages_per_file ® DECTRIS PILATUS 4 User Manual v1.0.2 13 | 34... -
Page 18: Additional Configuration Parameters
• beam_center_x • beam_center_y • detector_distance • detector_orientation • detector_translation • wavelength (see section 7.4.1 for dependency with photon_energy) Further parameters and their function are described in the API Reference. ® DECTRIS PILATUS 4 User Manual v1.0.2 14 | 34... -
Page 19: Interdependency Of Configuration Parameters
The flatfield applied for a given photon_energy and threshold_energy is a result of the detector calibration. Dur- ing the factory calibration a multitude of flatfields at different settings have been recorded to ensure optimal data quality of the flatfield for all common settings. ® DECTRIS PILATUS 4 User Manual v1.0.2 15 | 34... -
Page 20: Interdependency Of Timing Parameters
To acquire images with a certain frame rate and best possible duty cycle, a simple procedure is to first set count_time to the inverse of the frame rate and subsequently frame_time to the inverse of the frame rate. ® DECTRIS PILATUS 4 User Manual v1.0.2... -
Page 21: Region Of Interest (Roi)
In the PILATUS4 X detectors the selected ROI can be read out using an increased frame rate compared to a full detector read out. ® DECTRIS PILATUS 4 User Manual v1.0.2... -
Page 22: Trigger And Gating Introduction
As the trigger command is sent over an TCP/IP connection the exact latency of the start of the exposure is hard to predict. ® DECTRIS PILATUS 4 User Manual v1.0.2 18 | 34... -
Page 23: Inte - Internal (Software) Enable
Table 9.3 summarises the commands issued to record the same series. As the trigger command is sent over an TCP/IP connection the exact latency of the start of the exposure is hard to predict. ® DECTRIS PILATUS 4 User Manual v1.0.2... -
Page 24: Exts - Externally Triggered Exposure Series
{”value”: ”exts”} detector | config | nimages {”value”: 10} detector | config | ntrigger {”value”: 1} detector | config | frame_time {”value”: 1.0} detector | config | count_time {”value”: 0.7} ® DECTRIS PILATUS 4 User Manual v1.0.2 20 | 34... -
Page 25: Exte - Externally Enabled Exposure Series
{”value”: 1} detector | config | ntrigger {”value”: 10} detector | config | frame_time {”value”: 1.0} (see Info block #9) detector | config | count_time {”value”: 0.7} (see Info block #9) ® DECTRIS PILATUS 4 User Manual v1.0.2 21 | 34... -
Page 26: Eies - Externally Interrupted Exposure Series
Example configuration for an externally interrupted exposure series: detector | config | nimages {”value”: 1} detector | config | ntrigger {”value”: 4} detector | config | trigger_mode {”value”: ”eies”} ® DECTRIS PILATUS 4 User Manual v1.0.2 22 | 34... -
Page 27: Extg - Externally Gated Exposure
Figure 9.5: Schematic illustrating the ”eies” mode and the usage of the ntriggers_skipped parameter. 9.7. EXTG - Externally Gated Exposure Information ® The trigger mode ”extg” is only available with DECTRIS PILATUS 4 X and XE detectors. Caution Consult the Technical Specifications for details about the required electrical characteristics of the gate signal. -
Page 28: General Usage
Counter A will always have an even image_id, while counter B will always be uneven. This feature can be used for example in a pump-and-probe experiment to capture the state before and after the pump simultaneously in a single measurement. ® DECTRIS PILATUS 4 User Manual v1.0.2 24 | 34... -
Page 29: Gating Mode "Single
Please note, that it is not necessary to use the mode ”single” gating mode to achieve a 32-bit dynamic range. The other trigger modes offer auto-summation, also achieving 32 bit depth, and which are generally recom- mended unless you need very short gating windows and minimal jitter. ® DECTRIS PILATUS 4 User Manual v1.0.2 25 | 34... - Page 30 {value: ”single”} detector | config | nexpi {value: 123456} detector | config | nimages {value: 20} detector | config | ntrigger {value: 1} detector | config | countrate_correction_applied {value: ”false”} ® DECTRIS PILATUS 4 User Manual v1.0.2 26 | 34...
-
Page 31: Hdf5 And Albula Albula Overview
. It is a fast and easy-to-use program that allows optimal visualization of the data collected with DECTRIS detectors. The ALBULA API pro- vides a Python interface for image display and for data processing and analysis. The API also enables easy integration of viewer functionality with the user infrastructure and experimental setups. -
Page 32: Albula Hdf5 Python Library
The following examples illustrate how the data stored in HDF5 files by the PILATUS4 detector can be manipu- lated 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") import dectris.albula as albula iterateChildren(node,nodeList=[]): """... -
Page 33: 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() ® DECTRIS PILATUS 4 User Manual v1.0.2 29 | 34... -
Page 34: Writing Data
HDF5 library version used by this software is at least v1.8.11 in order for the plug-in mech- anism to work. ® For developers using C++, example code can be found on the DECTRIS website, after registration and login. See: https://code.google.com/p/lz4/, https://github.com/kiyo-masui/bitshuffle... -
Page 35: Pixel Mask
API Reference for details. The values in this array can then be manipulated to reflect the required updates of the pixel mask. After updating the array, it has to be serialized again in JSON according to the specifications in the API Reference. ® DECTRIS PILATUS 4 User Manual v1.0.2 31 | 34... -
Page 36: Uploading And Storing The Pixel Mask
After sending the detector command arm, the updated pixel mask is permanently stored on the detector system. 11.2.5. Python Example The following Python code using common libraries provides a simple example for updating the pixel mask: ® DECTRIS PILATUS 4 User Manual v1.0.2 32 | 34... - Page 37 = 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/{}'.format(IP, PORT, command) requests.put(url) else: print(reply.content) ® DECTRIS PILATUS 4 User Manual v1.0.2 33 | 34...
-
Page 38: Trademarks And Patents
Trademarks ® Registered trademarks ”DECTRIS”: AU, AUS, CH, CN, DE, FR, IT, JP, KR, USA, UK, ”DETECTING THE FUTURE”: AUS, CH, CN, EU, JP, KR, USA, UK, ”DECTRIS INSTANT RETRIGGER”: AUS, CH, CN, EU, JP, KR, USA, UK ”DECTRIS EIGER”: AUS, CH, CN, EU, JP, KR, USA, UK ”DECTRIS PILATUS”: AUS, CH, CN, EU, JP, KR, USA...
Need help?
Do you have a question about the PILATUS 4 and is the answer not in the manual?
Questions and answers