ROOT logo
#ifndef ALITRDCLUSTERIZER_H
#define ALITRDCLUSTERIZER_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */

////////////////////////////////////////////////////////////////////////////
//                                                                        //
//  TRD cluster finder                                                    //
//                                                                        //
////////////////////////////////////////////////////////////////////////////

#include <TNamed.h>

#include "AliTRDgeometry.h"

class TFile;
class TTree;
class TClonesArray;

class AliRunLoader;
class AliRawReader;

class AliTRD;
class AliTRDcluster;

class AliTRDrawStream;
class AliTRDarrayADC;
class AliTRDarraySignal;
class AliTRDdigitsManager;
class AliTRDSignalIndex;
class AliTRDtransform;
class AliTRDCalROC;
class AliTRDReconstructor;
class AliTRDCalSingleChamberStatus;
class AliTRDrecoParam;
class AliTRDCalOnlineGainTableROC;

class AliTRDclusterizer : public TNamed 
{

 public:

  // steering flags
  // bits from 0-13 are reserved by ROOT (see TObject.h)
  enum{
    kTrOwner = BIT(14)  //  toggle online tracklets ownership
    ,kClOwner= BIT(15)  //  toggle cluster ownership
    ,kLabels = BIT(16)  //  toggle MC labels for clusters
    ,kSkipTrafo = BIT(17)  //  skip the coordinate transformation of clusters?
    ,kLUT    = BIT(18)  //  using look up table for cluster's r-phi position
    ,kGAUS   = BIT(19)  //  using gauss approx. for cluster's r-phi position
    ,knewDM  = BIT(20)  //  was the digitsmanger created by raw2clusters?
    ,kTracksOwner = BIT(21) //  toggle GTU track ownership
    ,kRawSignal = BIT(22) //  toggle storage of raw signals in clusters
  };

  struct MaxStruct
  {
    Int_t       row;           // row of the current cluster candidate
    Int_t       col;           // col of the current cluster candidate
    Int_t       time;          // time -"-
    Float_t     signals[3];    // signals of the maximum pad and it's twon neigbours
    UChar_t     padStatus;     // padStatus of the current cluster candidate
    Bool_t      fivePad;       // is this cluster candidate part of a 5 pad cluster (two overlaping clusters)?
  MaxStruct():row(-1),col(0),time(0),padStatus(0),fivePad(kFALSE)
      {memset(signals, 0, 3*sizeof(Float_t));}
    MaxStruct &operator=(const MaxStruct &a)
    {memcpy(this, &a, sizeof(MaxStruct)); return *this;}
  };
  
  AliTRDclusterizer(const AliTRDReconstructor *const rec = 0x0);
  AliTRDclusterizer(const Text_t* name, const Text_t* title, const AliTRDReconstructor *const rec = 0x0);
  AliTRDclusterizer(const AliTRDclusterizer &c);
  virtual         ~AliTRDclusterizer();
  AliTRDclusterizer &operator=(const AliTRDclusterizer &c);

  void     Copy(TObject &c) const;

  Bool_t   Open(const Char_t *name, Int_t nEvent = 0);
  Bool_t   OpenInput(Int_t nEvent = 0);
  Bool_t   OpenOutput();
  Bool_t   OpenOutput(TTree *const clusterTree);

  Bool_t   ReadDigits();
  Bool_t   ReadDigits(AliRawReader *rawReader);
  Bool_t   ReadDigits(TTree *digitsTree);

  Bool_t   ReadTracklets();
  Bool_t   ReadTracks();

  Bool_t   WriteClusters(Int_t det);
  void     ResetRecPoints()                { fNoOfClusters = 0;}
  virtual TClonesArray    *RecPoints();
  virtual TClonesArray    *TrackletsArray(const TString &trkltype = "");
  virtual TClonesArray    *TracksArray();

  Bool_t   Raw2Clusters(AliRawReader *rawReader);
  Bool_t   Raw2ClustersChamber(AliRawReader *rawReader);

  Bool_t   MakeClusters();
  Bool_t   MakeClusters(Int_t det);

