New analysis modules

[u/mrichter/AliRoot.git] / ITS / AliITSClusterFinder.h

#ifndef ALIITSCLUSTERFINDER_H
#define ALIITSCLUSTERFINDER_H
 
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */
 
/* $Id$ */

////////////////////////////////////////////////
//  ITS Cluster Finder Class                  //
//                                            //
//                                            //
////////////////////////////////////////////////

#include <TObject.h>
#include <TClonesArray.h>
#include "AliLog.h"

class AliITSMap;
class AliITSresponse;
class AliITSsegmentation;
class AliITSdigit;
class AliITSRecPoint;
class AliITSDetTypeRec;
class AliRawReader;
class TArrayI;

//----------------------------------------------------------------------
class AliITSClusterFinder :public TObject{
  public:
    AliITSClusterFinder(); // Default constructor
    // Standard Constructor
    AliITSClusterFinder(AliITSDetTypeRec* dettyp);
    AliITSClusterFinder(AliITSDetTypeRec* dettyp,TClonesArray *digits);// Standard+ Constructor
    virtual ~AliITSClusterFinder(); // Destructor
    //
    // Do the Reconstruction.
    virtual void FindRawClusters(Int_t /*mod*/)=0; // Finds cluster of digits.
    virtual void RawdataToClusters(AliRawReader* /*rawReader*/) {
      AliError("Method not implemented in this class ");
    }

    // Digit
    virtual void SetDigits(TClonesArray *itsDigits) {// set digits
        fDigits=itsDigits;fNdigits = fDigits->GetEntriesFast();}
    virtual AliITSdigit* GetDigit(Int_t i){ // Returns ith digit
        return (AliITSdigit*) fDigits->UncheckedAt(i);}
    virtual TClonesArray* Digits(){return fDigits;}// Gets fDigits
    virtual Int_t   NDigits() const {return fNdigits;}// Get Number of Digits

    // Set fClusters up
    virtual void SetClusters(TClonesArray *itsClusters){// set clusters
        fClusters = itsClusters;}
    // Get fCluters
    virtual TClonesArray* Clusters(){return fClusters;}
    // Returns the present number of enteries
    virtual Int_t NClusters()const {return fClusters->GetEntriesFast();}

    virtual void SetModule(Int_t module){fModule = module;}// Set module number
    virtual Int_t GetModule()const {return fModule;}// Returns module number

    void SetEvent(Int_t event) { fEvent=event; }

    // Others
    virtual void  SetMap(AliITSMap *m) {fMap=m;}// map
    AliITSMap* Map(){return fMap;}// map
    virtual Int_t GetNPeaks() const {return fNPeaks;}// returns fNPeaks
    //
    virtual Bool_t IsNeighbor(TObjArray *digs,Int_t i,Int_t j[]) const;
        // Set max. cluster size ; bigger clusters will be rejected

    // IO functions
    void Print(ostream *os) const; // Class ascii print function
    void Read(istream *os);  // Class ascii read function
    virtual void Print(Option_t *option="") const {TObject::Print(option);}
    virtual Int_t Read(const char *name) {return TObject::Read(name);}

    virtual void SetDetTypeRec(AliITSDetTypeRec* dtr) {fDetTypeRec=dtr;}
    AliITSDetTypeRec* GetDetTypeRec() const {return fDetTypeRec;}

