]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - MUON/AliMUONDigit.h
Updated list of MUON libraries
[u/mrichter/AliRoot.git] / MUON / AliMUONDigit.h
index ba7b139a922cc0e9f0828d8c74f55144b52a4e1e..693bf9c98712ab49c7d240be146e9203bc1d314f 100644 (file)
@@ -17,52 +17,53 @@ class AliMUONDigit : public TObject
  public:
     AliMUONDigit();
     AliMUONDigit(const AliMUONDigit& rhs);
-    /// \deprecated
-    AliMUONDigit(Int_t *digits);
-    /// \deprecated
-    AliMUONDigit(Int_t *tracks, Int_t *charges, Int_t *digits);
     virtual ~AliMUONDigit();
 
     AliMUONDigit& operator=(const AliMUONDigit& rhs);
     
-    virtual Bool_t IsSortable() const {return kTRUE;}
-    virtual int Compare(const TObject *obj) const;
+    virtual Bool_t IsSortable() const {return kTRUE;}        ///< Return true if sortable
+    virtual Int_t Compare(const TObject *obj) const;
 
-    virtual Int_t DetElemId()const     {return fDetElemId;}    
-    virtual Int_t PadX() const         {return fPadX;}
-    virtual Int_t PadY() const         {return fPadY;}
-    virtual Int_t Cathode() const      {return fCathode;}
+    virtual Int_t DetElemId()const     {return fDetElemId;}  ///< Return detection element ID  
+    virtual Int_t PadX() const         {return fPadX;}       ///< Return pad number along x
+    virtual Int_t PadY() const         {return fPadY;}       ///< Return pad number along y
+    virtual Int_t Cathode() const      {return fCathode;}    ///< Return cathode number
     
-    virtual Int_t Signal() const       {return fSignal;}
+    virtual Float_t Signal() const     {return fSignal;}     ///< Return signal amplitude
     
-    virtual Int_t Physics() const      {return fPhysics;}
+    virtual Float_t Physics() const    {return fPhysics;}    ///< Return MC physics contribution to signal
     
-    virtual Int_t Hit() const          {return fHit;}  
+    virtual Int_t Hit() const          {return fHit;}        ///< Return MC hit number
     
-    virtual Int_t Ntracks() const { return fNtracks; }
-    virtual void AddTrack(Int_t trackNumber, Int_t trackCharge);
+    virtual Int_t Ntracks() const { return fNtracks; }       ///< Return MC tracks making to this digit
+    virtual void AddTrack(Int_t trackNumber, Float_t trackCharge);
     virtual Int_t Track(Int_t i) const;
-    virtual Int_t TrackCharge(Int_t i) const;
+    virtual Float_t TrackCharge(Int_t i) const;
     
-    virtual Int_t ADC() const { return fADC; }
-    virtual Int_t ManuId() const { return fManuId; }
-    virtual Int_t ManuChannel() const { return fManuChannel; }
+    virtual Int_t ADC() const { return fADC; }                 ///< Return ADC value
+    virtual Int_t ManuId() const { return fManuId; }           ///< Return Id of the MANU chip
+    virtual Int_t ManuChannel() const { return fManuChannel; } ///< Return Channel within the MANU chip
     virtual Bool_t IsSaturated() const;
     virtual Bool_t IsNoiseOnly() const;
+    virtual Bool_t IsEfficiencyApplied() const;
+    virtual UInt_t StatusMap() const { return fStatusMap; }    ///< Return Neighbouring pad status
     
     virtual void NoiseOnly(Bool_t value=kTRUE);
     virtual void Saturated(Bool_t saturated=kTRUE);
+    virtual void EfficiencyApplied(Bool_t value=kTRUE);
+    
     virtual void SetElectronics(Int_t manuId, Int_t manuChannel);