  Bool_t   AddLabels();
  Bool_t   SetUseLabels(const Bool_t kset) { SetBit(kLabels, kset); return TestBit(kLabels);  } // should we assign labels to clusters
  void     SetRawVersion(const Int_t iver) { fRawVersion = iver; } // set the expected raw data version
  void             SetReconstructor(const AliTRDReconstructor *rec) {fReconstructor = rec;}
  static UChar_t   GetStatus(Short_t &signal);
  Int_t            GetAddedClusters() const {return fNoOfClusters;}
  Int_t            GetNTimeBins() const {return fTimeTotal;}

  Bool_t           IsClustersOwner() const {return TestBit(kClOwner);}
  virtual void     SetClustersOwner(Bool_t own=kTRUE) {SetBit(kClOwner, own); if(!own) {fRecPoints = 0x0; fNoOfClusters=0;} }
  void             SetTrackletsOwner(Bool_t own=kTRUE) {SetBit(kTrOwner, own); if(!own) {fTracklets = 0x0; } }
  void             SetTracksOwner(Bool_t own=kTRUE) {SetBit(kTracksOwner, own); if(!own) {fTracks = 0x0; } }
  void             SetSkipTransform(Bool_t b=kTRUE) {SetBit(kSkipTrafo, b); }
  void             SetStoreRawSignals(Bool_t b=kTRUE) {SetBit(kRawSignal, b); }

  UInt_t   GetTriggerFlags(const Int_t sector) const { return fTrgFlags[sector]; }

protected:

  void             ApplyTCTM(Short_t *const arr, const Int_t nTime, const Int_t nexp);
  void             DeConvExp (Short_t *const arr, const Int_t nTime, const Int_t nexp);
  void             ConvExp(Short_t *const arr, const Int_t nTime);
  void             TailCancelation(const AliTRDrecoParam* const recoParam);

  Float_t          Unfold(Double_t eps, Int_t layer, const Double_t *const padSignal) const;
  
  void             SetPadStatus(const UChar_t status, UChar_t &encoding) const;
  UChar_t          GetPadStatus(UChar_t encoding) const;
  Int_t            GetCorruption(UChar_t encoding) const;

  Bool_t           IsMaximum(const MaxStruct &Max, UChar_t &padStatus, Float_t *const Signals);       //for const correctness reasons not const parameters are given separately
  Bool_t           FivePadCluster(MaxStruct &ThisMax, MaxStruct &NeighbourMax);
  void             CreateCluster(const MaxStruct &Max); 

  virtual void     AddClusterToArray(AliTRDcluster* cluster);

  const AliTRDReconstructor *fReconstructor;     //! reconstructor
  AliRunLoader        *fRunLoader;                //! Run Loader
  TTree               *fClusterTree;              //! Tree with the cluster
  TClonesArray        *fRecPoints;                //! Array of clusters
  TClonesArray        *fTracklets;                //! Array of online tracklets
  TClonesArray        *fTracks;                   //! Array of GTU tracks

  AliTRDdigitsManager *fDigitsManager;            //! TRD digits manager

  Int_t                fRawVersion;               //  Expected raw version of the data - default is 2

  AliTRDtransform     *fTransform;                //! Transforms the reconstructed space points

  AliTRDarrayADC      *fDigits;                   // Array holding the digits
  AliTRDarrayADC      *fDigitsRaw;                // Array holding the raw digits if requested
  AliTRDSignalIndex   *fIndexes;                  // Array holding the indexes to the digits
  Float_t              fMaxThresh;                // Threshold value for the maximum
  Float_t              fMaxThreshTest;            // Threshold value for the maximum to test agains
  Float_t              fSigThresh;                // Threshold value for the digit signal
  Float_t              fMinMaxCutSigma;           // Threshold value for the maximum (cut noise)
  Float_t              fMinLeftRightCutSigma;     // Threshold value for the sum pad (cut noise)
  Int_t                fLayer;                    // Current layer of the detector
  Int_t                fDet;                      // Current detecor
  UShort_t             fVolid;                    // Volume ID
  Int_t                fColMax;                   // Number of Colums in one detector
  Int_t                fTimeTotal;                // Number of time bins
  AliTRDCalROC        *fCalGainFactorROC;         // Calibration object with pad wise values for the gain factors
  Float_t              fCalGainFactorDetValue;    // Calibration value for chamber wise noise
  AliTRDCalROC        *fCalNoiseROC;              // Calibration object with pad wise values for the noise
  Float_t              fCalNoiseDetValue;         // Calibration value for chamber wise noise
  AliTRDCalSingleChamberStatus *fCalPadStatusROC; // Calibration object with the pad status
  AliTRDCalOnlineGainTableROC *fCalOnlGainROC;     // Calibration table of online gain factors
  Int_t                fClusterROC;               // The index to the first cluster of a given ROC
  Int_t                firstClusterROC;           // The number of cluster in a given ROC
  Int_t                fNoOfClusters;             // Number of Clusters already processed and still owned by the clusterizer
  Int_t                fBaseline;                 // Baseline of the ADC values
  AliTRDrawStream     *fRawStream;                // Raw data streamer
  UInt_t               fTrgFlags[AliTRDgeometry::kNsector]; // trigger flags

private:
  inline void      CalcAdditionalInfo(const MaxStruct &Max, Short_t *const signals, Int_t &nPadCount);

