TRD/AliTRDmcmSim.h

   1 #ifndef ALITRDMCMSIM_H
   2 #define ALITRDMCMSIM_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 //  Multi Chip Module Simulation Class               //
  11 //                                                   //
  12 ///////////////////////////////////////////////////////
  13
  14 #include <iostream>
  15
  16 class TObject;
  17 class TClonesArray;
  18 class TH2F;
  19
  20 class AliRunLoader;
  21 class AliTRDfeeParam;
  22 class AliTRDtrapConfig;
  23 class AliTRDarrayADC;
  24 class AliTRDarrayDictionary;
  25 class AliTRDdigitsManager;
  26
  27 class AliTRDmcmSim : public TObject {
  28  public:
  29                     AliTRDmcmSim();
  30   virtual          ~AliTRDmcmSim();
  31
  32           void      Init(Int_t det, Int_t rob, Int_t mcm, Bool_t newEvent = kFALSE);
  33           // Initialize MCM by the position parameters
  34
  35           void      Reset();
  36           // clears filter registers and internal data
  37
  38           Bool_t    LoadMCM(AliRunLoader* const runloader, Int_t det, Int_t rob, Int_t mcm);
  39
  40           void      NoiseTest(Int_t nsamples, Int_t mean, Int_t sigma, Int_t inputGain = 1, Int_t inputTail = 2);
  41
  42           Int_t     GetDataRaw(Int_t iadc, Int_t timebin)      const { return (fADCR[iadc][timebin] >> 2); }
  43           // Get unfiltered ADC data
  44           Int_t     GetDataFiltered(Int_t iadc, Int_t timebin) const { return (fADCF[iadc][timebin] >> 2); }
  45           // Get filtered ADC data
  46
  47           void      SetData(Int_t iadc, Int_t *adc);           // Set ADC data with array
  48           void      SetData(Int_t iadc, Int_t it, Int_t adc); // Set ADC data
  49           void      SetData(AliTRDarrayADC *adcArray,
  50                             AliTRDdigitsManager *digitsManager = 0x0);         // Set ADC data from adcArray
  51           void      SetDataPedestal(Int_t iadc);              // Fill ADC data with pedestal values
  52
  53   static  Bool_t    GetApplyCut() { return fgApplyCut; }
  54   static  void      SetApplyCut(Bool_t applyCut) { fgApplyCut = applyCut; }
  55
  56   static  Int_t     GetAddBaseline() { return fgAddBaseline; }
  57   static  void      SetAddBaseline(Int_t baseline) { fgAddBaseline = baseline; }
  58   // Additional baseline which is added for the processing
  59   // in the TRAP and removed when writing back the data.
  60   // This is needed to run with TRAP parameters set for a
  61   // different baseline but it will not change the baseline
  62   // of the output.
  63
  64           Int_t     GetDetector() const  { return fDetector;  };     // Returns Chamber ID (0-539)
  65           Int_t     GetRobPos() const { return fRobPos; };           // Returns ROB position (0-7)
  66           Int_t     GetMcmPos() const { return fMcmPos; };           // Returns MCM position (0-17) (16,17 are mergers)
  67           Int_t     GetRow() const    { return fRow;    };           // Returns Row number on chamber where the MCM is sitting
  68           Int_t     GetCol( Int_t iadc );                            // Get corresponding column (0-143) from for ADC channel iadc = [0:20]
  69           // for the ADC/Col mapping, see: http://wiki.kip.uni-heidelberg.de/ti/TRD/index.php/Image:ROB_MCM_numbering.pdf
  70
  71           void      WriteData(AliTRDarrayADC *digits);
  72           Bool_t    StoreTracklets();                          // Stores tracklets via runloader
  73
  74           Int_t     ProduceRawStream( UInt_t *buf, Int_t bufsize, UInt_t iEv = 0 ) const; // Produce raw data stream - Real data format
  75           Int_t     ProduceTrackletStream( UInt_t *buf, Int_t bufsize ); // produce the tracklet stream for this MCM
  76
  77           // different stages of processing in the TRAP
  78           void      Filter();                                  // Apply digital filters for existing data (according to configuration)
  79           void      ZSMapping();                               // Do ZS mapping for existing data
  80           void      Tracklet();                                // Run tracklet preprocessor and perform tracklet fit
  81
  82           // apply individual filters to all channels and timebins
  83           void      FilterPedestal();                   // Apply pedestal filter
  84           void      FilterGain();                       // Apply gain filter
  85           void      FilterTail();                       // Apply tail filter
  86
  87           // filter initialization (resets internal registers)
  88           void      FilterPedestalInit(Int_t baseline = 10);
  89           void      FilterGainInit();
  90           void      FilterTailInit(Int_t baseline = -1);
  91
  92           // feed single sample to individual filter
  93           // this changes the internal registers
  94           // all filters operate on (10+2)-bit values!
  95           UShort_t  FilterPedestalNextSample(Int_t adc, Int_t timebin, UShort_t value);
  96           UShort_t  FilterGainNextSample(Int_t adc, UShort_t value);
  97           UShort_t  FilterTailNextSample(Int_t adc, UShort_t value);
  98
  99           // tracklet calculation
 100           void      AddHitToFitreg(Int_t adc, UShort_t timebin, UShort_t qtot, Short_t ypos, Int_t label);
 101           void      CalcFitreg();
 102           void      TrackletSelection();
 103           void      FitTracklet();
 104
 105           Int_t         GetNHits() const { return fNHits; }
 106           Bool_t        GetHit(Int_t index, Int_t &channel, Int_t &timebin, Int_t &qtot, Int_t &ypos, Float_t &y, Int_t &label) const;
 107           TClonesArray* GetTrackletArray() const { return fTrackletArray; }
 108
 109           // data display
 110           void      Print(Option_t* const option="") const;   // print stored data to stdout
 111           void      Draw(Option_t* const option ="");         // draw data (ADC data, hits and tracklets)
 112
 113   friend  std::ostream& operator<<(std::ostream &os, const AliTRDmcmSim &mcm); // data output using ostream (e.g. cout << mcm;)
 114   static  ostream&  Cfdat(ostream &os);                       // manipulator to activate cfdat output
 115   static  ostream&  Raw  (ostream &os);                       // manipulator to activate raw output
 116   static  ostream&  Text (ostream &os);                       // manipulator to activate text output
 117
 118  protected:
 119           Bool_t    CheckInitialized() const;           // Check whether the class is initialized
 120
 121           void      SetNTimebins(Int_t ntimebins);      // allocate data arrays corr. to the no. of timebins
 122
 123  static const Int_t fgkFormatIndex;                     // index for format settings in stream
 124
 125  static const Int_t fgkNADC;                            // Number of ADC
 126  static const Int_t fgkMaxTracklets = 4;                // maximum number of tracklet-words submitted per MCM (one per CPU)
 127  static const Int_t fgkAddDigits = 2;                   // additional digits used for internal representation of ADC data
 128                                                         // all internal data as after data control block (i.e. 12 bit), s. TRAP manual
 129  static const Int_t fgkNCPU = 4;                        // Number of CPUs in the TRAP
 130  static const Int_t fgkNHitsMC = 100;                   // maximum number of hits for which MC information is kept
 131
 132  static const UShort_t fgkFPshifts[4];                  // shifts for pedestal filter
 133
 134
 135           Bool_t    fInitialized;                       // memory is allocated if initialized
 136           Int_t     fDetector;                          // Chamber ID
 137           Int_t     fRobPos;                            // ROB Position on chamber
 138           Int_t     fMcmPos;                            // MCM Position on chamber
 139           Int_t     fRow;                               // Pad row number (0-11 or 0-15) of the MCM on chamber
 140           Int_t     fNTimeBin;                          // Number of timebins currently allocated
 141           Int_t   **fADCR;                              // Array with MCM ADC values (Raw, 12 bit)
 142           Int_t   **fADCF;                              // Array with MCM ADC values (Filtered, 12 bit)
 143           UInt_t   *fMCMT;                              // tracklet word for one mcm/trap-chip
 144           TClonesArray *fTrackletArray;                 // Array of AliTRDtrackletMCM which contains MC information in addition to the tracklet word
 145           Int_t    *fZSMap;                             // Zero suppression map (1 dimensional projection)
 146
 147           Int_t     fFitPtr[fgkNCPU];                   // pointer to the tracklet to be calculated by CPU i
 148
 149           // Parameter classes
 150           AliTRDfeeParam    *fFeeParam;                 // FEE parameters
 151           AliTRDtrapConfig  *fTrapConfig;               // TRAP config
 152
 153           AliTRDdigitsManager *fDigitsManager;          // pointer to digits manager used for MC label calculation
 154           AliTRDarrayDictionary* fDict[3];              // pointers to label dictionaries
 155
 156
 157           // internal filter registers
 158           UInt_t*   fPedAcc;                            // Accumulator for pedestal filter
 159           UInt_t*   fGainCounterA;                      // Counter for values above FGTA in the gain filter
 160           UInt_t*   fGainCounterB;                      // Counter for values above FGTB in the gain filter
 161           UShort_t* fTailAmplLong;                      // Amplitude of the long component in the tail filter
 162           UShort_t* fTailAmplShort;                     // Amplitude of the short component in the tail filter
 163
 164           // hit detection
 165           // individual hits can be stored as MC info
 166           struct Hit_t {                                // Array of detected hits (only available in MC)
 167             Int_t fChannel;                             // ADC channel of the hit
 168             Int_t fTimebin;                             // timebin of the hit
 169             Int_t fQtot;                                // total charge of the hit
 170             Int_t fYpos;                                // calculated y-position
 171             Int_t fLabel;                               // label (only in MC)
 172           } fHits[fgkNHitsMC];
 173           Int_t fNHits;                                 // Number of detected hits
 174
 175           // tracklet calculation
 176           struct FitReg_t {                             // pointer to the 18 fit registers
 177             Int_t  fNhits;                              // number of hits
 178             UInt_t fQ0;                                 // charge accumulated in first window
 179             UInt_t fQ1;                                 // charge accumulated in second window
 180             UInt_t fSumX;                               // sum x
 181             Int_t  fSumY;                               // sum y
 182             UInt_t fSumX2;                              // sum x**2
 183             UInt_t fSumY2;                              // sum y**2
 184             Int_t  fSumXY;                              // sum x*y
 185           } *fFitReg;
 186
 187           // Sort functions as in TRAP
 188           void Sort2(UShort_t  idx1i, UShort_t  idx2i, UShort_t  val1i, UShort_t  val2i,
 189                      UShort_t *idx1o, UShort_t *idx2o, UShort_t *val1o, UShort_t *val2o) const;
 190           void Sort3(UShort_t  idx1i, UShort_t  idx2i, UShort_t  idx3i,
 191                      UShort_t  val1i, UShort_t  val2i, UShort_t  val3i,
 192                      UShort_t *idx1o, UShort_t *idx2o, UShort_t *idx3o,
 193                      UShort_t *val1o, UShort_t *val2o, UShort_t *val3o);
 194           void Sort6To4(UShort_t  idx1i, UShort_t  idx2i, UShort_t  idx3i, UShort_t  idx4i, UShort_t  idx5i, UShort_t  idx6i,
 195                         UShort_t  val1i, UShort_t  val2i, UShort_t  val3i, UShort_t  val4i, UShort_t  val5i, UShort_t  val6i,
 196                         UShort_t *idx1o, UShort_t *idx2o, UShort_t *idx3o, UShort_t *idx4o,
 197                         UShort_t *val1o, UShort_t *val2o, UShort_t *val3o, UShort_t *val4o);
 198           void Sort6To2Worst(UShort_t  idx1i, UShort_t  idx2i, UShort_t  idx3i, UShort_t  idx4i, UShort_t  idx5i, UShort_t  idx6i,
 199                              UShort_t  val1i, UShort_t  val2i, UShort_t  val3i, UShort_t  val4i, UShort_t  val5i, UShort_t  val6i,
 200                              UShort_t *idx5o, UShort_t *idx6o);
 201
 202           UInt_t AddUintClipping(UInt_t a, UInt_t b, UInt_t nbits) const;
 203           // Add a and b (unsigned) with clipping to the maximum value representable by nbits
 204
 205  private:
 206           AliTRDmcmSim(const AliTRDmcmSim &m);             // not implemented
 207           AliTRDmcmSim &operator=(const AliTRDmcmSim &m);  // not implemented
 208
 209   static Bool_t fgApplyCut;               // apply cut on deflection length
 210
 211   static Int_t fgAddBaseline;             // add baseline to the ADC values
 212
 213   ClassDef(AliTRDmcmSim,6)
 214 };
 215
 216 std::ostream& operator<<(std::ostream& os, const AliTRDmcmSim& mcm);
 217
 218 #endif