    void InitGeometry(); 
    //
    Int_t    GetNClusters()                               const {return fNClusters;}
    void     SetRawID2ClusID(TArrayI *arr)                      {fRawID2ClusID = arr;} 
    TArrayI* GetRawID2ClusID()                            const {return fRawID2ClusID;} 
    // 
  protected:
  class Ali1Dcluster {
  public:
    void SetY(Float_t y) {fY=y;}
    void SetQ(Float_t q) {fQ=q;}
    void SetNd(Int_t n)  {fNd=n;}
    void SetLabels(Int_t *lab) {fLab[0]=lab[0];fLab[1]=lab[1];fLab[2]=lab[2];}
    Float_t GetY() const {return fY;}
    Float_t GetQ() const {return fQ;}
    Int_t GetNd()const {return fNd;}
    Int_t GetLabel(Int_t lab) const { return fLab[lab]; }
  protected:
    Float_t fY; //cluster position
    Float_t fQ; //cluster charge
    Int_t fNd;  //number of digits
    Int_t fLab[3]; //track label
  };
  class AliBin {
  public:
  AliBin():fIndex(0),fMask(0xFFFFFFFE),fRawID(-1),fQ(0){}
    void SetIndex(UInt_t idx) {fIndex=idx;}
    void SetQ(UShort_t q)  {fQ=q;}
    void SetMask(UInt_t m) {fMask=m;}
    void SetRawID(Int_t id) {fRawID=id;}
    void Reset() {fIndex=0; fMask=0xFFFFFFFE; fQ=0; fRawID=-1;}

    void Use() {fMask&=0xFFFFFFFE;}
    Bool_t IsNotUsed() const {return (fMask&1);}
    Bool_t IsUsed() const {return !(IsNotUsed());}

    UInt_t   GetIndex() const {return fIndex;}
    UShort_t GetQ()     const {return fQ;}
    UInt_t   GetMask()  const {return fMask;}
    Int_t    GetRawID() const {return fRawID;}
  protected:
    UInt_t fIndex; //digit index
    UInt_t fMask; //peak mask
    Int_t  fRawID; // ID of raw word (used for embedding)
    UShort_t fQ;  //signal
  };
  void MakeCluster(Int_t k,Int_t max,AliBin *bins,UInt_t m,AliITSRecPoint &c);
  static Bool_t IsMaximum(Int_t k, Int_t max, const AliBin *bins);
  static void FindPeaks(Int_t k,Int_t m,AliBin*b,Int_t*idx,UInt_t*msk,Int_t&n);
  static void MarkPeak(Int_t k, Int_t max, AliBin *bins, UInt_t m);
  static void FindCluster(Int_t k,Int_t maxz,AliBin *bins,Int_t &n,Int_t *idx);

  static void CheckLabels2(Int_t lab[10]);
  static void AddLabel(Int_t lab[10], Int_t label);      

  // data members      

  Int_t              fModule;        //! Module number to be reconstuctted
  TClonesArray       *fDigits;       //! digits 
  Int_t              fNdigits;       //! num of digits 
  
  AliITSDetTypeRec* fDetTypeRec; //ITS object for reconstruction
  TClonesArray       *fClusters;     //! Array of clusters
  AliITSMap          *fMap;          //! map
  Int_t              fNPeaks;        //! NPeaks  
  // Data members needed to fill AliCluster objects
  Int_t fNdet[2200];           // detector index  
  Int_t fNlayer[2200];         // detector layer
  
  Int_t fNModules;             // total number of modules    
  Int_t fEvent;                //event number
  Int_t fZmin;   // minimum channel in Zloc
  Int_t fZmax;   // maximum channel in Zloc
  Int_t fXmin;   // minimum channel in Xloc
  Int_t fXmax;   // maximum channel in Xloc 
  //
  UInt_t fNClusters; // total number of clusters found
  //
  TArrayI* fRawID2ClusID;        //! optional array to store raw word ID -> ClusID for embedding (not owned)
  
  AliITSClusterFinder(const AliITSClusterFinder &source); // copy constructor
  // assignment operator
  AliITSClusterFinder& operator=(const AliITSClusterFinder &source);
  

  ClassDef(AliITSClusterFinder,11) //Class for clustering and reconstruction of space points
};
// Input and output functions for standard C++ input/output.
ostream &operator<<(ostream &os,AliITSClusterFinder &source);
istream &operator>>(istream &os,AliITSClusterFinder &source);
#endif