FMD/AliFMDBaseDigit.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    AliFMDBaseDigit.cxx
  17     @author  Christian Holm Christensen <cholm@nbi.dk>
  18     @date    Mon Mar 27 12:37:41 2006
  19     @brief   Digits for the FMD
  20     @ingroup FMD_base
  21 */
  22 //////////////////////////////////////////////////////////////////////
  23 //
  24 //  Digits classes for the FMD
  25 //
  26 //  Digits consists of
  27 //   - Detector #
  28 //   - Ring ID
  29 //   - Sector #
  30 //   - Strip #
  31 //   - ADC count in this channel
  32 //
  33 //  Digits consists of
  34 //   - Detector #
  35 //   - Ring ID
  36 //   - Sector #
  37 //   - Strip #
  38 //   - Total energy deposited in the strip
  39 //   - ADC count in this channel
  40 //
  41 // As the Digits and SDigits have so much in common, the classes
  42 // AliFMDDigit and AliFMDSDigit are implemented via a base
  43 // class AliFMDBaseDigit.
  44 ///
  45 //              +-----------------+
  46 //              | AliFMDBaseDigit |
  47 //              +-----------------+
  48 //                      ^
  49 //                      |
  50 //                +------------+
  51 //                |            |
  52 //      +-------------+ +--------------+
  53 //      | AliFMDDigit | | AliFMDSDigit |
  54 //      +-------------+ +--------------+
  55 //
  56 // (Note, that I'd really would have liked to implement AliFMDHit as a
  57 // derived class from some base class - say AliFMDStrip, and the Digit
  58 // classes would (eventually) have derived from that as well.
  59 // However, ROOT doesn't do well with multiple inheritance, so I chose
  60 // not to anyway).
  61 //
  62 // Latest changes by Christian Holm Christensen
  63 //
  64 //////////////////////////////////////////////////////////////////////
  65
  66 #include "AliFMDBaseDigit.h"    // ALIFMDDIGIT_H
  67 #include "Riostream.h"          // ROOT_Riostream
  68 #include <TString.h>
  69 #include <AliLog.h>
  70
  71 //====================================================================
  72 ClassImp(AliFMDBaseDigit)
  73 #if 0
  74   ; // This is here to keep Emacs from indenting the next line
  75 #endif
  76
  77 //____________________________________________________________________
  78 AliFMDBaseDigit::AliFMDBaseDigit()
  79   : fDetector(0),
  80     fRing('\0'),
  81     fSector(0),
  82     fStrip(0),
  83     fName("")
  84 {}
  85
  86 //____________________________________________________________________
  87 AliFMDBaseDigit::AliFMDBaseDigit(UShort_t detector,
  88                                  Char_t   ring,
  89                                  UShort_t sector,
  90                                  UShort_t strip)
  91   : fDetector(detector),
  92     fRing(ring),
  93     fSector(sector),
  94     fStrip(strip),
  95     fName("")
  96 {
  97   //
  98   // Creates a base data digit object
  99   //
 100   // Parameters
 101   //
 102   //    detector  Detector # (1, 2, or 3)
 103   //    ring      Ring ID ('I' or 'O')
 104   //    sector    Sector # (For inner/outer rings: 0-19/0-39)
 105   //    strip     Strip # (For inner/outer rings: 0-511/0-255)
 106 }
 107
 108 //____________________________________________________________________
 109 void
 110 AliFMDBaseDigit::Print(Option_t* /* option*/) const
 111 {
 112   // Print digit to standard out
 113   cout << ClassName() << ": FMD" << GetName() << flush;
 114 }
 115
 116 //____________________________________________________________________
 117 const char*
 118 AliFMDBaseDigit::GetName() const
 119 {
 120   // Get the name of a FMD digit.
 121   if (fName.IsNull())
 122     fName = Form("FMD%d%c[%2d,%3d]", fDetector, fRing, fSector, fStrip);
 123   return fName.Data();
 124 }
 125 #define fMaxStrips  512
 126 #define fMaxSectors 40
 127 #define fMaxRings   2
 128
 129 //____________________________________________________________________
 130 ULong_t
 131 AliFMDBaseDigit::Hash() const
 132 {
 133   // Calculate a hash value based on the detector coordinates.
 134   size_t ringi = (fRing == 'I' ||  fRing == 'i' ? 0 : 1);
 135   return fStrip + fMaxStrips *
 136     (fSector + fMaxSectors * (ringi + fMaxRings * (fDetector - 1)));
 137 }
 138
 139
 140 //____________________________________________________________________
 141 Int_t
 142 AliFMDBaseDigit::Compare(const TObject* o) const
 143 {
 144   // Compare to other digit.  If the passed pointer to TObject does
 145   // not point to an object of class AliFMDBaseDigit (or one of it's
 146   // derived classes), then a fatal exception is made.
 147   //
 148   // Returns -1, if this object's detector coordinates are smaller
 149   // than passed object's detector coordinates.
 150   //
 151   // Returns  0, if this object's detector coordinates is the same as
 152   // passed object's detector coordinates.
 153   //
 154   // Returns  1, if this object's detector coordinates are larger
 155   // than passed object's detector coordinates.
 156   if (!o)
 157     AliFatal("Can not compare to NULL!");
 158   if (o->IsA() != AliFMDBaseDigit::Class())
 159     AliFatal(Form("Cannot compare to a %s object", o->ClassName()));
 160   // AliFMDBaseDigit* of = static_cast<AliFMDBaseDigit*>(o);
 161   if (Hash() == o->Hash()) return 0;
 162   if (Hash() < o->Hash()) return -1;
 163   return 1;
 164 }
 165
 166
 167 //____________________________________________________________________
 168 //
 169 // EOF
 170 //