Software for the New General detector Controller (NGC) DETECTORS FOR ASTRONOMY Garching (Germany), October 2009 Claudio Cumani / Jörg Stegmeier

DetectorDetector FEBFEB Up DownSequencer Clock/BiasDriver 4 - ADC DetectorDetector DetectorDetector DetectorDetector DetectorDetector DetectorDetector Up Down 23 [N] - ADC Up Down 23 [N] - ADC Up Down 23 [N] - ADC Up Down 23 [N] - ADC Up Down 23 [N] - ADC DetectorDetector DetectorDetector AQAQ Up Down [N] - ADC AQAQ Up Down [N] - ADC NGCLLCU(Linux) NGCLLCU(Linux) NGC System Overview Shutter-Ctrl LLCU = Linux Local Control Unit Preamp-Ctrl 2

NGCLLCU(Linux)NGCLLCU(Linux) IWS(Linux) … Instrument LAN Fast Ethernet/ Gigabit-Ethernet With the current Linux-PC model With the current Linux-PC model we can achieve 200 Mbytes/s sustained input data-rate with co-adding (double correlated read-out) NGC Computing Architecture Programming Language: Programming Language: C++ for control processes C++ for control processes Tcl/Tk for GUI and Startup- Scripts Tcl/Tk for GUI and Startup- Scripts 3

Goals One software basis for both optical and infrared applications. One software basis for both optical and infrared applications. Maximum heritage of the strength of both IRACE (infrared predecessor) and FIERA (optical predecessor). Maximum heritage of the strength of both IRACE (infrared predecessor) and FIERA (optical predecessor). Modular object oriented architecture. Modular object oriented architecture. Configurable for all possible system realizations (i.e. number of ADC-modules, number of bias-generators etc.). Configurable for all possible system realizations (i.e. number of ADC-modules, number of bias-generators etc.). Easily programmable clock-pattern generation. Easily programmable clock-pattern generation. Synchronization with external events. Synchronization with external events. Version control and automated testing. Version control and automated testing. 4

Config.-Files Database FITS-Files Control Server Real-Time Display Real-Time Display Instrument Workstation Command/ Reply Driver-Interface-Process Device Driver NGC LLCU PCI-Bus Interface Fiber-Optic-Link to NGC Front End Data Commands Acquisition Process (Pre-Processing, Sorting,…) Acquisition Process (Pre-Processing, Sorting,…) GUI Data-Acquisition-Process (Pre-Processing, Sorting,…) Data-Acquisition-Process (Pre-Processing, Sorting,…) Error-System Log-System The Processes 5

NGC-DCS Control Server The control server can be used as NGC-HW Control Sub- System of the NGC Optical Software (NGCOSW). That is the maximum degree of communality as the same compiled and linked object is used by both applications to access the HW. The control server can be used as NGC-HW Control Sub- System of the NGC Optical Software (NGCOSW). That is the maximum degree of communality as the same compiled and linked object is used by both applications to access the HW. It can be configured at Run-Time for the one or the other purpose. It can be configured at Run-Time for the one or the other purpose. This is also used as general Engineering Tool. This is also used as general Engineering Tool. Config.-Files Database FITS-Files Instrument Workstation Command/ Reply GUI Error-System Log-System Control Server Infrared Applications 6

Controller Programming The detector voltages are defined in a Voltage Configuration File in Short-FITS format (xxx.v). The detector voltages are defined in a Voltage Configuration File in Short-FITS format (xxx.v). Clock-Pattern blocks can be defined both in ASCII- Format (xxx.clk) and in a Binary Format (xxx.bclk, output of the Graphical Editing Tool BlueWave). The formats can be converted automatically. Clock-Pattern blocks can be defined both in ASCII- Format (xxx.clk) and in a Binary Format (xxx.bclk, output of the Graphical Editing Tool BlueWave). The formats can be converted automatically. Synchronization with external events (e.g. trigger) can be done after any state in any clock-pattern block. Synchronization with external events (e.g. trigger) can be done after any state in any clock-pattern block. A Sequencer Programming Language has been defined to program the clock-pattern execution. A Sequencer Programming Language has been defined to program the clock-pattern execution. There may be Multiple Sequencer Instances within one detector front end system. There may be Multiple Sequencer Instances within one detector front end system. 7