-    virtual void SetADC(Int_t adc) { fADC=adc; }
-    virtual void SetDetElemId(Int_t id)    {fDetElemId = id;}
-    virtual void SetPadX(Int_t pad)        {fPadX = pad;}
-    virtual void SetPadY(Int_t pad)        {fPadY = pad;}
-    virtual void SetSignal(Int_t q)        {fSignal = q;}
-    virtual void AddSignal(Int_t q)        {fSignal += q;}
-    virtual void AddPhysicsSignal(Int_t q) {fPhysics += q;}
-    virtual void SetHit(Int_t n)           {fHit = n;}    
-    virtual void SetCathode(Int_t c)       {fCathode = c;}
-    virtual void SetPhysicsSignal(Int_t q) {fPhysics = q; }
+    virtual void SetADC(Int_t adc)         {fADC=adc; }        ///< Set ADC value
+    virtual void SetDetElemId(Int_t id)    {fDetElemId = id;}  ///< Set detection element ID
+    virtual void SetPadX(Int_t pad)        {fPadX = pad;}      ///< Set pad number along x
+    virtual void SetPadY(Int_t pad)        {fPadY = pad;}      ///< Set pad number along y
+    virtual void SetSignal(Float_t q)        {fSignal = q;}    ///< Set signal amplitude
+    virtual void AddSignal(Float_t q)        {fSignal += q;}   ///< Add signal amplitude
+    virtual void AddPhysicsSignal(Float_t q) {fPhysics += q;}  ///< Add MC physics contribution to signal
+    virtual void SetHit(Int_t n)           {fHit = n;}         ///< Set MC hit number
+    virtual void SetCathode(Int_t c)       {fCathode = c;}     ///< Set cathode number
+    virtual void SetPhysicsSignal(Float_t q) {fPhysics = q; }  ///< Set MC physics contribution to signal
+    virtual void SetStatusMap(UInt_t statusMap) { fStatusMap = statusMap; } ///< Set status map
     
     virtual void Print(Option_t* opt="") const;
     
@@ -74,30 +75,38 @@ class AliMUONDigit : public TObject
       */
     virtual void Clear(Option_t*);
     
-    /// Add mask to the track numbers.
+    // Add mask to the track numbers.
     virtual void PatchTracks(Int_t mask);
     
 private:
-    Int_t fDetElemId;     // Detection element ID
-    Int_t fManuId;        // Id of the MANU chip.
-    Int_t fManuChannel;   // Channel within the MANU chip.
-    Int_t fSignal;        // Signal amplitude    
+    Int_t fDetElemId;     ///< Detection element ID
+    Int_t fManuId;        ///< Id of the MANU chip.
+    Int_t fManuChannel;   ///< Channel within the MANU chip.
+    Float_t fSignal;        ///< Signal amplitude    
       
-    Int_t fPadX;          // Pad number along x
-    Int_t fPadY;          // Pad number along y
-    Int_t fCathode;       // Cathode number
-    Int_t fADC;           // ADC value
-    UInt_t fFlags;        // Special flags (e.g. is the signal an overflow ?)
-    
-    Int_t fNtracks;       // MC tracks making to this digit.
-    Int_t* fTcharges;     //[fNtracks] charges of MC track making this digit
-    Int_t* fTracks;       //[fNtracks] primary MC tracks making this digit
-    Int_t fPhysics;       // MC physics contribution to signal 
-    Int_t fHit;           // MC hit number - temporary solution
+    Int_t fPadX;          ///< Pad number along x
+    Int_t fPadY;          ///< Pad number along y
+    Int_t fCathode;       ///< Cathode number
+    Int_t fADC;           ///< ADC value
+    UInt_t fFlags;        ///< Special flags (e.g. is the signal an overflow ?)
+    
+    Int_t fNtracks;       ///< MC tracks making to this digit.
+    
+    /// charges of MC track making this digit
+    Float_t* fTcharges;     //[fNtracks]  charges of MC track making this digit
+
+    /// primary MC tracks making this digit
+    Int_t* fTracks;       //[fNtracks]  primary MC tracks making this digit
+
+    Float_t fPhysics;       ///< MC physics contribution to signal 
+    Int_t fHit;           ///< MC hit number - temporary solution
   
-    static const UInt_t fgkSaturatedMask = 0x1; // the mask (part of fFlags) to indicate this digit is saturated
-    static const UInt_t fgkNoiseOnlyMask = 0x1000; // indicate a simulated digit due to noise only
+    UInt_t fStatusMap; ///< Neighbouring pad status (whether ped, gains, hv were ok or not)
+    
+    static const UInt_t fgkSaturatedMask = 0x1; ///< the mask (part of fFlags) to indicate this digit is saturated
+    static const UInt_t fgkNoiseOnlyMask = 0x1000; ///< indicate a simulated digit due to noise only
+    static const UInt_t fgkEfficiencyMask = 0x2000; ///< indicate chamber efficiency has been applied to a simulated digit
     
-    ClassDef(AliMUONDigit,4)  //Digits for MUON
+    ClassDef(AliMUONDigit,7)  //Digits for MUON
 };
 #endif