FMD/AliFMDBaseDigitizer.cxx

   1 /**************************************************************************
   2  * Copyright(c) 2004, ALICE Experiment at CERN, All rights reserved. *
   3  *                                                                        *
   4  * Author: The ALICE Off-line Project.                                    *
   5  * Contributors are mentioned in the code where appropriate.              *
   6  *                                                                        *
   7  * Permission to use, copy, modify and distribute this software and its   *
   8  * documentation strictly for non-commercial purposes is hereby granted   *
   9  * without fee, provided that the above copyright notice appears in all   *
  10  * copies and that both the copyright notice and this permission notice   *
  11  * appear in the supporting documentation. The authors make no claims     *
  12  * about the suitability of this software for any purpose. It is          *
  13  * provided "as is" without express or implied warranty.                  *
  14  **************************************************************************/
  15 /* $Id$ */
  16 /** @file    AliFMDBaseDigitizer.cxx
  17     @author  Christian Holm Christensen <cholm@nbi.dk>
  18     @date    Mon Mar 27 12:38:26 2006
  19     @brief   FMD Digitizers implementation
  20     @ingroup FMD_sim
  21 */
  22 //////////////////////////////////////////////////////////////////////////////
  23 //
  24 //  This class contains the procedures simulation ADC  signal for the
  25 //  Forward Multiplicity detector  : Hits->Digits and Hits->SDigits
  26 //
  27 //  Digits consists of
  28 //   - Detector #
  29 //   - Ring ID
  30 //   - Sector #
  31 //   - Strip #
  32 //   - ADC count in this channel
  33 //
  34 //  Digits consists of
  35 //   - Detector #
  36 //   - Ring ID
  37 //   - Sector #
  38 //   - Strip #
  39 //   - Total energy deposited in the strip
  40 //   - ADC count in this channel
  41 //
  42 // As the Digits and SDigits have so much in common, the classes
  43 // AliFMDDigitizer and AliFMDSDigitizer are implemented via a base
  44 // class AliFMDBaseDigitizer.
  45 //
  46 //                 +---------------------+
  47 //                 | AliFMDBaseDigitizer |
  48 //                 +---------------------+
  49 //                           ^
  50 //                           |
  51 //                +----------+---------+
  52 //                |                    |
  53 //      +-----------------+     +------------------+
  54 //      | AliFMDDigitizer |     | AliFMDSDigitizer |
  55 //      +-----------------+     +------------------+
  56 //
  57 // These classes has several paramters:
  58 //
  59 //     fPedestal
  60 //     fPedestalWidth
  61 //         (Only AliFMDDigitizer)
  62 //         Mean and width of the pedestal.  The pedestal is simulated
  63 //         by a Guassian, but derived classes my override MakePedestal
  64 //         to simulate it differently (or pick it up from a database).
  65 //
  66 //     fVA1MipRange
  67 //         The dymamic MIP range of the VA1_ALICE pre-amplifier chip
  68 //
  69 //     fAltroChannelSize
  70 //         The largest number plus one that can be stored in one
  71 //         channel in one time step in the ALTRO ADC chip.
  72 //
  73 //     fSampleRate
  74 //         How many times the ALTRO ADC chip samples the VA1_ALICE
  75 //         pre-amplifier signal.   The VA1_ALICE chip is read-out at
  76 //         10MHz, while it's possible to drive the ALTRO chip at
  77 //         25MHz.  That means, that the ALTRO chip can have time to
  78 //         sample each VA1_ALICE signal up to 2 times.  Although it's
  79 //         not certain this feature will be used in the production,
  80 //         we'd like have the option, and so it should be reflected in
  81 //         the code.
  82 //
  83 //
  84 // The shaping function of the VA1_ALICE is generally given by
  85 //
  86 //      f(x) = A(1 - exp(-Bx))
  87 //
  88 // where A is the total charge collected in the pre-amp., and B is a
  89 // paramter that depends on the shaping time of the VA1_ALICE circut.
  90 //
  91 // When simulating the shaping function of the VA1_ALICe
  92 // pre-amp. chip, we have to take into account, that the shaping
  93 // function depends on the previous value of read from the pre-amp.
  94 //
  95 // That results in the following algorithm:
  96 //
  97 //    last = 0;
  98 //    FOR charge IN pre-amp. charge train DO
  99 //      IF last < charge THEN
 100 //        f(t) = (charge - last) * (1 - exp(-B * t)) + last
 101 //      ELSE
 102 //        f(t) = (last - charge) * exp(-B * t) + charge)
 103 //      ENDIF
 104 //      FOR i IN # samples DO
 105 //        adc_i = f(i / (# samples))
 106 //      DONE
 107 //      last = charge
 108 //   DONE
 109 //
 110 // Here,
 111 //
 112 //   pre-amp. charge train
 113 //       is a series of 128 charges read from the VA1_ALICE chip
 114 //
 115 //   # samples
 116 //       is the number of times the ALTRO ADC samples each of the 128
 117 //       charges from the pre-amp.
 118 //
 119 // Where Q is the total charge collected by the VA1_ALICE
 120 // pre-amplifier.   Q is then given by
 121 //
 122 //           E S
 123 //      Q =  - -
 124 //           e R
 125 //
 126 // where E is the total energy deposited in a silicon strip, R is the
 127 // dynamic range of the VA1_ALICE pre-amp (fVA1MipRange), e is the
 128 // energy deposited by a single MIP, and S ALTRO channel size in each
 129 // time step (fAltroChannelSize).
 130 //
 131 // The energy deposited per MIP is given by
 132 //
 133 //      e = M * rho * w
 134 //
 135 // where M is the universal number 1.664, rho is the density of
 136 // silicon, and w is the depth of the silicon sensor.
 137 //
 138 // The final ADC count is given by
 139 //
 140 //      C' = C + P
 141 //
 142 // where P is the (randomized) pedestal (see MakePedestal)
 143 //
 144 // This class uses the class template AliFMDMap<Type> to make an
 145 // internal cache of the energy deposted of the hits.  The class
 146 // template is instantasized as
 147 //
 148 //  typedef AliFMDMap<std::pair<Float_t, UShort_t> > AliFMDEdepMap;
 149 //
 150 // The first member of the values is the summed energy deposition in a
 151 // given strip, while the second member of the values is the number of
 152 // hits in a given strip.  Using the second member, it's possible to
 153 // do some checks on just how many times a strip got hit, and what
 154 // kind of error we get in our reconstructed hits.  Note, that this
 155 // information is currently not written to the digits tree.  I think a
 156 // QA (Quality Assurance) digit tree is better suited for that task.
 157 // However, the information is there to be used in the future.
 158 //
 159 //
 160 // Latest changes by Christian Holm Christensen
 161 //
 162 //////////////////////////////////////////////////////////////////////////////
 163
 164 //      /1
 165 //      |           A(-1 + B + exp(-B))
 166 //      | f(x) dx = ------------------- = 1
 167 //      |                    B
 168 //      / 0
 169 //
 170 // and B is the a parameter defined by the shaping time (fShapingTime).
 171 //
 172 // Solving the above equation, for A gives
 173 //
 174 //                 B
 175 //      A = ----------------
 176 //          -1 + B + exp(-B)
 177 //
 178 // So, if we define the function g: [0,1] -> [0:1] by
 179 //
 180 //               / v
 181 //               |              Bu + exp(-Bu) - Bv - exp(-Bv)
 182 //      g(u,v) = | f(x) dx = -A -----------------------------
 183 //               |                            B
 184 //               / u
 185 //
 186 // we can evaluate the ALTRO sample of the VA1_ALICE pre-amp between
 187 // any two times (u, v), by
 188 //
 189 //
 190 //                                B         Bu + exp(-Bu) - Bv - exp(-Bv)
 191 //      C = Q g(u,v) = - Q ---------------- -----------------------------
 192 //                         -1 + B + exp(-B)              B
 193 //
 194 //               Bu + exp(-Bu) - Bv - exp(-Bv)
 195 //        = -  Q -----------------------------
 196 //                    -1 + B + exp(-B)
 197 //
 198
 199 #include <TMath.h>
 200 #include <TTree.h>              // ROOT_TTree
 201 //#include <TRandom.h>          // ROOT_TRandom
 202 // #include <AliLog.h>          // ALILOG_H
 203 #include "AliFMDDebug.h" // Better debug macros
 204 #include "AliFMDBaseDigitizer.h" // ALIFMDDIGITIZER_H
 205 #include "AliFMD.h"             // ALIFMD_H
 206 #include "AliFMDGeometry.h"     // ALIFMDGEOMETRY_H
 207 #include "AliFMDDetector.h"     // ALIFMDDETECTOR_H
 208 #include "AliFMDRing.h"         // ALIFMDRING_H
 209 #include "AliFMDHit.h"          // ALIFMDHIT_H
 210 // #include "AliFMDDigit.h"     // ALIFMDDIGIT_H
 211 #include "AliFMDParameters.h"   // ALIFMDPARAMETERS_H
 212 // #include <AliRunDigitizer.h> // ALIRUNDIGITIZER_H
 213 //#include <AliRun.h>           // ALIRUN_H
 214 #include <AliLoader.h>          // ALILOADER_H
 215 #include <AliRun.h>             // ALILOADER_H
 216 #include <AliRunLoader.h>       // ALIRUNLOADER_H
 217 #include <TRandom.h>
 218
 219 //====================================================================
 220 ClassImp(AliFMDBaseDigitizer)
 221 #if 0
 222   ; // This is here to keep Emacs for indenting the next line
 223 #endif
 224
 225 //____________________________________________________________________
 226 AliFMDBaseDigitizer::AliFMDBaseDigitizer()
 227   : fFMD(0),
 228     fRunLoader(0),
 229     fEdep(AliFMDMap::kMaxDetectors,
 230           AliFMDMap::kMaxRings,
 231           AliFMDMap::kMaxSectors,
 232           AliFMDMap::kMaxStrips),
 233     fShapingTime(6)
 234 {
 235   AliFMDDebug(1, ("Constructed"));
 236   // Default ctor - don't use it
 237 }
 238
 239 //____________________________________________________________________
 240 AliFMDBaseDigitizer::AliFMDBaseDigitizer(AliRunDigitizer* manager)
 241   : AliDigitizer(manager, "AliFMDBaseDigitizer", "FMD Digitizer base class"),
 242     fFMD(0),
 243     fRunLoader(0),
 244     fEdep(AliFMDMap::kMaxDetectors,
 245           AliFMDMap::kMaxRings,
 246           AliFMDMap::kMaxSectors,
 247           AliFMDMap::kMaxStrips),
 248     fShapingTime(6)
 249 {
 250   // Normal CTOR
 251   AliFMDDebug(1, ("Constructed"));
 252   SetShapingTime();
 253 }
 254
 255 //____________________________________________________________________
 256 AliFMDBaseDigitizer::AliFMDBaseDigitizer(const Char_t* name,
 257                                          const Char_t* title)
 258   : AliDigitizer(name, title),
 259     fFMD(0),
 260     fRunLoader(0),
 261     fEdep(AliFMDMap::kMaxDetectors,
 262           AliFMDMap::kMaxRings,
 263           AliFMDMap::kMaxSectors,
 264           AliFMDMap::kMaxStrips),
 265     fShapingTime(6)
 266 {
 267   // Normal CTOR
 268   AliFMDDebug(1, (" Constructed"));
 269   SetShapingTime();
 270 }
 271
 272 //____________________________________________________________________
 273 AliFMDBaseDigitizer::~AliFMDBaseDigitizer()
 274 {
 275   // Destructor
 276 }
 277
 278 //____________________________________________________________________
 279 Bool_t
 280 AliFMDBaseDigitizer::Init()
 281 {
 282   // Initialization.   Get a pointer to the parameter manager, and
 283   // initialize it.
 284   AliFMDParameters::Instance()->Init();
 285   if (AliLog::GetDebugLevel("FMD","") >= 15)
 286     AliFMDParameters::Instance()->Print("");
 287   return kTRUE;
 288 }
 289
 290 //____________________________________________________________________
 291 UShort_t
 292 AliFMDBaseDigitizer::MakePedestal(UShort_t detector,
 293                                   Char_t   ring,
 294                                   UShort_t sector,
 295                                   UShort_t strip) const
 296 {
 297   // Make a pedestal.  The pedestal value is drawn from a Gaussian
 298   // distribution.  The mean of the distribution is the measured
 299   // pedestal, and the width is the measured noise.
 300   AliFMDParameters* param =AliFMDParameters::Instance();
 301   Float_t           mean  =param->GetPedestal(detector,ring,sector,strip);
 302   Float_t           width =param->GetPedestalWidth(detector,ring,sector,strip);
 303   return UShort_t(TMath::Max(gRandom->Gaus(mean, width), 0.));
 304 }
 305
 306 //____________________________________________________________________
 307 void
 308 AliFMDBaseDigitizer::AddContribution(UShort_t detector,
 309                                      Char_t   ring,
 310                                      UShort_t sector,
 311                                      UShort_t strip,
 312                                      Float_t  edep)
 313 {
 314   // Add edep contribution from (detector,ring,sector,strip) to cache
 315   AliFMDParameters* param = AliFMDParameters::Instance();
 316
 317   // Check if strip is `dead'
 318   if (param->IsDead(detector, ring, sector, strip)) {
 319     AliFMDDebug(5, ("FMD%d%c[%2d,%3d] is marked as dead",
 320                     detector, ring, sector, strip));
 321     return;
 322   }
 323   // Check if strip is out-side read-out range
 324   // if (strip < minstrip || strip > maxstrip) {
 325   //   AliFMDDebug(5, ("FMD%d%c[%2d,%3d] is outside range [%3d,%3d]",
 326   //                detector,ring,sector,strip,minstrip,maxstrip));
 327   //   continue;
 328   // }
 329
 330   // Give warning in case of double sdigit
 331   if (fEdep(detector, ring, sector, strip).fEdep != 0)
 332     AliFMDDebug(5, ("Double digit in %d%c(%d,%d)",
 333                     detector, ring, sector, strip));
 334
 335   // Sum energy deposition
 336   fEdep(detector, ring, sector, strip).fEdep  += edep;
 337   fEdep(detector, ring, sector, strip).fN     += 1;
 338 }
 339
 340 //____________________________________________________________________
 341 void
 342 AliFMDBaseDigitizer::DigitizeHits() const
 343 {
 344   // For the stored energy contributions in the cache (fEdep), convert
 345   // the energy signal to ADC counts, and store the created digit in
 346   // the digits array (AliFMD::fDigits)
 347   //
 348   AliFMDDebug(5, ("Will now digitize all the summed signals"));
 349   AliFMDGeometry* geometry = AliFMDGeometry::Instance();
 350
 351   TArrayI counts(4);
 352   for (UShort_t detector=1; detector <= 3; detector++) {
 353     AliFMDDebug(10, ("Processing hits in FMD%d", detector));
 354     // Get pointer to subdetector
 355     AliFMDDetector* det = geometry->GetDetector(detector);
 356     if (!det) continue;
 357     for (UShort_t ringi = 0; ringi <= 1; ringi++) {
 358       Char_t ring = ringi == 0 ? 'I' : 'O';
 359       AliFMDDebug(10, (" Processing hits in FMD%d%c", detector,ring));
 360       // Get pointer to Ring
 361       AliFMDRing* r = det->GetRing(ring);
 362       if (!r) continue;
 363
 364       // Get number of sectors
 365       UShort_t nSectors = UShort_t(360. / r->GetTheta());
 366       // Loop over the number of sectors
 367       for (UShort_t sector = 0; sector < nSectors; sector++) {
 368         AliFMDDebug(10, ("  Processing hits in FMD%d%c[%2d]",
 369                         detector,ring,sector));
 370         // Get number of strips
 371         UShort_t nStrips = r->GetNStrips();
 372         // Loop over the stips
 373         Float_t last = 0;
 374         for (UShort_t strip = 0; strip < nStrips; strip++) {
 375           // Reset the counter array to the invalid value -1
 376           counts.Reset(-1);
 377           // Reset the last `ADC' value when we've get to the end of a
 378           // VA1_ALICE channel.
 379           if (strip % 128 == 0) last = 0;
 380
 381           Float_t edep = fEdep(detector, ring, sector, strip).fEdep;
 382           ConvertToCount(edep, last, detector, ring, sector, strip, counts);
 383           last = edep;
 384
 385           // The following line was introduced - wrongly - by Peter
 386           // Hristov.  It _will_ break the digitisation and the
 387           // following reconstruction.  The behviour of the
 388           // digitisation models exactly the front-end as it should
 389           // (no matter what memory concuption it may entail).  The
 390           // check should be on zero suppression, since that's what
 391           // models the front-end - if zero suppression is turned on
 392           // in the front-end, then we can suppress empty digits -
 393           // otherwise we shoud never do that.  Note, that the line
 394           // affects _both_ normal digitisation and digitisation for
 395           // summable digits, since the condition is on the energy
 396           // deposition and not on the actual number of counts.  If
 397           // this line should go anywhere, it should be in the
 398           // possible overloaded AliFMDSDigitizer::AddDigit - not
 399           // here.
 400           //
 401           //   if (edep<=0) continue;
 402           AddDigit(detector, ring, sector, strip, edep,
 403                    UShort_t(counts[0]), Short_t(counts[1]),
 404                    Short_t(counts[2]), Short_t(counts[3]));
 405           AliFMDDebug(15, ("   Adding digit in FMD%d%c[%2d,%3d]=%d",
 406                           detector,ring,sector,strip,counts[0]));
 407 #if 0
 408           // This checks if the digit created will give the `right'
 409           // number of particles when reconstructed, using a naiive
 410           // approach.  It's here only as a quality check - nothing
 411           // else.
 412           CheckDigit(digit, fEdep(detector, ring, sector, strip).fN,
 413                      counts);
 414 #endif
 415         } // Strip
 416       } // Sector
 417     } // Ring
 418   } // Detector
 419 }
 420
 421 //____________________________________________________________________
 422 void
 423 AliFMDBaseDigitizer::ConvertToCount(Float_t   edep,
 424                                     Float_t   last,
 425                                     UShort_t  detector,
 426                                     Char_t    ring,
 427                                     UShort_t  sector,
 428                                     UShort_t  strip,
 429                                     TArrayI&  counts) const
 430 {
 431   // Convert the total energy deposited to a (set of) ADC count(s).
 432   //
 433   // This is done by
 434   //
 435   //               Energy_Deposited      ALTRO_Channel_Size
 436   //    ADC = -------------------------- ------------------- + pedestal
 437   //          Energy_Deposition_Of_1_MIP VA1_ALICE_MIP_Range
 438   //
 439   //               Energy_Deposited             fAltroChannelSize
 440   //        = --------------------------------- ----------------- + pedestal
 441   //          1.664 * Si_Thickness * Si_Density   fVA1MipRange
 442   //
 443   //
 444   //        = Energy_Deposited * ConversionFactor + pedestal
 445   //
 446   // However, this is modified by the response function of the
 447   // VA1_ALICE pre-amp. chip in case we are doing oversampling of the
 448   // VA1_ALICE output.
 449   //
 450   // In that case, we get N=fSampleRate values of the ADC, and the
 451   // `EnergyDeposited' is a function of which sample where are
 452   // calculating the ADC for
 453   //
 454   //     ADC_i = f(EnergyDeposited, i/N, Last) * ConversionFactor + pedestal
 455   //
 456   // where Last is the Energy deposited in the previous strip.
 457   //
 458   // Here, f is the shaping function of the VA1_ALICE.   This is given
 459   // by
 460   //
 461   //                    |   (E - l) * (1 - exp(-B * t) + l   if E > l
 462   //       f(E, t, l) = <
 463   //                    |   (l - E) * exp(-B * t) + E        otherwise
 464   //
 465   //
 466   //                  = E + (l - E) * ext(-B * t)
 467   //
 468   AliFMDParameters* param = AliFMDParameters::Instance();
 469   Float_t  convF          = param->GetDACPerMIP()*param->GetPulseGain(detector,ring,sector,strip);
 470   Int_t    ped            = MakePedestal(detector,ring,sector,strip);
 471   Int_t    maxAdc         = param->GetAltroChannelSize()-1;
 472   if (maxAdc < 0) {
 473     AliWarning(Form("Maximum ADC is %d < 0, forcing it to 1023", maxAdc));
 474     maxAdc = 1023;
 475   }
 476   UShort_t rate           = param->GetSampleRate(detector,ring,sector,strip);
 477   AliFMDDebug(15, ("Sample rate for FMD%d%c[%2d,%3d] = %d",
 478                   detector, ring, sector, strip, rate));
 479   if (rate < 1 || rate > 4) {
 480     AliWarning(Form("Invalid sample rate for for FMD%d%c[%2d,%3d] = %d",
 481                     detector, ring, sector, strip, rate));
 482     rate = 1;
 483   }
 484
 485   // In case we don't oversample, just return the end value.
 486   if (rate == 1) {
 487     Float_t    a = edep * convF + ped;
 488     if (a < 0) a = 0;
 489     counts[0]    = UShort_t(TMath::Min(a, Float_t(maxAdc)));
 490     AliFMDDebug(15, ("FMD%d%c[%2d,%3d]: converting ELoss %f to "
 491                      "ADC %4d (%f,%d)",
 492                      detector,ring,sector,strip,edep,counts[0],convF,ped));
 493     return;
 494   }
 495
 496   // Create a pedestal
 497   Float_t b = fShapingTime;
 498   for (Ssiz_t i = 0; i < rate;  i++) {
 499     Float_t t  = Float_t(i) / rate + 1./rate;
 500     Float_t s  = edep + (last - edep) * TMath::Exp(-b * t);
 501     Float_t a  = Int_t(s * convF + ped);
 502     if (a < 0) a = 0;
 503     counts[i]  = UShort_t(TMath::Min(a, Float_t(maxAdc)));
 504   }
 505 }
 506
 507 //____________________________________________________________________
 508 void
 509 AliFMDBaseDigitizer::AddDigit(UShort_t  detector,
 510                               Char_t    ring,
 511                               UShort_t  sector,
 512                               UShort_t  strip,
 513                               Float_t   /* edep */,
 514                               UShort_t  count1,
 515                               Short_t   count2,
 516                               Short_t   count3,
 517                               Short_t   count4) const
 518 {
 519   // Add a digit or summable digit
 520
 521   fFMD->AddDigitByFields(detector, ring, sector, strip,
 522                          count1, count2, count3, count4);
 523 }
 524
 525 //____________________________________________________________________
 526 TTree*
 527 AliFMDBaseDigitizer::MakeOutputTree(AliLoader* loader)
 528 {
 529   // Create output tree using loader.   If the passed loader differs
 530   // from the currently set loader in the FMD object, reset the FMD
 531   // loader to be the passed loader.   This is for the cases wher the
 532   // output is different from the output.
 533   AliFMDDebug(5, ("Making digits tree"));
 534   loader->LoadDigits("UPDATE"); // "RECREATE");
 535   TTree* out = loader->TreeD();
 536   if (!out) loader->MakeTree("D");
 537   out = loader->TreeD();
 538   if (out) {
 539     out->Reset();
 540     if (loader != fFMD->GetLoader())
 541       fFMD->SetLoader(loader);
 542     fFMD->MakeBranch("D");
 543   }
 544   return out;
 545 }
 546
 547 //____________________________________________________________________
 548 void
 549 AliFMDBaseDigitizer::StoreDigits(AliLoader* loader)
 550 {
 551   // Write the digits to disk
 552   AliFMDDebug(5, ("Storing %d digits",   fFMD->Digits()->GetEntries()));
 553   loader->WriteDigits("OVERWRITE");
 554   loader->UnloadDigits();
 555   // Reset the digits in the AliFMD object
 556   fFMD->ResetDigits();
 557 }
 558
 559 //____________________________________________________________________
 560 //
 561 // EOF
 562 //
 563
 564
 565
 566