Clock-Pattern Generation The clock pattern blocks define sequences of clock states, which are stored in a RAM inside the NGC sequencer hardware. The clock pattern blocks define sequences of clock states, which are stored in a RAM inside the NGC sequencer hardware. The bits in the RAM define the state of each physical clock line plus: The bits in the RAM define the state of each physical clock line plus: Some control bits (“wait-for-trigger”, “end-of-pattern”). Some control bits (“wait-for-trigger”, “end-of-pattern”). The duration of each state (dwell time) is defined in the state itself. The duration of each state (dwell time) is defined in the state itself. Patterns can be programmed via a graphical tool (Bluewave) Patterns can be programmed via a graphical tool (Bluewave) PATRAM Pattern RAM High Pattern RAM Low … + 0: State 1 … + 1: State 2 … + 2: State 3 : … +(n-1): State n … + n: State 1 … +(n+1): State 2 … +(n+2): State 3 : … +(n+m-1): State m ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ Clock Pattern 1 Pattern 2 End of Pattern 8

Address : Pattern-RAM HI Pattern-RAM LO BIT [31..0] BIT [31..0] PATRAM+ 0: PATRAM+ 1: PATRAM+ 2: PATRAM+ 3: PATRAM+ 4: PATRAM+ 5: PATRAM+ 6: PATRAM+ 7: PATRAM+ 8: PATRAM+ 9: PATRAM+10: PATRAM+11: PATRAM+12: PATRAM+13: PATRAM+14: PATRAM+15: PATRAM+16: PATRAM+17: PATRAM+18: : Clock-Pattern Block 1 Clock-Pattern Block 1 Clock-Pattern Block 2 Clock-Pattern Block 2 Clock-Pattern Block 3 Clock-Pattern Block 3 Clock-Pattern Block 4 Clock-Pattern Block 4 Sequencer Programming The sequencer program defines the order of execution of the defined clock pattern blocks. The sequencer program defines the order of execution of the defined clock pattern blocks. Simple 7-instruction code RAM. Simple 7-instruction code RAM. Easy to be compiled. Easy to be compiled. Address : BIT [30..28] [26..11] [10..0] SEQRAM+0: [LOOP] [N] [-] SEQRAM+1: [EXEC] [N] [PATRAM offset] SEQRAM+2: [LOOP] [N] [-] SEQRAM+3: [EXEC] [N] [PATRAM offset] SEQRAM+4: [LOOPEND] [-] [-] SEQRAM+5: [JSR] [-] [SEQRAM offset] SEQRAM+6: [LOOPEND] [-] [-] SEQRAM+7: [EXIT] [-] [-] : … +offset : [EXEC] [N] [PATRAM offset] … +offset+1: [EXEC] [N] [PATRAM offset] … +offset+2: [RETURN] [-] [-] [LOOP] = 010 [JSR] = 101 [EXEC] = 001 [LOOPINF] = 100 [RETRUN] = 110 [EXIT] = 000 [LOOPEND] = 011 9

Sequencer Program Language The sequencer program language is fully driven by Setup Parameters (e.g. detector integration time, number of integrations, window parameters, …). The sequencer program language is fully driven by Setup Parameters (e.g. detector integration time, number of integrations, window parameters, …). Support of Arithmetic Expression Evaluation (TCL- syntax) to derive any program-loop parameter from the setup parameters and to compute attributes like exposure time estimation and minimum DIT. Support of Arithmetic Expression Evaluation (TCL- syntax) to derive any program-loop parameter from the setup parameters and to compute attributes like exposure time estimation and minimum DIT. Support of Sub-Routines and Include-Files to minimize the code length. Support of Sub-Routines and Include-Files to minimize the code length. 10

Synchronization points can be inserted at any place in any clock pattern executed by the sequencer program (i.e. set the “wait-for-trigger” bit in the particular state). Synchronization points can be inserted at any place in any clock pattern executed by the sequencer program (i.e. set the “wait-for-trigger” bit in the particular state). When reaching such a point the pattern execution is suspended until the arrival of an external trigger signal. When reaching such a point the pattern execution is suspended until the arrival of an external trigger signal. External Synchronization 11

Infrared “Exposures” Sustained Detector Read-Out and Video Display (display remains active during the “Exposure”). Sustained Detector Read-Out and Video Display (display remains active during the “Exposure”). Sustained Data-Transfer between NGC-LLCU and Instrument Workstation for application specific Post- Processing (slow control loops, e.g. secondary auto- guiding). Sustained Data-Transfer between NGC-LLCU and Instrument Workstation for application specific Post- Processing (slow control loops, e.g. secondary auto- guiding). Starting an “Exposure” basically means “starting to transfer data to disk”. Starting an “Exposure” basically means “starting to transfer data to disk”. Burst-Mode for fast raw data acquisition. Burst-Mode for fast raw data acquisition. 12

