FMD/AliFMDHitDigitizer.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: AliFMDHitDigitizer.cxx 28055 2008-08-18 00:33:20Z cholm $ */
  16 /** @file    AliFMDHitDigitizer.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
  26 //
  27 //  Digits consists of
  28 //   - Detector #
  29 //   - Ring ID
  30 //   - Sector #
  31 //   - Strip #
  32 //   - ADC count in this channel
  33 //
  34 // As the Digits and SDigits have so much in common, the classes
  35 // AliFMDHitDigitizer and AliFMDSDigitizer are implemented via a base
  36 // class AliFMDBaseDigitizer.
  37 //
  38 //                 +---------------------+
  39 //                 | AliFMDBaseDigitizer |
  40 //                 +---------------------+
  41 //                           ^
  42 //                           |
  43 //                +----------+---------+
  44 //                |                    |
  45 //      +-----------------+     +------------------+
  46 //      | AliFMDHitDigitizer |  | AliFMDSDigitizer |
  47 //      +-----------------+     +------------------+
  48 //
  49 // These classes has several paramters:
  50 //
  51 //     fPedestal
  52 //     fPedestalWidth
  53 //         (Only AliFMDHitDigitizer)
  54 //         Mean and width of the pedestal.  The pedestal is simulated
  55 //         by a Guassian, but derived classes my override MakePedestal
  56 //         to simulate it differently (or pick it up from a database).
  57 //
  58 //     fVA1MipRange
  59 //         The dymamic MIP range of the VA1_ALICE pre-amplifier chip
  60 //
  61 //     fAltroChannelSize
  62 //         The largest number plus one that can be stored in one
  63 //         channel in one time step in the ALTRO ADC chip.
  64 //
  65 //     fSampleRate
  66 //         How many times the ALTRO ADC chip samples the VA1_ALICE
  67 //         pre-amplifier signal.   The VA1_ALICE chip is read-out at
  68 //         10MHz, while it's possible to drive the ALTRO chip at
  69 //         25MHz.  That means, that the ALTRO chip can have time to
  70 //         sample each VA1_ALICE signal up to 2 times.  Although it's
  71 //         not certain this feature will be used in the production,
  72 //         we'd like have the option, and so it should be reflected in
  73 //         the code.
  74 //
  75 // These parameters are fetched from OCDB via the mananger AliFMDParameters.
  76 //
  77 // The shaping function of the VA1_ALICE is generally given by
  78 //
  79 //      f(x) = A(1 - exp(-Bx))
  80 //
  81 // where A is the total charge collected in the pre-amp., and B is a
  82 // paramter that depends on the shaping time of the VA1_ALICE circut.
  83 //
  84 // When simulating the shaping function of the VA1_ALICe
  85 // pre-amp. chip, we have to take into account, that the shaping
  86 // function depends on the previous value of read from the pre-amp.
  87 //
  88 // That results in the following algorithm:
  89 //
  90 //    last = 0;
  91 //    FOR charge IN pre-amp. charge train DO
  92 //      IF last < charge THEN
  93 //        f(t) = (charge - last) * (1 - exp(-B * t)) + last
  94 //      ELSE
  95 //        f(t) = (last - charge) * exp(-B * t) + charge)
  96 //      ENDIF
  97 //      FOR i IN # samples DO
  98 //        adc_i = f(i / (# samples))
  99 //      DONE
 100 //      last = charge
 101 //   DONE
 102 //
 103 // Here,
 104 //
 105 //   pre-amp. charge train
 106 //       is a series of 128 charges read from the VA1_ALICE chip
 107 //
 108 //   # samples
 109 //       is the number of times the ALTRO ADC samples each of the 128
 110 //       charges from the pre-amp.
 111 //
 112 // Where Q is the total charge collected by the VA1_ALICE
 113 // pre-amplifier.   Q is then given by
 114 //
 115 //           E S
 116 //      Q =  - -
 117 //           e R
 118 //
 119 // where E is the total energy deposited in a silicon strip, R is the
 120 // dynamic range of the VA1_ALICE pre-amp (fVA1MipRange), e is the
 121 // energy deposited by a single MIP, and S ALTRO channel size in each
 122 // time step (fAltroChannelSize).
 123 //
 124 // The energy deposited per MIP is given by
 125 //
 126 //      e = M * rho * w
 127 //
 128 // where M is the universal number 1.664, rho is the density of
 129 // silicon, and w is the depth of the silicon sensor.
 130 //
 131 // The final ADC count is given by
 132 //
 133 //      C' = C + P
 134 //
 135 // where P is the (randomized) pedestal (see MakePedestal)
 136 //
 137 // This class uses the class template AliFMDMap<Type> to make an
 138 // internal cache of the energy deposted of the hits.  The class
 139 // template is instantasized as
 140 //
 141 //  typedef AliFMDMap<std::pair<Float_t, UShort_t> > AliFMDEdepMap;
 142 //
 143 // The first member of the values is the summed energy deposition in a
 144 // given strip, while the second member of the values is the number of
 145 // hits in a given strip.  Using the second member, it's possible to
 146 // do some checks on just how many times a strip got hit, and what
 147 // kind of error we get in our reconstructed hits.  Note, that this
 148 // information is currently not written to the digits tree.  I think a
 149 // QA (Quality Assurance) digit tree is better suited for that task.
 150 // However, the information is there to be used in the future.
 151 //
 152 //
 153 // Latest changes by Christian Holm Christensen
 154 //
 155 //////////////////////////////////////////////////////////////////////////////
 156
 157 //      /1
 158 //      |           A(-1 + B + exp(-B))
 159 //      | f(x) dx = ------------------- = 1
 160 //      |                    B
 161 //      / 0
 162 //
 163 // and B is the a parameter defined by the shaping time (fShapingTime).
 164 //
 165 // Solving the above equation, for A gives
 166 //
 167 //                 B
 168 //      A = ----------------
 169 //          -1 + B + exp(-B)
 170 //
 171 // So, if we define the function g: [0,1] -> [0:1] by
 172 //
 173 //               / v
 174 //               |              Bu + exp(-Bu) - Bv - exp(-Bv)
 175 //      g(u,v) = | f(x) dx = -A -----------------------------
 176 //               |                            B
 177 //               / u
 178 //
 179 // we can evaluate the ALTRO sample of the VA1_ALICE pre-amp between
 180 // any two times (u, v), by
 181 //
 182 //
 183 //                                B         Bu + exp(-Bu) - Bv - exp(-Bv)
 184 //      C = Q g(u,v) = - Q ---------------- -----------------------------
 185 //                         -1 + B + exp(-B)              B
 186 //
 187 //               Bu + exp(-Bu) - Bv - exp(-Bv)
 188 //        = -  Q -----------------------------
 189 //                    -1 + B + exp(-B)
 190 //
 191
 192 #include <TTree.h>              // ROOT_TTree
 193 #include "AliFMDDebug.h"        // Better debug macros
 194 #include "AliFMDHitDigitizer.h" // ALIFMDDIGITIZER_H
 195 #include "AliFMD.h"             // ALIFMD_H
 196 #include "AliFMDDigit.h"        // ALIFMDDIGIT_H
 197 #include "AliFMDParameters.h"   // ALIFMDPARAMETERS_H
 198 #include <AliRun.h>             // ALIRUN_H
 199 #include <AliLoader.h>          // ALILOADER_H
 200 #include <AliRunLoader.h>       // ALIRUNLOADER_H
 201 #include <AliFMDHit.h>
 202 #include <AliStack.h>
 203 #include <TFile.h>
 204 #include <TParticle.h>
 205
 206 //====================================================================
 207 ClassImp(AliFMDHitDigitizer)
 208 #if 0
 209 ;
 210 #endif
 211
 212 //____________________________________________________________________
 213 AliFMDHitDigitizer::AliFMDHitDigitizer(AliFMD* fmd, Output_t  output)
 214   : AliFMDBaseDigitizer("FMD", (output == kDigits ?
 215                                 "FMD Hit->Digit digitizer" :
 216                                 "FMD Hit->SDigit digitizer")),
 217     fOutput(output),
 218     fHoldTime(2e-6),
 219     fStack(0)
 220 {
 221   fFMD = fmd;
 222 }
 223
 224 //____________________________________________________________________
 225 AliFMDHitDigitizer&
 226 AliFMDHitDigitizer::operator=(const AliFMDHitDigitizer& o)
 227 {
 228   /**
 229    * Assignment operator
 230    *
 231    * @param o Object to assign from
 232    * @return Reference to this
 233    */
 234   AliFMDBaseDigitizer::operator=(o);
 235   fHoldTime    = o.fHoldTime;
 236   fOutput      = o.fOutput;
 237   fStack       = o.fStack;
 238   return *this;
 239 }
 240
 241 //____________________________________________________________________
 242 void
 243 AliFMDHitDigitizer::Exec(Option_t* /*option*/)
 244 {
 245   // Run this digitizer
 246   // Get an inititialize parameter manager
 247   AliFMDParameters::Instance()->Init();
 248   if (AliLog::GetDebugLevel("FMD","") >= 10)
 249     AliFMDParameters::Instance()->Print("ALL");
 250
 251   // Get loader, and ask it to read in the hits
 252   AliLoader* loader = fFMD->GetLoader();
 253   if (!loader) {
 254     AliError("Failed to get loader from detector object");
 255     return;
 256   }
 257   loader->LoadHits("READ");
 258
 259   // Get the run loader
 260   AliRunLoader* runLoader = loader->GetRunLoader();
 261   if (!runLoader) {
 262     AliError("Failed to get run loader from loader");
 263     return;
 264   }
 265
 266   // Now loop over events
 267   Int_t nEvents = runLoader->GetNumberOfEvents();
 268   for (Int_t event = 0; event < nEvents; event++) {
 269     // Get the current event folder.
 270     TFolder* folder = loader->GetEventFolder();
 271     if (!folder) {
 272       AliError("Failed to get event folder from loader");
 273       return;
 274     }
 275
 276     // Get the run-loader of this event.
 277     const char* loaderName = AliRunLoader::GetRunLoaderName();
 278     AliRunLoader* thisLoader =
 279       static_cast<AliRunLoader*>(folder->FindObject(loaderName));
 280     if (!thisLoader) {
 281       AliError(Form("Failed to get loader '%s' from event folder", loaderName));
 282       return;
 283     }
 284
 285     // Read in the event
 286     AliFMDDebug(1, ("Now digitizing (Hits->%s) event # %d",
 287                     (fOutput == kDigits ? "digits" : "sdigits"), event));
 288     thisLoader->GetEvent(event);
 289
 290     // Load kinematics to get primary information for SDigits
 291     fStack = 0;
 292     if (fOutput == kSDigits) {
 293       if (thisLoader->LoadKinematics("READ")) {
 294         AliError("Failed to get kinematics from event loader");
 295         return;
 296       }
 297       AliFMDDebug(5, ("Loading stack of kinematics"));
 298       fStack = thisLoader->Stack();
 299     }
 300
 301     // Check that we have the hits
 302     if (!loader->TreeH() && loader->LoadHits()) {
 303       AliError("Failed to load hits");
 304       return;
 305     }
 306     TTree*   hitsTree = loader->TreeH();
 307     TBranch* hitsBranch = hitsTree->GetBranch(fFMD->GetName());
 308     if (!hitsBranch) {
 309       AliError("Failed to get hits branch in tree");
 310       return;
 311     }
 312     // Check that we can make the output digits - This must come
 313     // before AliFMD::SetBranchAddress
 314     TTree* outTree = MakeOutputTree(loader);
 315     if (!outTree) {
 316       AliError("Failed to get output tree");
 317       return;
 318     }
 319     AliFMDDebug(5, ("Output tree name for %s is '%s'",
 320                     (fOutput == kDigits ? "digits" : "sdigits"),
 321                     outTree->GetName()));
 322     if (AliLog::GetDebugLevel("FMD","") >= 5) {
 323       TFile* file = outTree->GetCurrentFile();
 324       if (!file) {
 325         AliWarning("Output tree has no file!");
 326       }
 327       else {
 328         AliFMDDebug(5, ("Output tree file %s content:", file->GetName()));
 329         file->ls();
 330       }
 331     }
 332
 333     // Set-up the branch addresses
 334     fFMD->SetTreeAddress();
 335
 336     // Now sum all contributions in cache
 337     SumContributions(hitsBranch);
 338     loader->UnloadHits();
 339
 340     // And now digitize the hits
 341     DigitizeHits();
 342
 343     // Write digits to tree
 344     Int_t write = outTree->Fill();
 345     AliFMDDebug(5, ("Wrote %d bytes to digit tree", write));
 346
 347     // Store the digits
 348     StoreDigits(loader);
 349
 350   }
 351 }
 352
 353 //____________________________________________________________________
 354 TTree*
 355 AliFMDHitDigitizer::MakeOutputTree(AliLoader* loader)
 356 {
 357   /**
 358    * Make the output tree using the passed loader
 359    *
 360    * @param loader
 361    * @return The generated tree.
 362    */
 363   if (fOutput == kDigits)
 364     return AliFMDBaseDigitizer::MakeOutputTree(loader);
 365
 366   AliFMDDebug(5, ("Making sdigits tree"));
 367   loader->LoadSDigits("UPDATE"); // RECREATE");
 368   TTree* out = loader->TreeS();
 369   if (!out) loader->MakeTree("S");
 370   out = loader->TreeS();
 371   if (out) {
 372     out->Reset();
 373     fFMD->MakeBranch("S");
 374   }
 375   return out;
 376 }
 377
 378
 379 //____________________________________________________________________
 380 void
 381 AliFMDHitDigitizer::SumContributions(TBranch* hitsBranch)
 382 {
 383   // Sum energy deposited contributions from each hit in a cache
 384   // (fEdep).
 385
 386   // Clear array of deposited energies
 387   fEdep.Reset();
 388
 389   // Get a list of hits from the FMD manager
 390   AliFMDDebug(5, ("Get array of FMD hits"));
 391   TClonesArray *fmdHits = fFMD->Hits();
 392
 393
 394   // Get number of entries in the tree
 395   AliFMDDebug(5, ("Get # of tracks"));
 396   Int_t ntracks  = Int_t(hitsBranch->GetEntries());
 397   AliFMDDebug(5, ("We got %d tracks", ntracks));
 398
 399   Int_t read = 0;
 400   // Loop over the tracks in the
 401   for (Int_t track = 0; track < ntracks; track++)  {
 402     // Read in entry number `track'
 403     read += hitsBranch->GetEntry(track);
 404
 405     // Get the number of hits
 406     Int_t nhits = fmdHits->GetEntries ();
 407     for (Int_t hit = 0; hit < nhits; hit++) {
 408       // Get the hit number `hit'
 409       AliFMDHit* fmdHit =
 410         static_cast<AliFMDHit*>(fmdHits->UncheckedAt(hit));
 411
 412       // Ignore hits that arrive too late
 413       if (fmdHit->Time() > fHoldTime) continue;
 414
 415
 416       // Check if this is a primary particle
 417       Bool_t isPrimary = kTRUE;
 418       Int_t  trackno   = -1;
 419       if (fStack) {
 420         trackno = fmdHit->Track();
 421         AliFMDDebug(10, ("Will get track # %d/%d from entry # %d",
 422                         trackno, fStack->GetNtrack(), track));
 423         if (fStack->GetNtrack() < trackno) {
 424           AliError(Form("Track number %d/%d out of bounds",
 425                         trackno, fStack->GetNtrack()));
 426           continue;
 427         }
 428 #if 1
 429         isPrimary = fStack->IsPhysicalPrimary(trackno);
 430 #else // This is our hand-crafted code.  We use the ALICE definition
 431         TParticle* part    = fStack->Particle(trackno);
 432         isPrimary          = part->IsPrimary();
 433         if (!isPrimary) {
 434           // Extended testing of mother status - this is for Pythia6.
 435           Int_t      mother1   = part->GetFirstMother();
 436           TParticle* mother    = fStack->Particle(mother1);
 437           if (!mother || mother->GetStatusCode() > 1)
 438             isPrimary = kTRUE;
 439           AliFMDDebug(15,
 440                       ("Track %d secondary, mother: %d - %s - status %d: %s",
 441                        trackno, mother1,
 442                        (mother ? "found"                 : "not found"),
 443                        (mother ? mother->GetStatusCode() : -1),
 444                        (isPrimary ? "primary" : "secondary")));
 445         }
 446 #endif
 447       }
 448
 449       // Extract parameters
 450       AliFMDDebug(15,("Adding contribution %7.5f for FMD%d%c[%2d,%3d] "
 451                       " for trackno %6d (%s)",
 452                       fmdHit->Edep(),
 453                       fmdHit->Detector(),
 454                       fmdHit->Ring(),
 455                       fmdHit->Sector(),
 456                       fmdHit->Strip(),
 457                       trackno,
 458                       (isPrimary ? "primary" : "secondary")));
 459       AddContribution(fmdHit->Detector(),
 460                       fmdHit->Ring(),
 461                       fmdHit->Sector(),
 462                       fmdHit->Strip(),
 463                       fmdHit->Edep(),
 464                       isPrimary,
 465                       1,
 466                       &trackno);
 467     }  // hit loop
 468   } // track loop
 469   AliFMDDebug(5, ("Size of cache: %d bytes, read %d bytes",
 470                   int(sizeof(fEdep)), read));
 471 }
 472
 473
 474 //____________________________________________________________________
 475 UShort_t
 476 AliFMDHitDigitizer::MakePedestal(UShort_t  detector,
 477                                  Char_t    ring,
 478                                  UShort_t  sector,
 479                                  UShort_t  strip) const
 480 {
 481   // Make a pedestal
 482   if (fOutput == kSDigits) return 0;
 483   return AliFMDBaseDigitizer::MakePedestal(detector, ring, sector, strip);
 484 }
 485
 486
 487
 488 //____________________________________________________________________
 489 void
 490 AliFMDHitDigitizer::AddDigit(UShort_t        detector,
 491                              Char_t          ring,
 492                              UShort_t        sector,
 493                              UShort_t        strip,
 494                              Float_t         edep,
 495                              UShort_t        count1,
 496                              Short_t         count2,
 497                              Short_t         count3,
 498                              Short_t         count4,
 499                              UShort_t        ntotal,
 500                              UShort_t        nprim,
 501                              const TArrayI&  refs) const
 502 {
 503   // Add a digit or summable digit
 504   if (fOutput == kDigits) {
 505     AliFMDDebug(15,("Adding digit for FMD%d%c[%2d,%3d] = (%x,%x,%x,%x)",
 506                     detector, ring, sector, strip,
 507                     count1, count2, count3, count4));
 508     AliFMDBaseDigitizer::AddDigit(detector, ring, sector, strip, 0,
 509                                   count1, count2, count3, count4,
 510                                   ntotal, nprim, refs);
 511     return;
 512   }
 513   if (edep <= 0) {
 514     AliFMDDebug(15, ("Digit edep = %f <= 0 for FMD%d%c[%2d,%3d]",
 515                     edep, detector, ring, sector, strip));
 516     return;
 517   }
 518   if (count1 == 0 && count2 <= 0 && count3 <= 0 && count4 <= 0) {
 519     AliFMDDebug(15, ("Digit counts = (%x,%x,%x,%x) <= 0 for FMD%d%c[%2d,%3d]",
 520                     count1, count2, count3, count4,
 521                     detector, ring, sector, strip));
 522     return;
 523   }
 524   AliFMDDebug(15, ("Adding sdigit for FMD%d%c[%2d,%3d] = "
 525                    "(%x,%x,%x,%x) [%d/%d] %d",
 526                    detector, ring, sector, strip,
 527                    count1, count2, count3, count4, nprim, ntotal, refs.fN));
 528   fFMD->AddSDigitByFields(detector, ring, sector, strip, edep,
 529                           count1, count2, count3, count4,
 530                           ntotal, nprim, fStoreTrackRefs ? refs.fArray : 0);
 531   if (fStoreTrackRefs && nprim > 3) fIgnoredLabels += nprim - 3;
 532 }
 533
 534 //____________________________________________________________________
 535 void
 536 AliFMDHitDigitizer::CheckDigit(AliFMDDigit*    digit,
 537                                UShort_t        nhits,
 538                                const TArrayI&  counts)
 539 {
 540   // Check that digit is consistent
 541   AliFMDParameters* param = AliFMDParameters::Instance();
 542   UShort_t          det   = digit->Detector();
 543   Char_t            ring  = digit->Ring();
 544   UShort_t          sec   = digit->Sector();
 545   UShort_t          str   = digit->Strip();
 546   Float_t           mean  = param->GetPedestal(det,ring,sec,str);
 547   Float_t           width = param->GetPedestalWidth(det,ring,sec,str);
 548   UShort_t          range = param->GetVA1MipRange();
 549   UShort_t          size  = param->GetAltroChannelSize();
 550   Int_t             integral = counts[0];
 551   if (counts[1] >= 0) integral += counts[1];
 552   if (counts[2] >= 0) integral += counts[2];
 553   if (counts[3] >= 0) integral += counts[3];
 554   integral -= Int_t(mean + 2 * width);
 555   if (integral < 0) integral = 0;
 556
 557   Float_t convF = Float_t(range) / size;
 558   Float_t mips  = integral * convF;
 559   if (mips > Float_t(nhits) + .5 || mips < Float_t(nhits) - .5)
 560     Warning("CheckDigit", "Digit -> %4.2f MIPS != %d +/- .5 hits",
 561             mips, nhits);
 562 }
 563
 564 //____________________________________________________________________
 565 void
 566 AliFMDHitDigitizer::StoreDigits(const AliLoader* loader)
 567 {
 568   /**
 569    * Store the data using the loader
 570    *
 571    * @param loader The loader
 572    */
 573   if (fOutput == kDigits) {
 574     AliFMDBaseDigitizer::StoreDigits(loader);
 575     return;
 576   }
 577   AliFMDDebug(5, ("Storing %d sdigits",   fFMD->SDigits()->GetEntries()));
 578   // Write the digits to disk
 579   loader->WriteSDigits("OVERWRITE");
 580   loader->UnloadSDigits();
 581   // Reset the digits in the AliFMD object
 582   fFMD->ResetSDigits();
 583 }
 584
 585
 586 //____________________________________________________________________
 587 //
 588 // EOF
 589 //
 590
 591
 592
 593