Merge branch 'master' of https://git.cern.ch/reps/AliRoot

[u/mrichter/AliRoot.git] / ITS / UPGRADE / AliITSUClusterizer.h

#ifndef ALIITSUCLUSTERIZER_H\r
#define ALIITSUCLUSTERIZER_H\r
\r
#include <TClonesArray.h>\r
\r
//#define _ClusterTopology_  // uncomment this to produce the tree with cluster topology\r
\r
class TTree;\r
class TObjAray;\r
class AliITSUSegmentationPix;\r
class AliITSdigit;\r
class AliCluster;\r
class AliITSUClusterPix;\r
class AliITSURecoParam;\r
//\r
#ifdef  _ClusterTopology_\r
#include <TBits.h>\r
class TFile;\r
#endif //_ClusterTopology_\r
\r
\r
class AliITSUClusterizer : public TObject \r
{\r
  //\r
 public:\r
  enum {kDigitChunkSize=1024, kMaxLabels=20,kMaxLabInCluster=3};\r
  //\r
  AliITSUClusterizer(Int_t nrowInit=0);\r
  virtual ~AliITSUClusterizer();\r
  void SetRawData(Bool_t v=kTRUE)                      {fRawData = v;}\r
  void Clusterize();\r
  void SetSegmentation(const AliITSUSegmentationPix *segm);\r
  void SetRecoParam(const AliITSURecoParam* param)     {fRecoParam = param;}\r
  void SetLayerID(Int_t id)                            {fLayerID = id;}\r
  void SetVolID(Int_t id)                              {fVolID = id;}\r
  void SetNRow(Int_t nrow);\r
  void SetAllowDiagonalClusterization(Bool_t v)        {fAllowDiagonalClusterization = v;}\r
  void PrepareLorentzAngleCorrection(Double_t bz);\r
  //\r
  // interface methods\r
  void MakeRecPointBranch(TTree */*treeR*/)            {};\r
  void SetRecPointTreeAddress(TTree */*treeR*/)        {};\r
  void DigitsToRecPoints(const TObjArray */*digList*/) {};\r
  \r
  void SetDigits(const TClonesArray *digits)       {fInputDigits=digits;fInputDigitsReadIndex=0;}\r
  void SetClusters(TClonesArray *clusters)         {fOutputClusters=clusters;}\r
  //\r
  // labeling methods\r
  void AddLabel(int label);\r
  void CheckLabels();\r
  //\r
 protected: // transient data types\r
  struct AliITSUClusterizerClusterDigit {\r
    AliITSUClusterizerClusterDigit *fNext;\r
    AliITSdigit *fDigit;\r
  };\r
  \r
  struct AliITSUClusterizerClusterCand;\r
  struct AliITSUClusterizerClusterPart {\r
    AliITSUClusterizerClusterPart *fNextInRow;\r
    AliITSUClusterizerClusterPart *fPrevInCluster;\r
    AliITSUClusterizerClusterPart *fNextInCluster;\r
    AliITSUClusterizerClusterCand *fParent;\r
    Int_t fUBegin;\r
    Int_t fUEnd;\r
  };\r
  \r
  struct AliITSUClusterizerClusterCand {\r
    AliITSUClusterizerClusterCand  *fNext; // only used for memory management\r
    AliITSUClusterizerClusterPart  *fFirstPart;\r
    AliITSUClusterizerClusterDigit *fFirstDigit;\r
    AliITSUClusterizerClusterDigit *fLastDigit ;\r
  };\r
\r
 protected:\r
  //\r
  // allocation and deallocation\r
  AliITSUClusterizerClusterDigit* AllocDigitFreelist();\r
  AliITSUClusterizerClusterCand*  AllocCand();\r
  void                            DeallocCand(AliITSUClusterizerClusterCand *cand);\r
  AliITSUClusterizerClusterPart*  AllocPart();\r
  void                            DeallocPart(AliITSUClusterizerClusterPart *part) {DeallocParts(part,part); }\r
  void                            DeallocParts(AliITSUClusterizerClusterPart *first,AliITSUClusterizerClusterPart *last);\r
  AliITSUClusterizerClusterDigit* AllocDigit();\r
  void                            DeallocDigit(AliITSUClusterizerClusterDigit *digit) {DeallocDigits(digit,digit);}\r
  void                            DeallocDigits(AliITSUClusterizerClusterDigit *first,AliITSUClusterizerClusterDigit *last);\r
\r
  // input "iterator"\r
  AliITSUClusterizerClusterDigit* NextDigit();\r
  // output "iterator"\r
  AliCluster*                     NextCluster() {return (AliCluster*)fOutputClusters->New(fOutputClusters->GetEntriesFast());}\r
  \r
  // modifiers\r
  void SetAllowDiagonalClusterization();\r
\r
  void AttachDigitToCand(AliITSUClusterizerClusterCand *cand,AliITSUClusterizerClusterDigit *digit);\r
  void AttachPartToCand(AliITSUClusterizerClusterCand *cand,AliITSUClusterizerClusterPart *part);\r
  void DetachPartFromCand(AliITSUClusterizerClusterCand *cand,AliITSUClusterizerClusterPart *part);\r
  void MergeCands(AliITSUClusterizerClusterCand *a,AliITSUClusterizerClusterCand *b);\r
  void Transform(AliITSUClusterPix *cluster, AliITSUClusterizerClusterCand *cand);\r
  void CloseCand(AliITSUClusterizerClusterCand *cand);\r
  void ClosePart(AliITSUClusterizerClusterPart *part);\r
\r
  void CloseRemainingParts(AliITSUClusterizerClusterPart *part);\r
  //\r
 protected:\r
  //\r
  Int_t fVolID;                             // Volume id (module index)\r
  Bool_t fAllowDiagonalClusterization;      // allow clusters with pixels having common corners only\r
  const AliITSUSegmentationPix* fSegm;      // Segmentation or local coord calc.\r
  const AliITSURecoParam*       fRecoParam; // reco params\r
  //\r
  // Digit Input\r
  const TClonesArray *fInputDigits;         // supplied digits\r
  Int_t         fInputDigitsReadIndex;      // digits counter\r
  Int_t         fLayerID;                   // current layer id\r
  //\r
  Int_t         fCurrLabels[kMaxLabels];    // labels collected for current cluster\r
  Int_t         fNLabels;                   // number of collected labels\r
  Bool_t        fRawData;                   // is raw data processed?\r
  //\r
  Double_t      fLorAngCorrection;          // Lorentz Angle correction for current layer\r
  // Cluster Output\r
  TClonesArray *fOutputClusters;            // external container to store clusters\r
  //\r
  // temporary variables\r
  AliITSUClusterizerClusterDigit *fDigitFreelist    ; //! pool of local digits\r
  AliITSUClusterizerClusterPart  *fPartFreelist     ; //! pool of unfinished clusters\r
  AliITSUClusterizerClusterCand  *fCandFreelist     ; //! pool of clusters\r
  AliITSUClusterizerClusterDigit *fDigitFreelistBptrFirst; //! pointer in the pool\r
  AliITSUClusterizerClusterDigit *fDigitFreelistBptrLast ; //! pointer in the pool\r
  AliITSUClusterizerClusterPart  *fPartFreelistBptr ; //! pointer in the pool\r
  AliITSUClusterizerClusterCand  *fCandFreelistBptr ; //!pointer in the pool\r
  //\r
#ifdef _ClusterTopology_\r
  TTree* fTreeTopology;   // output tree for the cluster topology in the special mode\r
  TFile* fFileTopology;   // output file for the cluster topology in the special mode\r
  TBits  fTopology;       // container for the clusters topology pattern\r
  UShort_t fMinCol;       // min col number\r
  UShort_t fMinRow;       // min row number\r
  void   InitTopologyTree();\r
  void   SaveTopologyTree();\r
  void   FillClusterTopology(AliITSUClusterizerClusterCand *cand);\r
#endif //_ClusterTopology_\r
 private:\r
  AliITSUClusterizer(const AliITSUClusterizer&); //Not implemented\r
  AliITSUClusterizer& operator=(const AliITSUClusterizer&); //Not implemented\r
  //\r
  ClassDef(AliITSUClusterizer,0)\r
};\r
\r
\r
//_______________________________________________________________________________\r
inline void AliITSUClusterizer::DeallocCand(AliITSUClusterizerClusterCand *cand)\r
{\r
  // free candidate\r
  cand->fNext=fCandFreelist;\r
  fCandFreelist=cand;\r
}\r
\r
//_______________________________________________________________________________\r
inline void AliITSUClusterizer::DeallocParts(AliITSUClusterizerClusterPart *first,AliITSUClusterizerClusterPart *last)\r
{\r
  // free cluster part\r
  last->fNextInRow=fPartFreelist;\r
  fPartFreelist=first;\r
}\r
\r
//_______________________________________________________________________________\r
inline AliITSUClusterizer::AliITSUClusterizerClusterDigit* AliITSUClusterizer::AllocDigit()\r
{\r
  // allocate digits\r
  if (!fDigitFreelist) fDigitFreelist = AllocDigitFreelist();\r
  AliITSUClusterizerClusterDigit *digit = fDigitFreelist;\r
  fDigitFreelist = fDigitFreelist->fNext;\r
  return digit;\r
}\r
\r
//_______________________________________________________________________________\r
inline AliITSUClusterizer::AliITSUClusterizerClusterPart* AliITSUClusterizer::AllocPart()\r
{\r
  // allocate cluster part\r
  AliITSUClusterizerClusterPart *part=fPartFreelist;\r
  fPartFreelist=fPartFreelist->fNextInRow;\r
  return part;\r
}\r
\r
//_______________________________________________________________________________\r
inline AliITSUClusterizer::AliITSUClusterizerClusterCand* AliITSUClusterizer::AllocCand()\r
{\r
  // allocate cluster \r
  AliITSUClusterizerClusterCand *cand=fCandFreelist;\r
  fCandFreelist=fCandFreelist->fNext;\r
  return cand;\r
}\r
\r
//_______________________________________________________________________________\r
inline void AliITSUClusterizer::DeallocDigits(AliITSUClusterizerClusterDigit *first, AliITSUClusterizerClusterDigit *last) \r
{\r
  // free digit\r
  last->fNext = fDigitFreelist;\r
  fDigitFreelist = first;\r
}\r
\r
//_______________________________________________________________________________\r
inline void AliITSUClusterizer::AttachDigitToCand(AliITSUClusterizerClusterCand *cand,AliITSUClusterizerClusterDigit *digit) \r
{\r
  // attach digit\r
  digit->fNext = cand->fFirstDigit;\r
  cand->fFirstDigit = digit;\r
}\r
\r
//_______________________________________________________________________________\r
inline void AliITSUClusterizer::DetachPartFromCand(AliITSUClusterizerClusterCand *cand,AliITSUClusterizerClusterPart *part) \r
{\r
  // remove cluster part \r
  if (part->fPrevInCluster)    part->fPrevInCluster->fNextInCluster=part->fNextInCluster;\r
  else                         cand->fFirstPart=part->fNextInCluster;\r
  if (part->fNextInCluster)    part->fNextInCluster->fPrevInCluster=part->fPrevInCluster;\r
}\r
\r
//______________________________________________________________________________\r
inline void AliITSUClusterizer::AddLabel(int label)\r
{\r
  // add new label\r
  if (fNLabels==kMaxLabels) return;\r
  for (int i=fNLabels;i--;) if (fCurrLabels[i]==label) return;\r
  fCurrLabels[fNLabels++] = label;\r
}\r
\r
\r
#endif\r
\r