Adding setting of default CDB storage (if not defined)
[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>
44 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formating -->
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:
55 AliHLTReconstructor();
56 /** destructor */
57 virtual ~AliHLTReconstructor();
58
59 /** init the reconstructor */
60 void Init();
61
62 /**
63 * This Reconstructor function is not applicable for the AliHLTReconstructor
64 * as it gets a detector specific digits tree. But HLT processes all detectors.
7f9ab840 65 * Furthermore it's purely simulated data. <br>
66 * The function forwards to the default bahavior of AliReconstructor but gives
67 * a warning if there were options set, i.e. the user runs customized
68 * reconstruction.
c5123824 69 *
70 * @note HLT reconstruction on simulated data is processed at the end of
71 * simulation. <br>
3e820254 72 */
7f9ab840 73 void Reconstruct(TTree* digitsTree, TTree* clustersTree) const;
3e820254 74
75 /**
76 * Reconstruction from RAW data.
77 * The rawReader holds data for all detectors and this version of Reconstruct
78 * is thus applicable for the HLT. The clustersTree is just ignored.
79 */
80 void Reconstruct(AliRawReader* rawReader, TTree* clustersTree) const;
81
82 /**
c5123824 83 * This function treats the simulated HLTOUT data.
84 * Opens a handler for simulated HLTOUT data and forwards to ::ProcessHLTOUT.
3e820254 85 */
7f9ab840 86 void FillESD(TTree* digitsTree, TTree* clustersTree, AliESDEvent* esd) const;
3e820254 87
88 /**
c5123824 89 * Process the raw HLTOUT data and fill ESD.
90 * Opens a handler for raw HLTOUT data and forwards to ::ProcessHLTOUT.
3e820254 91 */
92 void FillESD(AliRawReader* rawReader, TTree* clustersTree, AliESDEvent* esd) const;
93
c5123824 94 /**
95 * Process HLTOUT data and fill ESD.
96 * This is the final treatment of the HLTOUT data, either simulated or real.
97 * HLTOUT data is stored in HOMER format, the AliHLTOUT object provides the interface
98 * to the individual data blocks.
99 *
100 * During reconstruction (::Reconstruct), module or user defined chains can be
101 * processed and may add additional data to the HLTOUT object. This data is then
102 * treated in the same way.
103 */
104 void ProcessHLTOUT(AliHLTOUT* pHLTOUT, AliESDEvent* esd) const;
105
3e820254 106private:
107 /** copy constructor prohibited */
108 AliHLTReconstructor(const AliHLTReconstructor& src);
109 /** assignment operator prohibited */
110 AliHLTReconstructor& operator=(const AliHLTReconstructor& src);
111
c5123824 112 /** function pointer: processing of HLTOUT data */
113 void* fFctProcessHLTOUT; //!transient
114
115 /** ESD manger instance for this reconstruction */
116 AliHLTEsdManager* fpEsdManager; //!transient
117
118 ClassDef(AliHLTReconstructor, 5) // class for the HLT reconstruction
119
3e820254 120};
121
122typedef AliHLTReconstructor AliL3Reconstructor; // for backward compatibility
123
124#endif