TRD/AliTRDclusterizer.h

   1 #ifndef ALITRDCLUSTERIZER_H
   2 #define ALITRDCLUSTERIZER_H
   3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
   4  * See cxx source for full Copyright notice                               */
   5
   6 /* $Id$ */
   7
   8 ////////////////////////////////////////////////////////////////////////////
   9 //                                                                        //
  10 //  TRD cluster finder                                                    //
  11 //                                                                        //
  12 ////////////////////////////////////////////////////////////////////////////
  13
  14 #include <TNamed.h>
  15
  16 #include "AliTRDrawStream.h"
  17 #include "AliTRDgeometry.h"
  18
  19 class TFile;
  20 class TTree;
  21 class TClonesArray;
  22
  23 class AliRunLoader;
  24 class AliRawReader;
  25
  26 class AliTRD;
  27 class AliTRDcluster;
  28
  29 class AliTRDarrayADC;
  30 class AliTRDarraySignal;
  31 class AliTRDdigitsManager;
  32 class AliTRDSignalIndex;
  33 class AliTRDtransform;
  34 class AliTRDCalROC;
  35 class AliTRDReconstructor;
  36 class AliTRDCalSingleChamberStatus;
  37 class AliTRDrecoParam;
  38 class AliTRDCalOnlineGainTableROC;
  39
  40 class AliTRDclusterizer : public TNamed
  41 {
  42
  43  public:
  44
  45   // steering flags
  46   // bits from 0-13 are reserved by ROOT (see TObject.h)
  47   enum{
  48     kTrOwner = BIT(14)  //  toggle online tracklets ownership
  49     ,kClOwner= BIT(15)  //  toggle cluster ownership
  50     ,kLabels = BIT(16)  //  toggle MC labels for clusters
  51     ,kSkipTrafo = BIT(17)  //  skip the coordinate transformation of clusters?
  52     ,kLUT    = BIT(18)  //  using look up table for cluster's r-phi position
  53     ,kGAUS   = BIT(19)  //  using gauss approx. for cluster's r-phi position
  54     ,knewDM  = BIT(20)  //  was the digitsmanger created by raw2clusters?
  55     ,kTracksOwner = BIT(21) //  toggle GTU track ownership
  56   };
  57
  58   struct MaxStruct
  59   {
  60     Int_t       row;           // row of the current cluster candidate
  61     Int_t       col;           // col of the current cluster candidate
  62     Int_t       time;          // time -"-
  63     Short_t     signals[3];    // signals of the maximum pad and it's twon neigbours
  64     UChar_t     padStatus;     // padStatus of the current cluster candidate
  65     Bool_t      fivePad;       // is this cluster candidate part of a 5 pad cluster (two overlaping clusters)?
  66   MaxStruct():row(-1),col(0),time(0),padStatus(0),fivePad(kFALSE)
  67       {memset(signals, 0, 3*sizeof(Short_t));}
  68     MaxStruct &operator=(const MaxStruct &a)
  69     {memcpy(this, &a, sizeof(MaxStruct)); return *this;}
  70   };
  71
  72   AliTRDclusterizer(const AliTRDReconstructor *const rec = 0x0);
  73   AliTRDclusterizer(const Text_t* name, const Text_t* title, const AliTRDReconstructor *const rec = 0x0);
  74   AliTRDclusterizer(const AliTRDclusterizer &c);
  75   virtual         ~AliTRDclusterizer();
  76   AliTRDclusterizer &operator=(const AliTRDclusterizer &c);
  77
  78   void     Copy(TObject &c) const;
  79
  80   Bool_t   Open(const Char_t *name, Int_t nEvent = 0);
  81   Bool_t   OpenInput(Int_t nEvent = 0);
  82   Bool_t   OpenOutput();
  83   Bool_t   OpenOutput(TTree *const clusterTree);
  84
  85   Bool_t   ReadDigits();
  86   Bool_t   ReadDigits(AliRawReader *rawReader);
  87   Bool_t   ReadDigits(TTree *digitsTree);
  88
  89   Bool_t   ReadTracklets();
  90   Bool_t   ReadTracks();
  91
  92   Bool_t   WriteClusters(Int_t det);
  93   void     ResetRecPoints();
  94   virtual TClonesArray    *RecPoints();
  95   virtual TClonesArray    *TrackletsArray(const TString &trkltype = "");
  96   virtual TClonesArray    *TracksArray();
  97
  98   Bool_t   Raw2Clusters(AliRawReader *rawReader);
  99   Bool_t   Raw2ClustersChamber(AliRawReader *rawReader);
 100
 101   Bool_t   MakeClusters();
 102   Bool_t   MakeClusters(Int_t det);
 103
 104   Bool_t   AddLabels();
 105   Bool_t   SetUseLabels(const Bool_t kset) { SetBit(kLabels, kset); return TestBit(kLabels);  } // should we assign labels to clusters
 106   void     SetRawVersion(const Int_t iver) { fRawVersion = iver; } // set the expected raw data version
 107   void             SetReconstructor(const AliTRDReconstructor *rec) {fReconstructor = rec;}
 108   static UChar_t   GetStatus(Short_t &signal);
 109   Int_t            GetAddedClusters() const {return fNoOfClusters;}
 110   Int_t            GetNTimeBins() const {return fTimeTotal;}
 111
 112   Bool_t           IsClustersOwner() const {return TestBit(kClOwner);}
 113   virtual void     SetClustersOwner(Bool_t own=kTRUE) {SetBit(kClOwner, own); if(!own) {fRecPoints = 0x0; fNoOfClusters=0;} }
 114   void             SetTrackletsOwner(Bool_t own=kTRUE) {SetBit(kTrOwner, own); if(!own) {fTracklets = 0x0; } }
 115   void             SetTracksOwner(Bool_t own=kTRUE) {SetBit(kTracksOwner, own); if(!own) {fTracks = 0x0; } }
 116   void             SetSkipTransform(Bool_t b=kTRUE) {SetBit(kSkipTrafo, b); }
 117
 118   UInt_t   GetTriggerFlags(const Int_t sector) const { return fTrgFlags[sector]; }
 119
 120 protected:
 121
 122   void             ApplyTCTM(Short_t *const arr, const Int_t nTime, const Int_t nexp);
 123   void             DeConvExp (Short_t *const arr, const Int_t nTime, const Int_t nexp);
 124   void             ConvExp(Short_t *const arr, const Int_t nTime);
 125   void             TailCancelation(const AliTRDrecoParam* const recoParam);
 126
 127   Float_t          Unfold(Double_t eps, Int_t layer, const Double_t *const padSignal) const;
 128
 129   void             SetPadStatus(const UChar_t status, UChar_t &encoding) const;
 130   UChar_t          GetPadStatus(UChar_t encoding) const;
 131   Int_t            GetCorruption(UChar_t encoding) const;
 132
 133   Bool_t           IsMaximum(const MaxStruct &Max, UChar_t &padStatus, Short_t *const Signals);       //for const correctness reasons not const parameters are given separately
 134   Bool_t           FivePadCluster(MaxStruct &ThisMax, MaxStruct &NeighbourMax);
 135   void             CreateCluster(const MaxStruct &Max);
 136
 137   virtual void     AddClusterToArray(AliTRDcluster* cluster);
 138
 139 private:
 140   inline void      CalcAdditionalInfo(const MaxStruct &Max, Short_t *const signals, Int_t &nPadCount);
 141
 142 protected:
 143   const AliTRDReconstructor *fReconstructor; //! reconstructor
 144   AliRunLoader        *fRunLoader;           //! Run Loader
 145   TTree               *fClusterTree;         //! Tree with the cluster
 146   TClonesArray        *fRecPoints;           //! Array of clusters
 147   TClonesArray        *fTracklets;           //! Array of online tracklets
 148   TClonesArray        *fTracks;              //! Array of GTU tracks
 149
 150   TTree               *fTrackletTree;        //! Tree for tracklets
 151
 152   AliTRDdigitsManager *fDigitsManager;       //! TRD digits manager
 153
 154   UInt_t              **fTrackletContainer;  //! tracklet container
 155                                              // legacy code to avoid breakint AliHLTTRDClusterizer
 156                                              // but it's useless
 157
 158   Int_t                fRawVersion;          //  Expected raw version of the data - default is 2
 159
 160   AliTRDtransform     *fTransform;           //! Transforms the reconstructed space points
 161
 162   AliTRDarrayADC      *fDigits;               // Array holding the digits
 163   AliTRDSignalIndex   *fIndexes;              // Array holding the indexes to the digits
 164   Short_t              fMaxThresh;            // Threshold value for the maximum
 165   Short_t              fMaxThreshTest;        // Threshold value for the maximum to test agains
 166   Short_t              fSigThresh;            // Threshold value for the digit signal
 167   Float_t              fMinMaxCutSigma;       // Threshold value for the maximum (cut noise)
 168   Float_t              fMinLeftRightCutSigma; // Threshold value for the sum pad (cut noise)
 169   Int_t                fLayer;                // Current layer of the detector
 170   Int_t                fDet;                  // Current detecor
 171   UShort_t             fVolid;                // Volume ID
 172   Int_t                fColMax;               // Number of Colums in one detector
 173   Int_t                fTimeTotal;            // Number of time bins
 174   AliTRDCalROC        *fCalGainFactorROC;     // Calibration object with pad wise values for the gain factors
 175   Float_t              fCalGainFactorDetValue;// Calibration value for chamber wise noise
 176   AliTRDCalROC        *fCalNoiseROC;          // Calibration object with pad wise values for the noise
 177   Float_t              fCalNoiseDetValue;     // Calibration value for chamber wise noise
 178   AliTRDCalSingleChamberStatus *fCalPadStatusROC; // Calibration object with the pad status
 179   AliTRDCalOnlineGainTableROC *fCalOnGainROC; // Calibration table of online gain factors
 180   Int_t                fClusterROC;           // The index to the first cluster of a given ROC
 181   Int_t                firstClusterROC;       // The number of cluster in a given ROC
 182   Int_t                fNoOfClusters;         // Number of Clusters already processed and still owned by the clusterizer
 183   Int_t                fBaseline;             // Baseline of the ADC values
 184   AliTRDrawStream     *fRawStream;            // Raw data streamer
 185   UInt_t               fTrgFlags[AliTRDgeometry::kNsector]; // trigger flags
 186
 187   ClassDef(AliTRDclusterizer,6)               //  TRD clusterfinder
 188
 189 };
 190
 191 #endif