Difference between revisions of "DAQTree plugin"

From GlueXWiki
Jump to: navigation, search
(Notes)
 
(9 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
Once everything is set up (as on the gluon cluster), it can be run using the following command:
 
Once everything is set up (as on the gluon cluster), it can be run using the following command:
  
hd_root -PPLUGINS=DAQ,DAQTree -PHDDM:ENABLE=0 codafile.evt -o outputfile.root
+
  hd_root -PPLUGINS=DAQ,DAQTree codafile.coda -o outputfile.root
  
The -PHDDM:ENABLE=0 switch is required to stop the analyzer from wasting time trying to interpret the file as a HDDM file.  Later developments to the HDDM parser may make this unnecessary.
+
The -PPLUGINS=DAQ is required to generate the low level DAQ object which are then saved to the tree.
  
===Types===
+
====Limiting the subsystems====
 +
 
 +
Running with the TTab plugin can add some additional functionality.  In particular, it allows you to specify which detector system(s) you wish the DAQ plugin to spend time parsing. It does this based
 +
on rocid and the rocids are determined by looking them up in the Translation Table based on the detector system name. The value of the variable should be a comma separated list of detector
 +
systems. For example:
 +
 
 +
  hd_root -PPLUGINS=DAQ,TTab,DAQTree  -TT:SYSTEMS_TO_PARSE=BCAL,FCAL  codafile.coda -o outputfile.root
 +
 
 +
This can save a lot of time for folks interested in data from only one detector system. It also means you can make smaller ROOT files with the DAQTree plugin. Valid values that could go into the comma separated list of systems are: BCAL, CDC, FCAL, FDC, FDC_CATHODES, FDC_WIRES, TOF, TAGM, TAGH, PS, PSC, and ST.  Note that “FDC” is just and alias for “FDC_CATHODES,FDC_WIRES” and “PS” will also
 +
automatically turn on parsing of “PSC” as well.  Not specifying the parameter will cause everything to be parsed, just as before.
 +
 
 +
The -PHDDM:ENABLE=0 switch can be used to force the analyzer not to try to interpret the file as a HDDM file.  Later developments to the HDDM parser have made this unnecessary.
 +
 
 +
===Data Types===
  
  
 
The currently supported object types are:
 
The currently supported object types are:
    Df250WindowRawData
+
 +
  Df125WindowRawData
 +
  Df125PulseRawData
 +
  Df125PulseIntegral
 +
  Df125PulseTime
 +
  Df125PulsePedestal
 +
  Df125TriggerTime
 +
  DF1TDCHit
 +
  DF1TDCTriggerTime
 +
  Df250WindowRawData  
 +
  Df250PulseRawData
 +
  Df250PulseIntegral
 +
  Df250PulseTime
 +
  Df250PulsePedestal
 +
  Df250TriggerTime
 +
 
 +
The data types that might be added in future:
 +
 
 +
  Df250StreamingRawData
 +
  Df250WindowSum
 +
 
 +
 
 +
===Installation===
  
The object types that will be supported is:
+
DAQTree is located in the repository at:
  
    Df125PulseIntegral
+
  src/programs/Analysis/plugins/DAQTree/
    Df125PulseTime
+
    Df125TriggerTime
+
    DF1TDCHit
+
    DF1TDCTriggerTime
+
    Df250PulseIntegral
+
    Df250PulseRawData
+
    Df250PulseTime
+
    Df250StreamingRawData
+
    Df250TriggerTime
+
    Df250WindowRawData
+
    Df250WindowSum
+
  
===Notes===
+
DAQTree is set up to be compiled and install by default along with all the other sim-recon tools.
  
DAQTree is currently not compiled or installed by default because it depends on the DAQ plugin.  The DAQ plugin is not currently compiled by default since it depends on evio, which is not typically necessary for standard simulation reconstruction.  This may change.  First compile and install sim-recon, the the DAQ plugin and then the DAQTree plugin.
+
===Documantation===
  
See the [http://www.jlab.org/Hall-D/software/HDSoftware_Documentation/class_j_event_processor___d_a_q_tree.html | Doxygen entry for this plugin] for a look into the internal structure.
+
See the [http://www.jlab.org/Hall-D/software/HDSoftware_Documentation/class_j_event_processor___d_a_q_tree.html Doxygen entry for this plugin] for a look into the internal structure.

Latest revision as of 14:59, 18 December 2014

DAQTree is a standard JANA plugin that can be used to output information about standard DAQ objects to root trees.

Usage

Once everything is set up (as on the gluon cluster), it can be run using the following command:

 hd_root -PPLUGINS=DAQ,DAQTree codafile.coda -o outputfile.root

The -PPLUGINS=DAQ is required to generate the low level DAQ object which are then saved to the tree.

Limiting the subsystems

Running with the TTab plugin can add some additional functionality. In particular, it allows you to specify which detector system(s) you wish the DAQ plugin to spend time parsing. It does this based on rocid and the rocids are determined by looking them up in the Translation Table based on the detector system name. The value of the variable should be a comma separated list of detector systems. For example:

 hd_root -PPLUGINS=DAQ,TTab,DAQTree  -TT:SYSTEMS_TO_PARSE=BCAL,FCAL  codafile.coda -o outputfile.root

This can save a lot of time for folks interested in data from only one detector system. It also means you can make smaller ROOT files with the DAQTree plugin. Valid values that could go into the comma separated list of systems are: BCAL, CDC, FCAL, FDC, FDC_CATHODES, FDC_WIRES, TOF, TAGM, TAGH, PS, PSC, and ST. Note that “FDC” is just and alias for “FDC_CATHODES,FDC_WIRES” and “PS” will also automatically turn on parsing of “PSC” as well. Not specifying the parameter will cause everything to be parsed, just as before.

The -PHDDM:ENABLE=0 switch can be used to force the analyzer not to try to interpret the file as a HDDM file. Later developments to the HDDM parser have made this unnecessary.

Data Types

The currently supported object types are:

  Df125WindowRawData 
  Df125PulseRawData 
  Df125PulseIntegral 
  Df125PulseTime 
  Df125PulsePedestal 
  Df125TriggerTime 
  DF1TDCHit 
  DF1TDCTriggerTime 
  Df250WindowRawData 
  Df250PulseRawData 
  Df250PulseIntegral 
  Df250PulseTime 
  Df250PulsePedestal 
  Df250TriggerTime 

The data types that might be added in future:

  Df250StreamingRawData
  Df250WindowSum


Installation

DAQTree is located in the repository at:

  src/programs/Analysis/plugins/DAQTree/

DAQTree is set up to be compiled and install by default along with all the other sim-recon tools.

Documantation

See the Doxygen entry for this plugin for a look into the internal structure.