/** \page hadaq_plugin HADAQ plugin for DABC (libDabcHadaq.so)
*
* \subpage hadaq_plugin_doc
*
* \subpage hadaq_trb3_package
*
*
* \ingroup dabc_plugins
*
*/
/** \page hadaq_plugin_doc Short description of HADAQ plugin
*
* This should be description of HADAQ plugin for DABC.
*
*/
/** \page hadaq_trb3_package Software collection for TRB3
Introduction
============
This is short instruction how dabc/go4/stream frameworks can be installed and
used for data taking and online/offline analysis of [TRB3](http://trb.gsi.de) data.
There are two main parts of software:
1. DABC which is required to take data from TRB3 and store to hld or lmd files
2. ROOT/Go4/stream frameworks to analyse online/offline TRB3/TDC data
The easiest way to install all necessary software components is use repository
https://subversion.gsi.de/dabc/trb3
Installation of all components in once
======================================
This method describes how DABC, ROOT, Go4 and stream analysis can be installed
with minimal efforts.
Requirements
------------
Following packages should be installed:
* libqt4-devel
* xorg-devel
* g++
[Here is full list of prerequisites for ROOT](http://root.cern.ch/drupal/content/build-prerequisites)
It is recommended to use bash (at least, during compilation)
Reuse existing ROOT installation
--------------------------------
Most of the time is consumed by ROOT compilation, therefore if ROOT
already installed on your machine, it can be reused. Just configure
ROOTSYS, PATH and LD_LIBRARY_PATH variables before starting.
For instance, call thisroot.sh script:
[shell] . your_root_path/bin/thisroot.sh
Compilation
-----------
To checkout and compile all components, just do:
[shell] svn co https://subversion.gsi.de/dabc/trb3 trb3
[shell] cd trb3
[shell] make -j4
During compilation makelog.txt file will be created in each sub-directory.
In case of any compilation problem please send me (S.Linev@gsi.de)
error message from that file.
Before using
------------
There is login script 'trb3login', which must be called before software can be used
[shell] . your_trb3_path/trb3login
It set all shell variables, which are required for DAQ and analysis
Update from repository
----------------------
To obtain newest version from repository do:
[shell] cd your_trb3_path
[shell] make -j4 update
Installation of packages separately
===================================
Use this methods only if installation of all packages at once did not work or
one need only some specific package to install.
Installation of DABC
--------------------
If only DAQ functionality is required, than one need to install DABC only.
It is much faster and easier. Just do:
[shell] svn co https://subversion.gsi.de/dabc/trunk dabc
[shell] cd dabc; make nodim=1 -j4
[shell] . ./dabclogin
Installation of ROOT
--------------------
See http://root.cern.ch for information
Installation of Go4
-------------------
Main information in http://go4.gsi.de.
To install from repository first initialize ROOT variables, than do:
[shell] svn co https://subversion.gsi.de/go4/trunk go4
[shell] cd go4; make -j4
[shell] . ./go4login
Installation of stream
----------------------
First compile and configure go4. Than:
[shell] svn co https://subversion.gsi.de/go4/app/stream stream
[shell] cd stream; make -j4
[shell] . ./streamlogin
Running of DAQ
==============
To run DAQ, only DABC installation is required.
Example configuration file is in https://subversion.gsi.de/dabc/trunk/plugins/hadaq/app/EventBuilder.xml
Copy it in any suitable place and modify it for your needs.
Main configuration parameters:
Memory pool
-----------
Defines number and size of buffers, used in application. Normally must remain as is.
Should be increased if queue sizes of input/output ports are increased
Combiner module
---------------
It is central functional module of the DAQ application.
It could have arbitrary number of inputs, defined by NumInputs parameter.
Each input corresponds to separate TRB3 board which should be readout.
For each input only correct UDP port number should be specified like:
Here only port number 10101 is relevant, all other parameters must remain as is.
Events, produced by combiner module, can be stored in hld file or (and) delivered
via online server to online analysis.
Write HLD files
---------------
To write HLD files, one should specify following parameters in combiner module:
Only second output port (name Output1) can be use for HLD file storage.
maxsize defines maximum size (in MB) of file, which than will be closed and new
file will be started
## Configure online server
Combiner module should have at least one output and
auto="true" should be specified for "OnlineServer" module.
hadaq events will be delivered to "OnlineServer" module, where
conversion into lmd format will be done (just adding lmd headers).
Produced data can be provided to online server - configured for Output0:
At the same time, data can be stored to lmd file. One should set two output ports
and name of output file provide in configuration of second output port:
Here maxsize also defines maximum size of output file.
Running DABC
------------
Once configuration file is adjusted, one should call:
[shell] dabc_exe EventBuilder.xml
Execution can always be regularly stopped by Ctrl-C.
All opened files will be closed normally.
Usage of web-server
-------------------
One able to observe and control running DAQ application via web browser.
After DAQ is started, one could open in web browser address like
`http://your_host:8090`. Port number 8090 can be changed in configuration
of HttpServer.
In browser one should be able to see hierarchy with two folders:
+ "Hadaq/Combiner" for combiner module
+ "Hadaq/Transmitter" for online server module.
In the folders one will find published ratemeters and log messages.
Most useful part of web-server now - possibility to start/stop file writings.
For instance, in "Hadaq/Combiner" folder there are two commands:
+ "StartHldFile" start file writing
+ "StopHldFile" stop file writing.
Running analysis
================
Analysis code is provided in new __stream__ project.
It is generic analysis framework, dedicated for synchronization and
processing of different kinds of time-stamped data streams. Classes,
relevant for TRB3/FPGA-TDC processing located in
[header](https://subversion.gsi.de/go4/app/stream/include/hadaq/) and
[source](https://subversion.gsi.de/go4/app/stream/framework/hadaq/) directories.
In principle, in most cases it is not required to change these classes -
all user-specific configurations provided in ROOT script, which can be found in
[example](https://subversion.gsi.de/go4/app/stream/applications/trb3tdc/) directory.
It shows how to process data from several TDCs. Please read comment in script itself.
One can always copy such script to any other location and modify it to specific needs.
Running in batch
----------------
To run analysis in batch (offline), start from directory where first.C script is
situated:
[shell] go4analysis -user file_0000.hld
or if lmd files were written:
[shell] go4analysis -file file_0000.lmd
Advantage of lmd file usage - wildcard expression can be specified like:
[shell] go4analysis -file file_000*.lmd
After analysis finished, filled histograms will be saved in Go4AutoSave.root file and
can be viewed in ROOT or in Go4 browser. Just type:
[shell] go4 Go4AutoSave.root
There are many parameters of go4analysis executable (run go4analysis -help).
For instance, one can run only specified number of events or change output file name:
[shell] go4analysis -user file_0000.hld -number 100000 -asf new_name.root
Running analysis online
-----------------------
First of all, online server should be configured in DABC. In any moment one
could start analysis from batch, connecting to DABC server with command:
[shell] go4analysis -stream dabc_host_name
With Ctrl-C one can always stop execution and check histograms in auto-save file.
But more convenient way is to run analysis from the gui to be able monitor
all histogram in live mode. For that one need:
1. start go4 gui (type go4) from directory with first.C macro
2. Select "Launch analysis" menu command in go4
3. set "Dir" parameter to "." (current directory)
4. keep empty library name file of analysis code
(library will be located automatically by go4 itself)
5. when analysis configuration window appears,
select "MBS stream server" and host name of DABC
(can be localhost if DABC runs on same machine)
6. press "Submit and start" button
Via analysis browser one can display and monitor any histogram.
For more details about go4 see introduction on http://go4.gsi.de.
Running hldprint
================
hldprint is small utility to printout HLD data from different sources:
local hld files, remote hld files and running dabc application.
It also supports printout of TDC messages.
For instance, printing of messages from TDC with mask 0xC003 can be done with command:
~~~~~~~~~~~~~~~~
[shell] hldprint file_0000.hld -tdc 0xc003 -hub 0x9000 -num 1
~~~~~~~~~~~~~~~~
Result is:
~~~~~~~~~~~~~~~~
*** Event #0x10b7b7 fullid=0x2001 runid=0x0bc01162 size 424 ***
*** Subevent size 388 decoding 0x020011 id 0x8000 trig 0x9578eaf0 swapped align 4 ***
*** Subsubevent size 19 id 0xc000 full 0013c000
[ 1] 21660000 tdc header
[ 2] 6f68537d epoch 258495357 tm 5587568640.000 ns
[ 3] 80118d18 hit ch: 0 isrising:1 tc:0x518 tf:0x118 tm:5587575162.766 ns
[ 4] 6f68537c epoch 258495356 tm 5587558400.000 ns
[ 5] 808e0fb6 hit ch: 2 isrising:1 tc:0x7b6 tf:0x0e0 tm:5587568272.170 ns
[ 6] 6f68537c epoch 258495356 tm 5587558400.000 ns
[ 7] 8104efb5 hit ch: 4 isrising:1 tc:0x7b5 tf:0x04e tm:5587568265.617 ns
[ 8] 6f68537c epoch 258495356 tm 5587558400.000 ns
[ 9] 81848fb5 hit ch: 6 isrising:1 tc:0x7b5 tf:0x048 tm:5587568265.553 ns
[10] 6f68537c epoch 258495356 tm 5587558400.000 ns
[11] 82063fb5 hit ch: 8 isrising:1 tc:0x7b5 tf:0x063 tm:5587568265.840 ns
[12] 6f68537c epoch 258495356 tm 5587558400.000 ns
[13] 8283afb5 hit ch:10 isrising:1 tc:0x7b5 tf:0x03a tm:5587568265.404 ns
[14] 6f68537c epoch 258495356 tm 5587558400.000 ns
[15] 830befb5 hit ch:12 isrising:1 tc:0x7b5 tf:0x0be tm:5587568266.809 ns
[16] 6f68537c epoch 258495356 tm 5587558400.000 ns
[17] 83989fb6 hit ch:14 isrising:1 tc:0x7b6 tf:0x189 tm:5587568273.968 ns
[18] 6f68537c epoch 258495356 tm 5587558400.000 ns
[19] 8415cfb6 hit ch:16 isrising:1 tc:0x7b6 tf:0x15c tm:5587568273.489 ns
*** Subsubevent size 3 id 0xc001 full 0003c001
[21] 21660000 tdc header
[22] 6f68537d epoch 258495357 tm 5587568640.000 ns
[23] 8007dd18 hit ch: 0 isrising:1 tc:0x518 tf:0x07d tm:5587575161.117 ns
*** Subsubevent size 20 id 0x9000 full 00149000
*** Subsubevent size 19 id 0xc003 full 0013c003
[26] 21660000 tdc header
[27] 6f68537d epoch 258495357 tm 5587568640.000 ns
[28] 80151cce hit ch: 0 isrising:1 tc:0x4ce tf:0x151 tm:5587574793.372 ns
[29] 6f68537c epoch 258495356 tm 5587558400.000 ns
[30] 8083cf6b hit ch: 2 isrising:1 tc:0x76b tf:0x03c tm:5587567895.426 ns
[31] 6f68537c epoch 258495356 tm 5587558400.000 ns
[32] 8106ef6b hit ch: 4 isrising:1 tc:0x76b tf:0x06e tm:5587567895.957 ns
[33] 6f68537c epoch 258495356 tm 5587558400.000 ns
[34] 81840f6b hit ch: 6 isrising:1 tc:0x76b tf:0x040 tm:5587567895.468 ns
[35] 6f68537c epoch 258495356 tm 5587558400.000 ns
[36] 82033f6b hit ch: 8 isrising:1 tc:0x76b tf:0x033 tm:5587567895.330 ns
[37] 6f68537c epoch 258495356 tm 5587558400.000 ns
[38] 8289bf6b hit ch:10 isrising:1 tc:0x76b tf:0x09b tm:5587567896.436 ns
[39] 6f68537c epoch 258495356 tm 5587558400.000 ns
[40] 83066f6b hit ch:12 isrising:1 tc:0x76b tf:0x066 tm:5587567895.872 ns
[41] 6f68537c epoch 258495356 tm 5587558400.000 ns
[42] 8394af6b hit ch:14 isrising:1 tc:0x76b tf:0x14a tm:5587567898.298 ns
[43] 6f68537c epoch 258495356 tm 5587558400.000 ns
[44] 8414bf6b hit ch:16 isrising:1 tc:0x76b tf:0x14b tm:5587567898.309 ns
*** Subsubevent size 29 id 0xc002 full 001dc002
[46] 21660000 tdc header
[47] 6f68537d epoch 258495357 tm 5587568640.000 ns
[48] 80119d19 hit ch: 0 isrising:1 tc:0x519 tf:0x119 tm:5587575167.777 ns
[49] 6f68537d epoch 258495357 tm 5587568640.000 ns
[50] 80c7b840 hit ch: 3 isrising:1 tc:0x040 tf:0x07b tm:5587568961.096 ns
[51] 80d26845 hit ch: 3 isrising:1 tc:0x045 tf:0x126 tm:5587568987.915 ns
[52] 80d0d8d1 hit ch: 3 isrising:1 tc:0x0d1 tf:0x10d tm:5587569687.649 ns
[53] 80dc58fc hit ch: 3 isrising:1 tc:0x0fc tf:0x1c5 tm:5587569904.606 ns
[54] 80d06a23 hit ch: 3 isrising:1 tc:0x223 tf:0x106 tm:5587571377.574 ns
[55] 80c2ea81 hit ch: 3 isrising:1 tc:0x281 tf:0x02e tm:5587571845.277 ns
[56] 80c31ae2 hit ch: 3 isrising:1 tc:0x2e2 tf:0x031 tm:5587572330.309 ns
[57] 80c62b42 hit ch: 3 isrising:1 tc:0x342 tf:0x062 tm:5587572810.830 ns
[58] 80c72b77 hit ch: 3 isrising:1 tc:0x377 tf:0x072 tm:5587573076.000 ns
[59] 80d30ba6 hit ch: 3 isrising:1 tc:0x3a6 tf:0x130 tm:5587573313.021 ns
[60] 80d06bd3 hit ch: 3 isrising:1 tc:0x3d3 tf:0x106 tm:5587573537.574 ns
[61] 80d3bcbc hit ch: 3 isrising:1 tc:0x4bc tf:0x13b tm:5587574703.138 ns
[62] 6f68537d epoch 258495357 tm 5587568640.000 ns
[63] 810ba840 hit ch: 4 isrising:1 tc:0x040 tf:0x0ba tm:5587568961.766 ns
[64] 8113c845 hit ch: 4 isrising:1 tc:0x045 tf:0x13c tm:5587568988.149 ns
[65] 811288d1 hit ch: 4 isrising:1 tc:0x0d1 tf:0x128 tm:5587569687.936 ns
[66] 810498fb hit ch: 4 isrising:1 tc:0x0fb tf:0x049 tm:5587569895.564 ns
[67] 8113da23 hit ch: 4 isrising:1 tc:0x223 tf:0x13d tm:5587571378.160 ns
[68] 81066a81 hit ch: 4 isrising:1 tc:0x281 tf:0x066 tm:5587571845.872 ns
[69] 8119fae3 hit ch: 4 isrising:1 tc:0x2e3 tf:0x19f tm:5587572339.202 ns
[70] 81084b42 hit ch: 4 isrising:1 tc:0x342 tf:0x084 tm:5587572811.191 ns
[71] 81095b77 hit ch: 4 isrising:1 tc:0x377 tf:0x095 tm:5587573076.372 ns
[72] 8115fba6 hit ch: 4 isrising:1 tc:0x3a6 tf:0x15f tm:5587573313.521 ns
[73] 8112abd3 hit ch: 4 isrising:1 tc:0x3d3 tf:0x12a tm:5587573537.957 ns
[74] 8116fcbc hit ch: 4 isrising:1 tc:0x4bc tf:0x16f tm:5587574703.691 ns
*** Subsubevent size 15 id 0x8000 full 000f8000
[76] 1006f0f4 [77] a14df70f [78] 00000032 [79] 9cbfd319 [80] 00000000 [81] 00000000 [82] 00000000 [83] 00000000
[84] 00000000 [85] a14df70f [86] 00000032 [87] 9cbfd319 [88] 00000000 [89] e0ffffff [90] 21660000
*** Subsubevent size 1 id 0x5555 full 00015555
[92] 00000001
~~~~~~~~~~~~~~~~
All options can be obtain when running "hldprint -help"
Usage of hadaq API from DABC
============================
hldprint is just program with about 200 lines of code.
Source code can be found in [repository](https://subversion.gsi.de/dabc/trunk/plugins/hadaq/hldprint.cxx)
There is also [example](https://subversion.gsi.de/dabc/trunk/applications/hadaq/), which
can be copied and modified for the user needs.
In simplified form access to any data source (local file, remote file or online server) looks like:
~~~~~~~~~~~~~~~~
#include "hadaq/api.h"
int main() {
hadaq::ReadoutHandle ref = hadaq::ReadoutHandle::Connect("file.hld");
hadaq::RawEvent* evnt = 0;
while(evnt = ref.NextEvent(1.)) {
// any user code here
evnt->Dump();
}
}
~~~~~~~~~~~~~~~~
One can use such interface in any other standalone applications.
Any comments and wishes: S.Linev(at)gsi.de
*/