HLT/TPCLib/offline/AliHLTTPCOfflineTrackerComponent.h

   1 //-*- Mode: C++ -*-
   2 // $Id$
   3 #ifndef ALIHLTTPCOFFLINETRACKERCOMPONENT_H
   4 #define ALIHLTTPCOFFLINETRACKERCOMPONENT_H
   5
   6 //* This file is property of and copyright by the ALICE HLT Project        *
   7 //* ALICE Experiment at CERN, All rights reserved.                         *
   8 //* See cxx source for full Copyright notice                               *
   9
  10 /** @file   AliHLTTPCOfflineTrackerComponent.h
  11     @author Matthias Richter
  12     @date
  13     @brief  Wrapper component to the TPC offline cluster finder
  14 */
  15
  16 #include "AliHLTProcessor.h"
  17
  18 /**
  19  * @class AliHLTTPCOfflineTrackerComponent
  20  * Wrapper component to the TPC offline tracker.
  21  *
  22  * The component interfaces the AliTPCtrackerMI of the TPC offline code
  23  * to the online HLT. The component expects a full TreeR containing the
  24  * cluster information. The output is in ESD format.
  25  *
  26  * <h2>General properties:</h2>
  27  *
  28  * Component ID: \b TPCOfflineTracker <br>
  29  * Library: \b libAliHLTTPC.so     <br>
  30  * Input Data Types: @ref kAliHLTDataTypeAliTreeR|kAliHLTDataOriginTPC <br>
  31  * Output Data Types: @ref kAliHLTDataTypeESDTree|kAliHLTDataOriginTPC <br>
  32  *
  33  * <h2>Mandatory arguments:</h2>
  34  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  35  *
  36  * <h2>Optional arguments:</h2>
  37  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  38  *
  39  * <h2>Configuration:</h2>
  40  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  41  *
  42  * <h2>Default CDB entries:</h2>
  43  * - loads magnetic field value from <tt>HLT/ConfigHLT/SolenoidBz</tt>.
  44  *
  45  * <h2>Performance:</h2>
  46  * To be determined.
  47  *
  48  * <h2>Memory consumption:</h2>
  49  * To be determined.
  50  *
  51  * <h2>Output size:</h2>
  52  * To be determined.
  53  *
  54  * @ingroup alihlt_tpc_components
  55  */
  56
  57 class AliTPCParam;
  58 class AliTPCtrackerMI;
  59 class AliESDEvent;
  60
  61 class AliHLTTPCOfflineTrackerComponent : public AliHLTProcessor {
  62 public:
  63   AliHLTTPCOfflineTrackerComponent();
  64   virtual ~AliHLTTPCOfflineTrackerComponent();
  65
  66   // AliHLTComponent interface functions
  67   const char* GetComponentID();
  68   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
  69   AliHLTComponentDataType GetOutputDataType();
  70   void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
  71
  72   // Spawn function, return new class instance
  73   AliHLTComponent* Spawn();
  74
  75  protected:
  76   // AliHLTComponent interface functions
  77   int DoInit( int argc, const char** argv );
  78   int DoDeinit();
  79   int DoEvent( const AliHLTComponentEventData& evtData, AliHLTComponentTriggerData& trigData);
  80   int Reconfigure(const char* cdbEntry, const char* chainId);
  81
  82   using AliHLTProcessor::DoEvent;
  83
  84 private:
  85   /** copy constructor prohibited */
  86   AliHLTTPCOfflineTrackerComponent(const AliHLTTPCOfflineTrackerComponent&);
  87   /** assignment operator prohibited */
  88   AliHLTTPCOfflineTrackerComponent& operator=(const AliHLTTPCOfflineTrackerComponent&);
  89
  90   Double_t fOutputPercentage; // percentage of output data
  91   AliTPCParam *fTPCGeomParam; // TPC geometry params
  92   AliTPCtrackerMI *fTracker;  // TPC tracker
  93   AliESDEvent *fESD;          // AliESDEvent needed by TPC tracker
  94
  95   /**
  96    * Configure the component.
  97    * Parse a string for the configuration arguments and set the component
  98    * properties.
  99    */
 100   int Configure(const char* arguments);
 101
 102   ClassDef(AliHLTTPCOfflineTrackerComponent, 0)
 103 };
 104 #endif