]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - HLT/rec/AliHLTReconstructor.h
Patch for the tracker
[u/mrichter/AliRoot.git] / HLT / rec / AliHLTReconstructor.h
index 3a1d9e6abe9dc66e53e7a7bca3c541de2d3a5ff8..ad3ae4a18f0158c2175b22a14788baf6bb44bd05 100644 (file)
@@ -1,4 +1,5 @@
-// @(#) $Id$
+//-*- Mode: C++ -*-
+// $Id$
 
 #ifndef ALIHLTRECONSTRUCTOR_H
 #define ALIHLTRECONSTRUCTOR_H
@@ -6,11 +7,12 @@
 //* ALICE Experiment at CERN, All rights reserved.                         *
 //* See cxx source for full Copyright notice                               *
 
-/** @file   AliHLTReconstructor.h
-    @author Matthias Richter
-    @date   
-    @brief  Binding class for HLT simulation in AliRoot
-*/
+//  @file   AliHLTReconstructor.h
+//  @author Matthias Richter
+//  @date   
+//  @brief  Binding class for HLT reconstruction in AliRoot
+//          Implements bot the interface to run HLT chains embedded into
+//          AliReconstruction and the unpacking and treatment of HLTOUT
 
 #include "AliReconstructor.h"
 
@@ -83,6 +85,12 @@ class AliHLTPluginBase;
  *     level can be a hex number encoding the @ref AliHLTComponentLogSeverity
  * \li alilog=off <br>
  *     disables the logging of HLT log messages through <tt>AliLog</tt> <br>
+ * \li ignore-hltout <br>
+ *     ignore data from the HLTOUT data links
+ * \li ignore-ctp <br>
+ *     ignore CTP trigger setup
+ * \li esdmanager=<option> <br>
+ *     options passed to the AliHLTEsdManager
  *
  * For further information on the AliRoot reconstruction refer to the AliRoot
  * documentation, namely <tt>AliReconstruction</tt>.
@@ -123,18 +131,28 @@ class AliHLTPluginBase;
  *
  * @subsection sec_alihltreconstructor_hltout_esd ESD HLTOUT data
  * The framework implements a standard handling of ESD data
- * blocks of type ::kAliHLTDataTypeESDTree {ESD_TREE:ANY}. \em ANY can be
+ * blocks of type ::kAliHLTDataTypeESDObject {ALIESDV0:ANY} and 
+ * ::kAliHLTDataTypeESDTree {ESD_TREE:ANY}. Please note that the V0 refers to
+ * a foreseen version number, not the AliESDV0 class. \em ANY can be
  * any detector origin. Each ESD block contains the data of only one event,
- * the ESDs are merged by the AliHLTEsdManager and written to files of the
- * naming scheme AliHLT\em DET ESDs.root. The first ESD block is also copied
- * to the hltEsd provided by the AliReconstruction. This is a temporary
- * solution as the handling and merging of HLT ESDs is under discussion.
- * At the time of writing (May 08) only the TPC HLT components produce ESD
- * blocks.
+ * the ESDs are merged by the AliHLTEsdManager into the hltEsd. Optionally,
+ * ESD contributions are written to files following the naming scheme
+ * AliHLT\em DET ESDs.root. This debugging feature can be enabled by option
+ * esdmanager='-writelocal -directory=dir'. The specification of target
+ * directory is optional.
+ *
  * The module agent can provide a handler for multiple ESD data blocks, e.g.
  * for merging within one event prior to the writing. Instead of the individual
  * ESDs the one provided by the handler is passed to the AliHLTEsdManager. The
  * handler is of type \link AliHLTModuleAgent::AliHLTOUTHandlerType kEsd \endlink.
+ * 
+ * A specific handler AliHLTOUTHandlerEsdBranch allows to simply merge a
+ * streamed Root object into the ESD. The class can be used as-is by just
+ * specifying the data type and specification of the relevant data block and
+ * the branch name. Alternatively, a child class can implement conversion of
+ * binary data to a Root object or merging of several data blocks into one
+ * object to be added to the ESD. \b Note: in order to create the branch at
+ * the beginning of reconstruction the hltEsd layout needs to be adjusted.
  *
  * @subsection sec_alihltreconstructor_hltout_rawreader DDL raw HLTOUT data
  * The HLT can perform selective readout and produces a reduced amount of data
@@ -156,9 +174,12 @@ class AliHLTPluginBase;
  * first stage of the offline reconstruction might need some adaptions.
  *
  * @subsection sec_alihltreconstructor_hltout_chain HLTOUT data fed into a chain
- * At the time of writing (May 08), handler type 
- * \link AliHLTModuleAgent::AliHLTOUTHandlerType kChain \endlink
- * is foreseen but not yet implemented. Has to be discussed.
+ * Handlers of type \link AliHLTModuleAgent::AliHLTOUTHandlerType kChain \endlink
+ * can execute a normal HLT chain and thus process HLTOUT data blocks by normal
+ * HLT components just as if the components were running on-line. The base class
+ * is provided by AliHLTOUTHandlerChain and can be used as it is just specifying
+ * the chain to be run.<br>
+ * Example:
  *
  * @subsection sec_alihltreconstructor_hltout_proprietary Proprietary HLTOUT data
  * This is a handler of proprietary detector data. Handlers of type 
@@ -206,16 +227,9 @@ public:
   void Init(const char* options);
 
   /**
-   * Init streamer infos for the relevent classes to be extracted from HLT raw
-   * data payload. Reads the info from HLT/Calib/StreamerInfo
-   */
-  int InitStreamerInfos();
-
-  /**
-   * Init streamer infos for the relevant classes to be extracted from HLT raw
-   * data payload.
+   * Build the CTP_TRIGGER_CLASSES string from CTP trigger configuration
    */
-  int InitStreamerInfos(TObjArray* pSchemas) const;
+  int BuildCTPTriggerClassString(TString& triggerclasses) const;
 
   /**
    * This Reconstructor function is not applicable for the AliHLTReconstructor
@@ -291,6 +305,7 @@ public:
   enum {
     /// ignore the blocks from the HLTOUT payload
     kAliHLTReconstructorIgnoreHLTOUT = 0x1,
+    kAliHLTReconstructorIgnoreCTP = 0x2,
     kAliHLTReconstructorLastFlag
   };
 
@@ -300,9 +315,6 @@ private:
   /** assignment operator prohibited */
   AliHLTReconstructor& operator=(const AliHLTReconstructor& src);
 
-  /** function pointer: processing of HLTOUT data */
-  void (*fFctProcessHLTOUT)(); //!transient
-
   /** ESD manger instance for this reconstruction */
   AliHLTEsdManager* fpEsdManager; //!transient
 
@@ -313,7 +325,7 @@ private:
 
   static const char* fgkCalibStreamerInfoEntry; //! OCDB path
 
-  ClassDef(AliHLTReconstructor, 7)   // class for the HLT reconstruction
+  ClassDef(AliHLTReconstructor, 8)   // class for the HLT reconstruction
 
 };