3 #ifndef ALIHLTTPCESDWRITERCOMPONENT_H
4 #define ALIHLTTPCESDWRITERCOMPONENT_H
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 *
9 /** @file AliHLTTPCEsdWriterComponent.h
10 @author Matthias Richter
12 @brief Writer component to store tracks of the HLT TPC conformal
13 mapping tracker in the AliESD format
16 #include "AliHLTRootFileWriterComponent.h"
17 #include "AliHLTProcessor.h"
19 // forward declarations
22 class AliHLTTPCTrackArray;
25 * @class AliHLTTPCEsdWriterComponent
26 * Translation of internal TPC track data to the ESD format.
27 * This class translates incoming track segments structures from the TPC
28 * conformal mapping tracker (datatype TRAKSEGS/TPC) or tracks in global
29 * coordinates from the AliHLTTPCGlobalMergerComponent (TRACKS/TPC) into
32 * The \em TPCEsdWriter writes it to a ROOT file, the \em TPCEsdConverter
33 * to a TTree and sends the whole object to the output stream with data
34 * type ::kAliHLTDataTypeESDTree and origin TPC.
36 * In case of TRAKSEGS, the component can only process data block containing
37 * data of one slice, but it can read an unlimeted number of data blocks.
39 * componentid: \b TPCEsdWriter <br>
40 * componentid: \b TPCEsdConverter <br>
41 * componentlibrary: \b libAliHLTTPC.so <br>
42 * Arguments TPCEsdWriter: <br>
43 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
44 * \li -datafile <i> filename </i> <br>
46 * \li -directory <i> directory </i> <br>
49 * Arguments TPCEsdConverter: <br>
50 * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
52 * write ESD directly to output (::kAliHLTDataTypeESDObject)
53 * this has been made the default behavior in Sep 2008.
55 * write ESD directly to TTree and to output (::kAliHLTDataTypeESDTree)
56 * \li -solenoidBz <br>
57 * magnetic field like -solenoidBz 5.0
60 * Example usage (HLT configuration file):
61 * \<Proc ID="EsdWriter" type="prc">
62 * \<Cmd>AliRootWrapperSubscriber -eventmodulo 1
63 * -componentid TPCEsdWriter
64 * -componentlibrary libAliHLTTPC.so
65 * -componentargs "-datafile AliESDs.root"
68 * \<Parent>TR0-SC\</Parent>
69 * \<Node>master\</Node>
70 * \<Shm blocksize="1k" blockcount="1" type="sysv"/>
74 * @see AliHLTFileWriter and AliHLTRootFileWriterComponent for more parameters
76 * @ingroup alihlt_tpc_components
78 class AliHLTTPCEsdWriterComponent : public AliHLTLogging
81 /** standard constructor */
82 AliHLTTPCEsdWriterComponent();
84 ~AliHLTTPCEsdWriterComponent();
87 * class AliHLTTPCEsdWriterComponent::AliWriter
88 * The writer component of the AliHLTTPCEsdWriterComponent.
90 class AliWriter : public AliHLTRootFileWriterComponent
93 /** standard constructor */
99 * The id of the component.
100 * @return component id (string)
102 const char* GetComponentID() {return "TPCEsdWriter";};
104 void GetInputDataTypes(AliHLTComponentDataTypeList& list);
108 * @return new class instance
110 AliHLTComponent* Spawn() {return new AliHLTTPCEsdWriterComponent::AliWriter;}
114 * Data processing method for the component.
115 * The function can be overloaded by specific ROOT file writer
117 * @param evtData event data structure
118 * @param blocks input data block descriptors
119 * @param trigData trigger data structure
121 int DumpEvent( const AliHLTComponentEventData& evtData,
122 const AliHLTComponentBlockData* blocks,
123 AliHLTComponentTriggerData& trigData );
125 using AliHLTRootFileWriterComponent::DumpEvent;
128 * Scan one argument and adjacent parameters.
129 * @param argc size of the argument array
130 * @param argv agument array for component initialization
131 * @return number of processed members of the argv <br>
132 * -EINVAL unknown argument <br>
133 * -EPROTO parameter for argument missing <br>
135 int ScanArgument(int argc, const char** argv);
137 /** copy constructor prohibited */
138 AliWriter(const AliWriter&);
139 /** assignment operator prohibited */
140 AliWriter& operator=(const AliWriter&);
144 * The DoInit function is not available for this child class. InitWriter is the
145 * corresponding function for classes derived from AliHLTFileWriter.
151 * The DoDeinit function is not available for this child class. CloseWriter is the
152 * corresponding function for classes derived from AliHLTFileWriter.
157 TTree* fTree; //! transient value
160 AliESDEvent* fESD; //! transient value
162 /** pointer to the basic ESD conversion methods */
163 AliHLTTPCEsdWriterComponent* fBase; //! transient value
167 * class AliHLTTPCEsdWriterComponent::AliConverter
168 * The converter component of the AliHLTTPCEsdWriterComponent.
171 class AliConverter : public AliHLTProcessor
174 /** standard constructor */
177 virtual ~AliConverter();
179 // interface methods of base class
180 const char* GetComponentID() {return "TPCEsdConverter";};
181 void GetInputDataTypes(AliHLTComponentDataTypeList& list);
182 AliHLTComponentDataType GetOutputDataType();
183 void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
184 AliHLTComponent* Spawn() {return new AliHLTTPCEsdWriterComponent::AliConverter;}
187 // interface methods of base class
188 int DoInit(int argc, const char** argv);
190 int DoEvent(const AliHLTComponentEventData& evtData,
191 const AliHLTComponentBlockData* blocks,
192 AliHLTComponentTriggerData& trigData,
193 AliHLTUInt8_t* outputPtr,
194 AliHLTUInt32_t& size,
195 AliHLTComponentBlockDataList& outputBlocks );
197 using AliHLTProcessor::DoEvent;
200 /** copy constructor prohibited */
201 AliConverter(const AliConverter&);
202 /** assignment operator prohibited */
203 AliConverter& operator=(const AliConverter&);
206 AliESDEvent* fESD; //! transient value
208 /** pointer to the basic ESD conversion methods */
209 AliHLTTPCEsdWriterComponent* fBase; //! transient value
211 /** write object to TTree or directly */
212 int fWriteTree; //!transient
217 * Process the input data blocks.
218 * @param pTree tree to be filled
219 * @param pESD ESD to be filled
220 * @param blocks data block descriptor array
221 * @param nBlocks size of the array
222 * @param pMinSlice [OUT] receives the minimum slice no
223 * @param pMaxSlice [OUT] receives the maximum slice no
224 * @return neg. error code if failed
226 int ProcessBlocks(TTree* pTree, AliESDEvent* pESD, const AliHLTComponentBlockData* blocks,
227 int nBlocks, int* pMinSlice=NULL, int* pMaxSlice=NULL);
230 * Covert tracks to AliTPCtracks (AliKalmanTracks) and add them to ESD.
231 * @param pTracks array of tracks
232 * @param pESD pointer to ESD
233 * @return neg. error code if failed
235 int Tracks2ESD(AliHLTTPCTrackArray* pTracks, AliESDEvent* pESD );
238 /** copy constructor prohibited */
239 AliHLTTPCEsdWriterComponent(const AliHLTTPCEsdWriterComponent&);
240 /** assignment operator prohibited */
241 AliHLTTPCEsdWriterComponent& operator=(const AliHLTTPCEsdWriterComponent&);
244 * (Re)Configure from the CDB
245 * Loads the following objects:
246 * - HLT/ConfigHLT/SolenoidBz
248 int Reconfigure(const char* cdbEntry, const char* chainId);
251 * Configure the component.
252 * Parse a string for the configuration arguments and set the component
255 int Configure(const char* arguments);
257 /** solenoid b field */
258 Double_t fSolenoidBz; //! transient
260 ClassDef(AliHLTTPCEsdWriterComponent, 0)