Dectris MYTHEN Interface Manual

Dectris MYTHEN Interface Manual

Detector system socket interface specification

Advertisement

Quick Links

Socket Interface
Specification
MYTHEN Detector System
Version:
Document Version:
3.0.0
2
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 MYTHEN and is the answer not in the manual?

Questions and answers

Summary of Contents for Dectris MYTHEN

  • Page 1 Socket Interface Specification MYTHEN Detector System Version: 3.0.0 Document Version: DECTRIS Ltd. 5405 Baden- Daettwil Switzerland www.dectris.com...
  • Page 2 Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 2/34...
  • Page 3: Table Of Contents

    7.1.3. Detector settings 7.1.4. Data correction 7.1.5. Trigger / Gate 7.1.6. Debugging 7.1.7. Deprecated commands 7.2. Error Codes 7.3. Decoding the raw data 8. Release Notes 8.1. Version 3.0.0 Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 3/34...
  • Page 4 8.5. Version 2.0.3 8.6. Version 2.0.2 8.7. Version 2.0.1 8.8. Version 2.0.0 8.8.1. New Functionalities 8.8.2. Migration notes 8.8.3. Legacy Mode 9. Appendix 9.1. Table of Tables 9.2. Referenced Documents Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 4/34...
  • Page 5: Document History

    3.0.0 DV1.0 21.09.2012 Simplified operation of the detector system Better data quality due to optimized calibration Restricted threshold and energy ranges By default all commands affect all active modules Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 5/34...
  • Page 6: How To Use This Guide

    How to use this guide Before you start to operate the MYTHEN detector system please read the User Manual and the Technical Documentation included in the documentation package carefully. This document has been designed for the MYTHEN detector systems. 2.1.
  • Page 7: Explanation Of Symbols

    The smallest fully functional unit of the detector (1280 channels). Module Control Board FIFO Storage working according to the First In - First Out principle Kilo electron Volt Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 7/34...
  • Page 8: Disclaimer

    DECTRIS Ltd. 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 Ltd. it is prohibited to integrate the protected contents published in these applications into other programs or other Web sites or to use them by any other means.
  • Page 9: Warnings

     The embedded Linux operating system on the detector control system has customized software for controlling the MYTHEN detector system. Do not make any changes to the Linux operating system without explicit instructions from DECTRIS Ltd. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2...
  • Page 10: Introduction

    To take advantage of new functionality and bug fixes, it is possible to update to a newer version of the MYTHEN Socket Server within the same major release. The configuration files and the network settings stored on the DCS will not be affected by the update.
  • Page 11: Operation

    The number of active modules to be used can be specified using the “-nmodules” command. The MYTHEN system can also be operated with more than the delivered modules if the corresponding calibration files are available on the DCS. When increasing the number of active modules, all modules are set back to default settings.
  • Page 12: Settings

    The status of the acquisition can be checked with the "-status" command. Sending commands other than "- readout", "-status" or "-stop" during an acquisition can result in misbehavior of the detector. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 12/34...
  • Page 13: Data Corrections

    For debugging problems related to the transmission of the data packages over the socket, the freely available network protocol analyzer WireShark can be used. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 13/34...
  • Page 14: Example Applications

    They set up a socket connection to the DCS and read back the module serial numbers. Afterwards a short acquisition is performed, and the result is printed on the command prompt. The Windows version was developed with the freely available Microsoft Visual C++ 2008 Express Edition. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 14/34...
  • Page 15: Commands

    Return Size: Specifies the number of data elements in the returned byte array. For example a response of return type int and return size 1280 is 5120 bytes long (since one integer uses 4 bytes). N stands for the number of active modules (set by "-nmodules"). Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 15/34...
  • Page 16: General Commands

    Number of modules Sets the number of active modules (N ). When the number of active modules is increased, all modules are set back to default settings. After Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 16/34...
  • Page 17 -reset Sets the detector back to default settings. This command takes about two seconds per module. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 17/34...
  • Page 18: Acquisition Control

    If the buffer is empty and there is an ongoing measurement, the command returns the data after the measurement has finished. If the readout fails for some reason, all count values are set to -1. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 18/34...
  • Page 19 Stops the current acquisition. The data of the ongoing frame is discarded. -time ˂time˃ Exposure time in units of Sets the exposure time of one frame. 100ns. Default is 1s. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 19/34...
  • Page 20: Detector Settings

    The supported ranges depend on the Defaults are f1 = 6.4 keV calibration of the system. This command takes about two and f2 = 8.05 keV. seconds per module. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 20/34...
  • Page 21 The following table shows, how this commands relates to –kthreshenergy is equivalent to -settings Cr -kthreshenergy 4.8 5.41 -settings Cu -kthreshenergy 6.4 8.05 -settings Mo -kthreshenergy 8.74 17.48 -settings Ag -kthreshenergy 11.08 22.16 Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 21/34...
  • Page 22: Data Correction

    Sets the dead time constant (used by the rate correction) in units of ns for the selected modules. If the argument is equal to -1.0 the system uses predefined values appropriate for the loaded settings. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 22/34...
  • Page 23: Trigger / Gate

    (active high or low). 1: falling edge / active low -outpol ˂b˃ 0: active high Sets the polarity of the enable out signal. 1: active low Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 23/34...
  • Page 24 -trigen ˂b˃ 0: Disable Enables or disables the trigger mode. The acquisition 1: Enable starts after the trigger signal. Subsequent frames are started automatically. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 24/34...
  • Page 25: Debugging

    For a bad edge channel, the return value is twice the value of its neighbor minus the value of its neighbor after next Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 25/34...
  • Page 26: Deprecated Commands

    "auto ˂thr˃ ˂e˃" (with ˂thr˃ being the threshold and ˂e˃ the energy) or “manual” if not all modules have the same settings. In legacy2 mode the result string is of the form "predefined StdCu or "auto ˂thr˃. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 26/34...
  • Page 27 = TrimCr | TrimCu | Deprecated version of the "-settings" command. The TrimMo arguments TrimCr, TrimCu, TrimMo corresponde to the arguments HgCr, StdCu, StdMo of the "-settings" command. Socket Interface Specification. MYTHEN Detector System. Version: 3.0.0, Document Version: 2 27/34...
  • Page 28: Error Codes

    Invalid format of the gain calibration file Dead time file not found Invalid format of the dead time file Could not create log file Could not close log file Could not read log file Socket Interface Specification. MYTHEN Detector System. Version: 2 28/34...
  • Page 29: Decoding The Raw Data

    // unsigned int32 for (int j = 0; j < chanperline; j++) int shift = nbits*j; int shiftedMask = mask<<shift; for (int i = 0; i < size; i++) result[i*chanperline+j]=((tmpArray[i]&shiftedMask)>>shift)&mask; Socket Interface Specification. MYTHEN Detector System. Version: 2 29/34...
  • Page 30: Release Notes

    New command “-get commandid” to retrieve a command identifier. This can be used to make sure that no other clients changed the state of the system.  New command “-testpattern” for debugging purposes.  Legacy2 mode for backwards compatibility with version 2. Socket Interface Specification. MYTHEN Detector System. Version: 2 30/34...
  • Page 31: Migration Notes

     Commands retrieving module specific information return the values for all values.  The “-kthresh” commands only accepts arguments within the range supported by the specific MYTHEN system.  Since the gain automatically changes with the threshold energy, the number of bad channels can change with the specified threshold energy.
  • Page 32: Version

    The initialization sets the number of modules to the number of delivered modules. For systems which are delivered with less modules than the DCS maximally supports (e.g. a MYTHEN 3K with 3 modules on a DCS6), the user no longer needs to specify the number of modules. The command to set the number of active modules is only necessary for running a system with less (or more) than the number of delivered modules.
  • Page 33: New Functionalities

    If for some reasons you are not going to migrate, you can enable the legacy mode with the "-legacy" command. After having sent this command, the server should behave identically to version 1.3.0 up to bug fixes and the more detailed error responses. Socket Interface Specification. MYTHEN Detector System. Version: 2 33/34...
  • Page 34: Appendix

    Table 5 Trigger and Gating control commands..................23 Table 6 Debugging commands........................25 Table 7 Depreceated commands........................ 26 Table 8 List of error codes.......................... 28 9.2. Referenced Documents All the following documents are available through DECTRIS Ltd. homepage. https://www.dectris.com/technical_mythen.html#main_head_navigation Term Description Firmware Update Guide Firmware_Update-MYTHEN-V1_6.pdf Module Handling Instructions Handling_Instructions-MYTHEN-V2_1.pdf...

Table of Contents