]> git.uio.no Git - u/mrichter/AliRoot.git/blobdiff - MUON/AliMUONRawCluster.h
Updated list of MUON libraries
[u/mrichter/AliRoot.git] / MUON / AliMUONRawCluster.h
index 36a13803fba06274604bbdc0702e05322d6d2b8d..1431fe65a81ef5eb2fcca385f7de899b36c0d448 100644 (file)
@@ -7,9 +7,13 @@
 /* $Id$ */
 // Revision of includes 07/05/2004
 
-// Class for the MUON RecPoint
-// It contains the propeorties of the physics cluters found in the tracking chambers
-// RawCluster contains also the information from the both cathode of the chambers.
+/// \ingroup base
+/// \class AliMUONRawCluster
+/// \brief MUON raw cluster
+///
+/// Class for the MUON RecPoint
+/// It contains the properties of the physics cluters found in the tracking chambers
+/// RawCluster contains also the information from the both cathode of the chambers.
 
 
 #include <TObject.h>
@@ -19,44 +23,51 @@ class AliMUONRawCluster : public TObject {
 
 public:
    AliMUONRawCluster();
-   virtual ~AliMUONRawCluster() { }
+   virtual ~AliMUONRawCluster();
+   
+   /// Return radius
    Float_t      GetRadius(Int_t i) {return TMath::Sqrt(fX[i]*fX[i]+fY[i]*fY[i]);}
+   /// Return true as the function Compare() is implemented
    Bool_t       IsSortable() const {return kTRUE;}
    Int_t        Compare(const TObject *obj) const;
    Int_t        PhysicsContribution() const;
+   virtual void Print(Option_t* opt="") const;
    static Int_t BinarySearch(Float_t r, TArrayF ccord, Int_t from, Int_t upto);
    static void  SortMin(Int_t *idx,Float_t *xdarray, Float_t *xarray, Float_t *yarray, Float_t *qarray,Int_t ntr);
    void         DumpIndex();
 
-   Int_t        AddCharge(Int_t i, Int_t Q);
+   Int_t        AddCharge(Int_t i, Float_t Q);
    Int_t        AddX(Int_t i, Float_t X);
    Int_t        AddY(Int_t i, Float_t Y);
    Int_t        AddZ(Int_t i, Float_t Z);
 
-   Int_t        GetCharge(Int_t i) const;
-   Float_t      GetX(Int_t i) const;
-   Float_t      GetY(Int_t i) const;
-   Float_t      GetZ(Int_t i) const;
-   Int_t        GetTrack(Int_t i) const;
-   Int_t        GetPeakSignal(Int_t i) const;
-   Int_t        GetMultiplicity(Int_t i) const;
+   Float_t        GetCharge(Int_t i=0) const;
+   Float_t      GetX(Int_t i=0) const;
+   Float_t      GetY(Int_t i=0) const;
+   Float_t      GetZ(Int_t i=0) const;
+   Int_t        GetTrack(Int_t i=0) const;
+   Float_t        GetPeakSignal(Int_t i=0) const;
+   Int_t        GetMultiplicity(Int_t i=0) const;
    Int_t        GetClusterType() const;
    Int_t        GetGhost() const;
-   Int_t        GetNcluster(Int_t i) const;
-   Float_t      GetChi2(Int_t i) const;
+   Int_t        GetNcluster(Int_t i=0) const;
+   Float_t      GetChi2(Int_t i=0) const;
    Int_t        GetIndex(Int_t i, Int_t j) const;
    Int_t        GetOffset(Int_t i, Int_t j) const;
    Float_t      GetContrib(Int_t i, Int_t j) const;
    Int_t        GetPhysics(Int_t i) const;
    Int_t        GetDetElemId() const ; 
+   Float_t      GetError(Int_t iXY) const;
+   Float_t      GetErrX() const;
+   Float_t      GetErrY() const;
 
-   Int_t        SetCharge(Int_t i,Int_t Q);
+   Int_t        SetCharge(Int_t i, Float_t Q);
    Int_t        SetX(Int_t i, Float_t X);
    Int_t        SetY(Int_t i, Float_t Y);
    Int_t        SetZ(Int_t i, Float_t Z);
    void         SetDetElemId(Int_t Id); 
    Int_t        SetTrack(Int_t i, Int_t track);
-   Int_t        SetPeakSignal(Int_t i, Int_t peaksignal);
+   Int_t        SetPeakSignal(Int_t i, Float_t peaksignal);
    Int_t        SetMultiplicity(Int_t i, Int_t mul);
    Int_t        SetClusterType(Int_t type);
    Int_t        SetGhost(Int_t ghost);
@@ -66,63 +77,103 @@ public:
    void         SetOffset(Int_t i, Int_t j, Int_t offset);
    void         SetContrib(Int_t i, Int_t j, Float_t contrib);
    void         SetPhysics(Int_t i, Int_t physics);
+   void         SetError(Int_t iXY, Float_t err);
+   void         SetErrX(Float_t err);
+   void         SetErrY(Float_t err);
 
 private:
-   Int_t       fIndexMap[50][2];  // indeces of digits
-   Int_t       fOffsetMap[50][2]; // Emmanuel special
-   Float_t     fContMap[50][2];   // Contribution from digit
-   Int_t       fPhysicsMap[50];   // Distinguish signal and background contr.
+   Int_t       fIndexMap[50][2];  ///< Indices of digits
+   Int_t       fOffsetMap[50][2]; ///< Emmanuel special
+   Float_t     fContMap[50][2];   ///< Contribution from digit
+   Int_t     fPhysicsMap[50];   ///< Distinguish signal and background contr.
   
-   Int_t       fQ[2]  ;           // Q of cluster (in ADC counts)     
-   Float_t     fX[2]  ;           // X of cluster
-   Float_t     fY[2]  ;           // Y of cluster
-   Float_t     fZ[2]  ;           // Z of cluster
-   Int_t       fTracks[3];        //labels of overlapped tracks
-   Int_t       fPeakSignal[2];    // Peak signal 
-   Int_t       fMultiplicity[2];  // Cluster multiplicity
-   Int_t       fClusterType;      // Cluster type
-   Int_t       fGhost;            // 0 if not a ghost or ghost problem solved
+   Float_t     fQ[2]  ;           ///< Q of cluster (in ADC counts)     
+   Float_t     fX[2]  ;           ///< X of cluster
+   Float_t     fY[2]  ;           ///< Y of cluster
+   Float_t     fZ[2]  ;           ///< Z of cluster
+   Int_t       fTracks[3];        ///< Labels of overlapped tracks
+   Float_t     fPeakSignal[2];    ///< Peak signal 
+   Int_t       fMultiplicity[2];  ///< Cluster multiplicity
+   Int_t       fClusterType;      ///< Cluster type
+   Int_t       fGhost;            ///< Ghost info
+                                  // 0 if not a ghost or ghost problem solved
                                   // >0 if ghost problem remains because
                                   // 1 both (true and ghost) satify 
                                   //   charge chi2 compatibility
                                   // 2 none give satisfactory chi2
-   Int_t       fNcluster[2];      // Number of clusters
-   Float_t     fChi2[2];          // Chi**2 of fit
-   Int_t       fDetElemId;        // ID number of the detection element (slat) on which the cluster is found. 
-   ClassDef(AliMUONRawCluster,1)  //Cluster class for MUON
+   Int_t       fNcluster[2];      ///< Number of clusters
+   Float_t     fChi2[2];          ///< Chi**2 of fit
+   Int_t       fDetElemId;        ///< ID number of the detection element (slat) on which the cluster is found. 
+   Float_t     fErrXY[2];         ///< coordinate errors
+   ClassDef(AliMUONRawCluster,2)  //Cluster class for MUON
 };
 
 // inline functions
 