  ClassDef(AliTRDclusterizer,6)                   //  TRD clusterfinder

};

#endif
 AliTRDclusterizer.h:1
 AliTRDclusterizer.h:2
 AliTRDclusterizer.h:3
 AliTRDclusterizer.h:4
 AliTRDclusterizer.h:5
 AliTRDclusterizer.h:6
 AliTRDclusterizer.h:7
 AliTRDclusterizer.h:8
 AliTRDclusterizer.h:9
 AliTRDclusterizer.h:10
 AliTRDclusterizer.h:11
 AliTRDclusterizer.h:12
 AliTRDclusterizer.h:13
 AliTRDclusterizer.h:14
 AliTRDclusterizer.h:15
 AliTRDclusterizer.h:16
 AliTRDclusterizer.h:17
 AliTRDclusterizer.h:18
 AliTRDclusterizer.h:19
 AliTRDclusterizer.h:20
 AliTRDclusterizer.h:21
 AliTRDclusterizer.h:22
 AliTRDclusterizer.h:23
 AliTRDclusterizer.h:24
 AliTRDclusterizer.h:25
 AliTRDclusterizer.h:26
 AliTRDclusterizer.h:27
 AliTRDclusterizer.h:28
 AliTRDclusterizer.h:29
 AliTRDclusterizer.h:30
 AliTRDclusterizer.h:31
 AliTRDclusterizer.h:32
 AliTRDclusterizer.h:33
 AliTRDclusterizer.h:34
 AliTRDclusterizer.h:35
 AliTRDclusterizer.h:36
 AliTRDclusterizer.h:37
 AliTRDclusterizer.h:38
 AliTRDclusterizer.h:39
 AliTRDclusterizer.h:40
 AliTRDclusterizer.h:41
 AliTRDclusterizer.h:42
 AliTRDclusterizer.h:43
 AliTRDclusterizer.h:44
 AliTRDclusterizer.h:45
 AliTRDclusterizer.h:46
 AliTRDclusterizer.h:47
 AliTRDclusterizer.h:48
 AliTRDclusterizer.h:49
 AliTRDclusterizer.h:50
 AliTRDclusterizer.h:51
 AliTRDclusterizer.h:52
 AliTRDclusterizer.h:53
 AliTRDclusterizer.h:54
 AliTRDclusterizer.h:55
 AliTRDclusterizer.h:56
 AliTRDclusterizer.h:57
 AliTRDclusterizer.h:58
 AliTRDclusterizer.h:59
 AliTRDclusterizer.h:60
 AliTRDclusterizer.h:61
 AliTRDclusterizer.h:62
 AliTRDclusterizer.h:63
 AliTRDclusterizer.h:64
 AliTRDclusterizer.h:65
 AliTRDclusterizer.h:66
 AliTRDclusterizer.h:67
 AliTRDclusterizer.h:68
 AliTRDclusterizer.h:69
 AliTRDclusterizer.h:70
 AliTRDclusterizer.h:71
 AliTRDclusterizer.h:72
 AliTRDclusterizer.h:73
 AliTRDclusterizer.h:74
 AliTRDclusterizer.h:75
 AliTRDclusterizer.h:76
 AliTRDclusterizer.h:77
 AliTRDclusterizer.h:78
 AliTRDclusterizer.h:79
 AliTRDclusterizer.h:80
 AliTRDclusterizer.h:81
 AliTRDclusterizer.h:82
 AliTRDclusterizer.h:83
 AliTRDclusterizer.h:84
 AliTRDclusterizer.h:85
 AliTRDclusterizer.h:86
 AliTRDclusterizer.h:87
 AliTRDclusterizer.h:88
 AliTRDclusterizer.h:89
 AliTRDclusterizer.h:90
 AliTRDclusterizer.h:91
 AliTRDclusterizer.h:92
 AliTRDclusterizer.h:93
 AliTRDclusterizer.h:94
 AliTRDclusterizer.h:95
 AliTRDclusterizer.h:96
 AliTRDclusterizer.h:97
 AliTRDclusterizer.h:98
 AliTRDclusterizer.h:99
 AliTRDclusterizer.h:100
 AliTRDclusterizer.h:101
 AliTRDclusterizer.h:102
 AliTRDclusterizer.h:103
 AliTRDclusterizer.h:104
 AliTRDclusterizer.h:105
 AliTRDclusterizer.h:106
 AliTRDclusterizer.h:107
 AliTRDclusterizer.h:108
 AliTRDclusterizer.h:109
 AliTRDclusterizer.h:110
 AliTRDclusterizer.h:111
 AliTRDclusterizer.h:112
 AliTRDclusterizer.h:113
 AliTRDclusterizer.h:114
 AliTRDclusterizer.h:115
 AliTRDclusterizer.h:116
 AliTRDclusterizer.h:117
 AliTRDclusterizer.h:118
 AliTRDclusterizer.h:119
 AliTRDclusterizer.h:120
 AliTRDclusterizer.h:121
 AliTRDclusterizer.h:122
 AliTRDclusterizer.h:123
 AliTRDclusterizer.h:124
 AliTRDclusterizer.h:125
 AliTRDclusterizer.h:126
 AliTRDclusterizer.h:127
 AliTRDclusterizer.h:128
 AliTRDclusterizer.h:129
 AliTRDclusterizer.h:130
 AliTRDclusterizer.h:131
 AliTRDclusterizer.h:132
 AliTRDclusterizer.h:133
 AliTRDclusterizer.h:134
 AliTRDclusterizer.h:135
 AliTRDclusterizer.h:136
 AliTRDclusterizer.h:137
 AliTRDclusterizer.h:138
 AliTRDclusterizer.h:139
 AliTRDclusterizer.h:140
 AliTRDclusterizer.h:141
 AliTRDclusterizer.h:142
 AliTRDclusterizer.h:143
 AliTRDclusterizer.h:144
 AliTRDclusterizer.h:145
 AliTRDclusterizer.h:146
 AliTRDclusterizer.h:147
 AliTRDclusterizer.h:148
 AliTRDclusterizer.h:149
 AliTRDclusterizer.h:150
 AliTRDclusterizer.h:151
 AliTRDclusterizer.h:152
 AliTRDclusterizer.h:153
 AliTRDclusterizer.h:154
 AliTRDclusterizer.h:155
 AliTRDclusterizer.h:156
 AliTRDclusterizer.h:157
 AliTRDclusterizer.h:158
 AliTRDclusterizer.h:159
 AliTRDclusterizer.h:160
 AliTRDclusterizer.h:161
 AliTRDclusterizer.h:162
 AliTRDclusterizer.h:163
 AliTRDclusterizer.h:164
 AliTRDclusterizer.h:165
 AliTRDclusterizer.h:166
 AliTRDclusterizer.h:167
 AliTRDclusterizer.h:168
 AliTRDclusterizer.h:169
 AliTRDclusterizer.h:170
 AliTRDclusterizer.h:171
 AliTRDclusterizer.h:172
 AliTRDclusterizer.h:173
 AliTRDclusterizer.h:174
 AliTRDclusterizer.h:175
 AliTRDclusterizer.h:176
 AliTRDclusterizer.h:177
 AliTRDclusterizer.h:178
 AliTRDclusterizer.h:179
 AliTRDclusterizer.h:180
 AliTRDclusterizer.h:181
 AliTRDclusterizer.h:182
 AliTRDclusterizer.h:183
 AliTRDclusterizer.h:184
 AliTRDclusterizer.h:185
 AliTRDclusterizer.h:186
 AliTRDclusterizer.h:187