HLT/MUON/OfflineInterface/AliHLTMUONESDMaker.h

   1 #ifndef ALIHLTMUONESDMAKER_H
   2 #define ALIHLTMUONESDMAKER_H
   3 /* This file is property of and copyright by the ALICE HLT Project        *
   4  * ALICE Experiment at CERN, All rights reserved.                         *
   5  * See cxx source for full Copyright notice                               */
   6
   7 // $Id: $
   8
   9 ///
  10 /// @file   AliHLTMUONESDMaker.h
  11 /// @author Artur Szostak <artursz@iafrica.com>
  12 /// @date   30 June 2008
  13 /// @brief  Component for converting dHLT raw data into AliESDEvent objects.
  14 ///
  15
  16 #include "AliHLTMUONProcessor.h"
  17
  18 /**
  19  * @class AliHLTMUONESDMaker
  20  * \brief Component for converting dHLT results into ESD format.
  21  *
  22  * The component is used to convert dHLT reconstructed data into AliESDEvent
  23  * objects which can be stored in ROOT files during offline reconstruction.
  24  * Only the dHLT track and trigger record data is converted, then filled in the ESD.
  25  * These should then be merged together with ESDs from all the other parts of
  26  * HLT (eg. TPC HLT).<br>
  27  * This component can also be run online to have ESDs directly in the raw
  28  * HLT output data stream.<br>
  29  *
  30  * Component ID: \b MUONESDMaker <br>
  31  * Library: \b libAliHLTMUON.so  <br>
  32  *
  33  * Optional arguments:<br>
  34  * \li -make_minimal_esd <br>
  35  *       Indicates that AliESDEvent objects should be created with only the TClonesArray
  36  *       for the muon tracks created. (default is to generate all standard ESD objects)<br>
  37  * \li -add_rootified_objects <br>
  38  *       If specified then the any rootified dHLT event data that is found is added to the
  39  *       ESD list of objects as a custom data object.<br>
  40  * \li -makeclonesarray <br>
  41  *      This option will cause the component to generate a TClonesArray of MUON ESD tracks
  42  *      and send it as a kAliHLTDataTypeTObject data block type. <br>
  43  * \li -makeonlyclonesarray <br>
  44  *      Same as the -makeclonesarray option, however the data block with the AliESDEvent
  45  *      object is not generated at all. <br>
  46  * \li -warn_on_unexpected_block <br>
  47  *       If set, then warning messages are generated for any data block types that
  48  *       were not expected. (default is to generate only debug messages)<br>
  49  * \li -dumponerror <br>
  50  *      This flag will cause the component to dump the data blocks it received if
  51  *      an error occurs during the processing of an event. <br>
  52  * \li -dumppath <i>path</i> <br>
  53  *      Allows one to specify the path in which to dump the received data blocks
  54  *      if an error occurs. <br>
  55  *
  56  * @ingroup alihlt_dimuon_component
  57  */
  58 class AliHLTMUONESDMaker : public AliHLTMUONProcessor
  59 {
  60 public:
  61
  62         AliHLTMUONESDMaker();
  63         virtual ~AliHLTMUONESDMaker();
  64
  65         virtual const char* GetComponentID();
  66
  67         virtual void GetInputDataTypes(AliHLTComponentDataTypeList& list);
  68         virtual AliHLTComponentDataType GetOutputDataType();
  69         virtual int GetOutputDataTypes(AliHLTComponentDataTypeList& list);
  70         virtual void GetOutputDataSize(unsigned long& constBase, double& inputMultiplier);
  71
  72         virtual AliHLTComponent* Spawn();
  73
  74 protected:
  75
  76         virtual int DoInit(int argc, const char** argv);
  77         virtual int DoDeinit();
  78         virtual int DoEvent(const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData);
  79         virtual bool IgnoreArgument(const char* arg) const;
  80         using AliHLTProcessor::DoEvent;
  81
  82 private:
  83
  84         // Prevent copying of these objects.
  85         AliHLTMUONESDMaker(const AliHLTMUONESDMaker& /*object*/);
  86         AliHLTMUONESDMaker& operator = (const AliHLTMUONESDMaker& /*object*/);
  87
  88         bool fWarnForUnexpecedBlock;  /// Flag indicating if we should log a warning if we got a block of an unexpected type.
  89         bool fMakeMinimalESD;  /// Flag to indicate if a minimal ESD object should be created.
  90         bool fAddCustomData;  /// Flag to turn on adding of all dHLT rootified objects to the ESD.
  91         bool fMakeClonesArray;  /// Flag indicating if a data block of TClonesArray with AliESDMuonTrack objects should be generated.
  92         bool fMakeESDDataBlock;  /// Flag indicating if the ESD data block should generated.
  93
  94         ClassDef(AliHLTMUONESDMaker, 0); // Component for converting dHLT reconstructed data into the ESD format.
  95 };
  96
  97 #endif // ALIHLTMUONESDMAKER_H