+/// Return Indices of digits
 inline  Int_t  AliMUONRawCluster::GetIndex(Int_t i, Int_t j) const
 { return fIndexMap[i][j]; }
 
+/// Return Emmanuel special offset map
 inline  Int_t  AliMUONRawCluster::GetOffset(Int_t i, Int_t j) const
 { return fOffsetMap[i][j]; }
 
+/// Return Contribution from digit
 inline  Float_t  AliMUONRawCluster::GetContrib(Int_t i, Int_t j) const
 { return fContMap[i][j]; }
 
+/// Return Distinguish signal and background contr.
 inline  Int_t  AliMUONRawCluster::GetPhysics(Int_t i) const
 { return fPhysicsMap[i]; }
 
+/// Set Indices of digits
 inline  void  AliMUONRawCluster::SetIndex(Int_t i, Int_t j, Int_t index)
 { fIndexMap[i][j] = index; }
 
+/// Set Emmanuel special offset map
 inline  void  AliMUONRawCluster::SetOffset(Int_t i, Int_t j, Int_t offset)
 { fOffsetMap[i][j] = offset; }
 
+/// Set Contribution from digit
 inline  void  AliMUONRawCluster::SetContrib(Int_t i, Int_t j, Float_t contrib)
 { fContMap[i][j] = contrib; }
 
+/// Set Distinguish signal and background contr.
 inline  void  AliMUONRawCluster::SetPhysics(Int_t i, Int_t physics)
 { fPhysicsMap[i] = physics; }
 
+/// Set ID number of the detection element (slat) on which the cluster is found.
 inline void AliMUONRawCluster::SetDetElemId(Int_t Id)
 { fDetElemId = Id; }
 
+/// Return ID number of the detection element (slat) on which the cluster is found.
 inline Int_t AliMUONRawCluster::GetDetElemId() const
 { return fDetElemId;}
+
+/// Set coordinate errors
+inline void AliMUONRawCluster::SetError(Int_t iXY, Float_t err)
+{ fErrXY[iXY] = err; }
+
+/// Set x coordinate error
+inline void AliMUONRawCluster::SetErrX(Float_t err)
+{ SetError(0, err); }
+
+/// Set y coordinate error
+inline void AliMUONRawCluster::SetErrY(Float_t err)
+{ SetError(1, err); }
+
+/// Return coordinate errors
+inline Float_t AliMUONRawCluster::GetError(Int_t iXY) const
+{ return fErrXY[iXY]; }
+
+/// Return x coordinate error
+inline Float_t AliMUONRawCluster::GetErrX() const
+{ return GetError(0); }
+
+/// Return y coordinate error
+inline Float_t AliMUONRawCluster::GetErrY() const
+{ return GetError(1); }
+
 #endif