Data Acquisiton Processes Multi-threaded pre-processing framework. Multi-threaded pre-processing framework. High concurrency (receive, process, transfer to multiple readers, handle command). High concurrency (receive, process, transfer to multiple readers, handle command). One process per read-out mode guarantees maximum independency and maximum safety (cannot corrupt working code, releases all resources). One process per read-out mode guarantees maximum independency and maximum safety (cannot corrupt working code, releases all resources). Template Processes have been developed, which are an easy-to-use and stand-alone tool to visualize NGC raw- data on the real-time display. Template Processes have been developed, which are an easy-to-use and stand-alone tool to visualize NGC raw- data on the real-time display. Standard acquisition processes for the ESO Standard IR Detectors (HAWAII 1Kx1K, HAWAII2-RG 2Kx2K, SELEX, AQUARIUS, …) are available within the NGC software package. Special setups (e.g. mosaics) may require special software modules. Standard acquisition processes for the ESO Standard IR Detectors (HAWAII 1Kx1K, HAWAII2-RG 2Kx2K, SELEX, AQUARIUS, …) are available within the NGC software package. Special setups (e.g. mosaics) may require special software modules. 13

Frame Types User-definable Frame-Types (Raw-Sample, Mean-Value, Standard-Deviation, Half-Chop-Cycle, Intermediate Results…). User-definable Frame-Types (Raw-Sample, Mean-Value, Standard-Deviation, Half-Chop-Cycle, Intermediate Results…). The types can be selected to be generated/stored during an exposure. The types can be selected to be generated/stored during an exposure. Exposure Break-Conditions can be set per “per frame- type”. Exposure Break-Conditions can be set per “per frame- type”. Individual SW-Windows per frame-type. Individual SW-Windows per frame-type. 14

Data Interface FITS-Files FITS-Files Wait for exposure termination and read the generated FITS-file(s). Wait for exposure termination and read the generated FITS-file(s). Direct connection to Acquisition Process (e.g. real-time display) Direct connection to Acquisition Process (e.g. real-time display) Retrieve the binary image data with just minimum header information (dimension, type, sequential number). Retrieve the binary image data with just minimum header information (dimension, type, sequential number). Post-Processing Call-Back Post-Processing Call-Back The control server calls a user-defined procedure before the frame is stored. The control server calls a user-defined procedure before the frame is stored. 15

Optical vs. IF NGC Active intervention of the control-server during the exposure is required (application of new voltages in each state “wiping”, “integrating”, “reading”). Active intervention of the control-server during the exposure is required (application of new voltages in each state “wiping”, “integrating”, “reading”). “Active” interface to different kinds of shutter controllers (open/close, status check, open/close delays, etc.). “Active” interface to different kinds of shutter controllers (open/close, status check, open/close delays, etc.). 16

Finite State Machine Detector controllers can be modeled as finite state machines i.e.: model of behavior composed of a finite number of states, transitions between those states, and actions 17

State Machine - UML Designed using UML (Unified Modeling Language) Designed using UML (Unified Modeling Language) From this model, code can be automatically generated! From this model, code can be automatically generated! 18

wsf Code generation tool: ESO wsf - workstation software framework: 1.state design (described by a configuration file) 2.automatic code generation from state design “automatically generated” code handles state transitions, messages, commands, error conditions, etc. (NOT the actions needed to drive an exposure!) 3.implementation of detector control code (CCD, shutter, etc) 19

Results Code dimension: Code dimension: NGC Base-SW: lines of code (Test SW = 16 %) NGC Base-SW: lines of code (Test SW = 16 %) NGC IR-SW: lines of code (Test SW = 12 %) NGC IR-SW: lines of code (Test SW = 12 %) NGC Optical SW: lines of code (Test SW = 27 %) NGC Optical SW: lines of code (Test SW = 27 %) Code dimension for optical NGC ~ code dimensions for FIERA controller Code dimension for optical NGC ~ code dimensions for FIERA controller Automatically generated code for optical NGC is 78% of the total optical NGC code (without Test SW) Automatically generated code for optical NGC is 78% of the total optical NGC code (without Test SW) All NGC software modules are under version control and contain test procedures for automated testing according to the ESO VLT SOFTWARE standards. All NGC software modules are under version control and contain test procedures for automated testing according to the ESO VLT SOFTWARE standards. 20

Goals are achieved…  One software basis for both optical and infrared applications.  Maximum heritage of the strength of both IRACE (infrared predecessor) and FIERA (optical predecessor).  Modular object oriented architecture.  Configurable for all possible system realizations (i.e. number of ADC-modules, number of bias-generators etc.).  Easily programmable clock-pattern generation.  Synchronization with external events.  Version control and automated testing. 21