HLT/TPCLib/AliHLTTPCClusterFinderComponent.h

   1 // @(#) $Id$
   2
   3 #ifndef ALIHLTTPCCLUSTERFINDERCOMPONENT_H
   4 #define ALIHLTTPCCLUSTERFINDERCOMPONENT_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   AliHLTTPCClusterFinderComponent.h
  11     @author Timm Steinbeck, Matthias Richter, Kenneth Aamodt
  12     @date
  13     @brief  The TPC cluster finder component.
  14 */
  15
  16 #include "AliHLTProcessor.h"
  17
  18 class AliHLTTPCClusterFinder;
  19 class AliHLTTPCDigitReader;
  20
  21 /**
  22  * @class AliHLTTPCClusterFinderComponent
  23  * Implementation of the cluster finder component.
  24  * The component implements the interface methods of the @ref AliHLTProcessor.
  25  * The actual cluster finding algorithm is implemented in @ref AliHLTTPCClusterFinder.
  26  * Two components are registered, TPCClusterFinderPacked and TPCClusterFinderDecoder.
  27  * TPCClusterFinderDecoder use the AliTPCRawStream class for decoding of the data, while TPCClusterFinderDecoder
  28  * use the AliAltroDecoder for decoding the data.
  29  *
  30  * TPCClusterFinderDecoder is the fastest of the two, this is due to that the AliAltroDecoder
  31  * returns data in a bunch format. A bunch consist of consecutive signals.
  32  * TPCClusterFinderPacked first have to read the data one by one, which means that row, pad and
  33  * time signals have to be compared between each new digit, which leads to a slower alorithm.
  34  *
  35  *
  36  * The clusterfinder is now using the AliTPCTransform instead of the AliHLTTPCTransform for
  37  * transformations from row, pad time -> x,y,z.
  38  *
  39  * <h2>General properties:</h2>
  40  *
  41  * Component ID: \b TPCClusterFinderDecoder and TPCClusterFinderPacked <br>
  42  * Library: \b libAliHLTTPC
  43  * Input Data Types: @ref kAliHLTDataTypeDDLRaw <br>
  44  * Output Data Types: @ref AliHLTTPCDefinitions::fgkClustersDataType and/or kAliHLTDataTypeHwAddr16 <br>
  45  *
  46  *
  47  * Mandatory arguments: <br>
  48  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  49  *
  50  * Optional arguments: <br>
  51  * <!-- NOTE: ignore the \li. <i> and </i>: it's just doxygen formatting -->
  52  * \li -deconvolute-time <br>
  53  *      Turns on deconvolution in the time direction.
  54  * \li -deconvolute-pad <br>
  55  *      Turns on deconvolution in the pad direction.
  56  * \li -timebins <br>
  57  *      Sets the number of timebins (446 for simulated data, and 1024 for real data) Default:1024
  58  * \li -first-timebin <br>
  59  *      First timebin taken into consideration when reading the data.
  60  * \li -last-timebin <br>
  61  *      Last timebin taken into consideration when reading the data.
  62  * \li -sorted <br>
  63  *      Switch off unsorted reading of data. Equivalent to the old argument unsorted 0.
  64  * \li -active-pads <br>
  65  *      Switch off unsorted reading of data. Equivalent to the old argument unsorted 0.
  66  * \li -occupancy-limit <br>
  67  *      Set the occupancy limit for the sorted clusterfinding.
  68  *
  69  *
  70  * Obsolete arguments: <br>
  71  * \li occupancy-limit <br>
  72  * \li rawreadermode   <br>
  73  * \li pp-run          <br>
  74  * \li adc-threshold   <br>
  75  * \li oldrcuformat    <br>
  76  * \li unsorted        <br>
  77  * \li nsigma-threshold <br>
  78  *
  79  * <h2>Default CDB entries:</h2>
  80  * The component has two default CDB entries
  81  * \li <tt>TPC/Calib/PadTime0</tt>.
  82  * \li <tt>TPC/Calib/Parameters</tt>.
  83  *
  84  * These entries are used by the AliTPCTransform class to correct for T0 and drift.
  85  * @ingroup alihlt_tpc_components
  86  */
  87 class AliHLTTPCClusterFinderComponent : public AliHLTProcessor
  88     {
  89     public:
  90       /**
  91        * Defines for the cluster finder type.
  92        * The cluster finders can work on different formats of input data,
  93        * the AliHLTTPCDigitReader interface provides a transparent way to
  94        * read the data.
  95        */
  96       enum {
  97         /** real data, offline AliAltroRawStream used for data decoding */
  98         kClusterFinderPacked,
  99         /** Unpacked data of format AliHLTTPCUnpackedRawData */
 100         kClusterFinderUnpacked,
 101         /** real data, fast AliAltroDecoder used for data decoding */
 102         kClusterFinderDecoder,
 103         /** real data, offline altro decoder 32 bit format*/
 104         kClusterFinder32Bit
 105       };
 106
 107         /**
 108          * constructor
 109          * @param mode    input type see e.g. @ref kClusterFinderUnpacked
 110          */
 111         AliHLTTPCClusterFinderComponent(int mode);
 112         /** destructor */
 113         virtual ~AliHLTTPCClusterFinderComponent();
 114
 115         // Public functions to implement AliHLTComponent's interface.
 116         // These functions are required for the registration process
 117
 118   /** interface function, see AliHLTComponent for description */
 119   const char* GetComponentID();
 120   /** interface function, see AliHLTComponent for description */
 121   void GetInputDataTypes( vector<AliHLTComponentDataType>& list);
 122   /** interface function, see AliHLTComponent for description */
 123   AliHLTComponentDataType GetOutputDataType();
 124   /** interface function, see AliHLTComponent for description */
 125   int GetOutputDataTypes(AliHLTComponentDataTypeList& tgtList);
 126   /** interface function, see AliHLTComponent for description */
 127   virtual void GetOutputDataSize( unsigned long& constBase, double& inputMultiplier );
 128   /** interface function, see AliHLTComponent for description */
 129   AliHLTComponent* Spawn();
 130
 131     protected:
 132
 133         // Protected functions to implement AliHLTComponent's interface.
 134         // These functions provide initialization as well as the actual processing
 135         // capabilities of the component.
 136
 137         int DoInit( int argc, const char** argv );
 138         int DoDeinit();
 139         int DoEvent( const AliHLTComponentEventData& evtData, const AliHLTComponentBlockData* blocks,
 140                      AliHLTComponentTriggerData& trigData, AliHLTUInt8_t* outputPtr,
 141                      AliHLTUInt32_t& size, vector<AliHLTComponentBlockData>& outputBlocks );
 142         int Configure(const char* arguments);
 143         int ScanConfigurationArgument(int argc, const char** argv);
 144         int Reconfigure(const char* cdbEntry, const char* chainId);
 145
 146         using AliHLTProcessor::DoEvent;
 147
 148     private:
 149         /** standard constructor prohibited */
 150         AliHLTTPCClusterFinderComponent();
 151         /** copy constructor prohibited */
 152         AliHLTTPCClusterFinderComponent(const AliHLTTPCClusterFinderComponent&);
 153         /** assignment operator prohibited */
 154         AliHLTTPCClusterFinderComponent& operator=(const AliHLTTPCClusterFinderComponent&);
 155         /** the cluster finder object */
 156         AliHLTTPCClusterFinder* fClusterFinder;                                      //!transient
 157         /** the reader object for data decoding */
 158         AliHLTTPCDigitReader* fReader;                                               //!transient
 159
 160         /** flag to deconvolute in time direction */
 161         Bool_t fDeconvTime;                                                          //!transient
 162
 163         /** flag to deconvolute in pad direction */
 164         Bool_t fDeconvPad;                                                           //!transient
 165         /** flag to switch on/off deconvolution in pad and time directions (used by sorted clusterfinding method) */
 166         bool fClusterDeconv;                                                         //!transient
 167         /** Error in xy of cluster */
 168         float fXYClusterError;                                                       //!transient
 169         /** Error in Z direction of cluster */
 170         float fZClusterError; //!transient
 171         /**
 172          * switch to indicated the reader
 173          * use fModeSwitch = 0 for packed inputtype "gkDDLPackedRawDataType"
 174          * use fModeSwitch = 1 for unpacked inputtype "gkUnpackedRawDataType"
 175          * use fModeSwitch = 2 for packed inputtype "gkDDLPackedRawDataType" with new digit reader
 176          * use fModeSwitch = 3 for packed inputtype "gkDDLPackedRawDataType" with 32bit digit reader
 177          */
 178         Int_t fModeSwitch;                                                            // see above
 179
 180         /*
 181          * Reads the data the new unsorted way if true
 182          *
 183          */
 184         Int_t fUnsorted;                                                               //!transient
 185
 186         /*
 187          * Patch number to be read, currently given as component argument,
 188          * will be changed later.
 189          */
 190         Int_t fPatch;                                                                  //!transient
 191
 192         /*
 193          * Switch to specify if one ship out a list of active pads (pads conected to a cluster).
 194          */
 195         Int_t fGetActivePads;                                                          //!transient
 196
 197         /** First timebin taken into account when reading the data */
 198         Int_t fFirstTimeBin;                                                           //!transient
 199
 200         /** Last timebin taken in to account when reading the data */
 201         Int_t fLastTimeBin;                                                            //!transient
 202
 203         Bool_t fDoMC;
 204
 205         /// the default configuration entry for this component
 206         static const char* fgkOCDBEntryPacked; //!transient
 207         static const char* fgkOCDBEntryUnpacked; //!transient
 208         static const char* fgkOCDBEntryDecoder; //!transient
 209         static const char* fgkOCDBEntry32Bit; //!transient
 210
 211         ClassDef(AliHLTTPCClusterFinderComponent, 7)
 212
 213 };
 214 #endif