Signal propagation delay value: changed according to a measurement result (5.13 ns...
[u/mrichter/AliRoot.git] / HLT / rec / AliHLTReconstructor.h
CommitLineData
3e820254 1// @(#) $Id$
2
3#ifndef ALIHLTRECONSTRUCTOR_H
4#define ALIHLTRECONSTRUCTOR_H
c5123824 5//* This file is property of and copyright by the ALICE HLT Project *
6//* ALICE Experiment at CERN, All rights reserved. *
7//* See cxx source for full Copyright notice *
3e820254 8
3a7c0444 9/** @file AliHLTReconstructor.h
c534985b 10 @author Matthias Richter
11 @date
12 @brief Binding class for HLT simulation in AliRoot
c5123824 13*/
c534985b 14
3e820254 15#include "AliReconstructor.h"
a3ef3c1d 16#include "AliHLTReconstructorBase.h"
3e820254 17
18class AliHLTSystem;
19class AliRawReader;
20class AliESDEvent;
c5123824 21class AliHLTOUT;
22class AliHLTEsdManager;
3e820254 23
24/**
25 * @class AliHLTReconstructor
26 * AliHLTReconstructor AliRoot event reconstruction plugin for the HLT.
27 * The AliHLTReconstructor holds an instance of the @ref AliHLTSystem
28 * steering class. The actual reconstruction depends on the loaded component
29 * libraries. Each library must implement a module agent (@ref AliHLTModuleAgent)
30 * in order to provide information on the supported features and the
31 * configurations to be run.
32 *
33 * The default component libraries which are loaded through the initialization
60dd5042 34 * are determined by the @ref AliHLTSystem::fgkHLTDefaultLibs array. The library
35 * loading can be overridden by an option to the AliHLTReconstructor through the
3e820254 36 * <tt>SetOption</tt> method of <tt>AliReconstruction</tt>, e.g.
37 * <pre>
38 * AliReconstruction rec;
39 * rec.SetOption("HLT", "libAliHLTSample.so");
40 * </pre>
41 * will only load <tt>libAliHLTSample.so</tt>
42 *
43 * Optional arguments:<br>
1ac82ce6 44 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
3e820254 45 * \li loglevel=<i>level</i><br>
46 * level can be a hex number encoding the @ref AliHLTComponentLogSeverity
47 * \li alilog=off <br>
48 * disables the logging of HLT log messages through <tt>AliLog</tt> <br>
49 *
50 * For further information on the AliRoot reconstruction refer to the AliRoot
51 * documentation, namely <tt>AliReconstruction</tt>.
52 */
a3ef3c1d 53class AliHLTReconstructor: public AliReconstructor, public AliHLTReconstructorBase {
3e820254 54public:
032c5e5e 55 /** standard constructor */
3e820254 56 AliHLTReconstructor();
032c5e5e 57 /** constructor */
58 AliHLTReconstructor(const char* options);
3e820254 59 /** destructor */
60 virtual ~AliHLTReconstructor();
61
62 /** init the reconstructor */
63 void Init();
64
032c5e5e 65 /** init the reconstructor */
66 void Init(const char* options);
67
3e820254 68 /**
69 * This Reconstructor function is not applicable for the AliHLTReconstructor
70 * as it gets a detector specific digits tree. But HLT processes all detectors.
7f9ab840 71 * Furthermore it's purely simulated data. <br>
72 * The function forwards to the default bahavior of AliReconstructor but gives
73 * a warning if there were options set, i.e. the user runs customized
74 * reconstruction.
c5123824 75 *
76 * @note HLT reconstruction on simulated data is processed at the end of
77 * simulation. <br>
3e820254 78 */
7f9ab840 79 void Reconstruct(TTree* digitsTree, TTree* clustersTree) const;
3e820254 80
81 /**
82 * Reconstruction from RAW data.
83 * The rawReader holds data for all detectors and this version of Reconstruct
84 * is thus applicable for the HLT. The clustersTree is just ignored.
85 */
86 void Reconstruct(AliRawReader* rawReader, TTree* clustersTree) const;
87
88 /**
c5123824 89 * This function treats the simulated HLTOUT data.
90 * Opens a handler for simulated HLTOUT data and forwards to ::ProcessHLTOUT.
3e820254 91 */
7f9ab840 92 void FillESD(TTree* digitsTree, TTree* clustersTree, AliESDEvent* esd) const;
3e820254 93
94 /**
c5123824 95 * Process the raw HLTOUT data and fill ESD.
96 * Opens a handler for raw HLTOUT data and forwards to ::ProcessHLTOUT.
3e820254 97 */
98 void FillESD(AliRawReader* rawReader, TTree* clustersTree, AliESDEvent* esd) const;
99
c5123824 100 /**
101 * Process HLTOUT data and fill ESD.
102 * This is the final treatment of the HLTOUT data, either simulated or real.
103 * HLTOUT data is stored in HOMER format, the AliHLTOUT object provides the interface
104 * to the individual data blocks.
105 *
106 * During reconstruction (::Reconstruct), module or user defined chains can be
107 * processed and may add additional data to the HLTOUT object. This data is then
108 * treated in the same way.
109 */
110 void ProcessHLTOUT(AliHLTOUT* pHLTOUT, AliESDEvent* esd) const;
111
032c5e5e 112 /**
113 * Process HLTOUT data.
114 * Open digit file and process the HLTOUT digit data.
115 * This function is mostly intended for debugging purposes and stand-alone
116 * processing of the output from the simulation. Loops over all events.
117 * @param digitFile path of the digit file
118 * @param pEsd optional ESD to be filled
119 */
120 void ProcessHLTOUT(const char* digitFile="HLT.Digits.root", AliESDEvent* pEsd=NULL) const;
121
122 /**
123 * Process HLTOUT data.
124 * Process the HLTOUT from the raw reader.
125 * This function is mostly intended for debugging purposes and stand-alone
126 * processing of simulated or real raw data.
127 * \em Note: Loops over all events, i.e. the current event of the the raw
128 * reader will change. Not to be called inside the normal AliRoot processsing.
129 * @param pRawReader raw reader instance
130 * @param pEsd optional ESD to be filled
131 */
132 void ProcessHLTOUT(AliRawReader* pRawReader, AliESDEvent* pEsd=NULL) const;
133
134 /**
135 * Print a short info about the HLTOUT content.
136 */
137 void PrintHLTOUTContent(AliHLTOUT* pHLTOUT) const;
138
3e820254 139private:
140 /** copy constructor prohibited */
141 AliHLTReconstructor(const AliHLTReconstructor& src);
142 /** assignment operator prohibited */
143 AliHLTReconstructor& operator=(const AliHLTReconstructor& src);
144
c5123824 145 /** function pointer: processing of HLTOUT data */
146 void* fFctProcessHLTOUT; //!transient
147
148 /** ESD manger instance for this reconstruction */
149 AliHLTEsdManager* fpEsdManager; //!transient
150
151 ClassDef(AliHLTReconstructor, 5) // class for the HLT reconstruction
152
3e820254 153};
154
155typedef AliHLTReconstructor AliL3Reconstructor; // for backward compatibility
156
157#endif