[u/mrichter/AliRoot.git] / TRD / AliTRDclusterizer.h

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

/* $Id$ */

////////////////////////////////////////////////////////////////////////////
//                                                                        //
//  TRD cluster finder                                                    //
//                                                                        //
////////////////////////////////////////////////////////////////////////////

#include <TNamed.h>

class TFile;
class TTree;
class TClonesArray;

class AliRunLoader;
class AliRawReader;

class AliTRD;
class AliTRDcluster;

class AliTRDarrayADC;
class AliTRDarraySignal;
class AliTRDdigitsManager;
class AliTRDSignalIndex;
class AliTRDtransform;
class AliTRDCalROC;
class AliTRDReconstructor;
class AliTRDCalSingleChamberStatus;
class AliTRDrawStreamBase;

class AliTRDclusterizer : public TNamed 
{

 public:

  // steering flags
  enum{
    kTrOwner= BIT(13)  //  toggle online tracklets ownership
    ,kClOwner= BIT(14)  //  toggle cluster ownership
    ,kLabels = BIT(15)  //  toggle MC labels for clusters
    ,kHLT    = BIT(16)  //  HLT mode
    ,kLUT    = BIT(17)  //  using look up table for cluster's r-phi position
    ,kGAUS   = BIT(18)  //  using gauss approx. for cluster's r-phi position
    ,knewDM  = BIT(19)  //  was the digitsmanger created by raw2clusters?
  };

  struct MaxStruct
  {
    Int_t       row;           // row of the current cluster candidate
    Int_t       col;           // col of the current cluster candidate
    Int_t       time;          // time -"-
    Short_t     signals[3];    // signals of the maximum pad and it's twon neigbours
    UChar_t     padStatus;     // padStatus of the current cluster candidate
    Bool_t      fivePad;       // is this cluster candidate part of a 5 pad cluster (two overlaping clusters)?
  MaxStruct():row(-1),col(0),time(0),padStatus(0),fivePad(kFALSE)
      {memset(signals, 0, 3*sizeof(Short_t));}
    MaxStruct &operator=(const MaxStruct &a)
    {memcpy(this, &a, sizeof(MaxStruct)); return *this;}
  };
  
  AliTRDclusterizer(const AliTRDReconstructor *const rec = 0x0);
  AliTRDclusterizer(const Text_t* name, const Text_t* title, const AliTRDReconstructor *const rec = 0x0);
  AliTRDclusterizer(const AliTRDclusterizer &c);
  virtual         ~AliTRDclusterizer();
  AliTRDclusterizer &operator=(const AliTRDclusterizer &c);

  void     Copy(TObject &c) const;

  Bool_t   Open(const Char_t *name, Int_t nEvent = 0);
  Bool_t   OpenInput(Int_t nEvent = 0);
  Bool_t   OpenOutput();
  Bool_t   OpenOutput(TTree *const clusterTree);
  Bool_t   OpenTrackletOutput();

  Bool_t   ReadDigits();
  Bool_t   ReadDigits(AliRawReader *rawReader);
  Bool_t   ReadDigits(TTree *digitsTree);

  Bool_t   WriteClusters(Int_t det);
  void     ResetRecPoints();
  virtual TClonesArray    *RecPoints();
  virtual TClonesArray    *TrackletsArray();
  Bool_t   WriteTracklets(Int_t det);

  Bool_t   Raw2Clusters(AliRawReader *rawReader);
  Bool_t   Raw2ClustersChamber(AliRawReader *rawReader);

  Bool_t   MakeClusters();
  Bool_t   MakeClusters(Int_t det);

  Bool_t   AddLabels();
  Bool_t   SetUseLabels(const Bool_t kset) { SetBit(kLabels, kset); return TestBit(kLabels);  } // should we assign labels to clusters
  void     SetRawVersion(const Int_t iver) { fRawVersion = iver; } // set the expected raw data version
  void             SetReconstructor(const AliTRDReconstructor *rec) {fReconstructor = rec;}
  static UChar_t   GetStatus(Short_t &signal);
  Int_t            GetAddedClusters() const {return fNoOfClusters;}

  Bool_t   IsClustersOwner() const {return TestBit(kClOwner);}
  virtual void     SetClustersOwner(Bool_t own=kTRUE) {SetBit(kClOwner, own); if(!own) {fRecPoints = 0x0; fNoOfClusters=0;} }
  void     SetTrackletsOwner(Bool_t own=kTRUE) {SetBit(kTrOwner, own); if(!own) {fTracklets = 0x0; } }

protected:

  void             DeConvExp (const Double_t *const source, Double_t *const target
			     ,const Int_t nTimeTotal, const Int_t nexp);
  void             TailCancelation();

  Float_t  Unfold(Double_t eps, Int_t layer, const Double_t *const padSignal) const;
  
  void             SetPadStatus(const UChar_t status, UChar_t &encoding) const;
  UChar_t          GetPadStatus(UChar_t encoding) const;
  Int_t            GetCorruption(UChar_t encoding) const;

  Bool_t           IsMaximum(const MaxStruct &Max, UChar_t &padStatus, Short_t *const Signals);       //for const correctness reasons not const parameters are given separately
  Bool_t           FivePadCluster(MaxStruct &ThisMax, MaxStruct &NeighbourMax);
  void             CreateCluster(const MaxStruct &Max); 

  virtual void     AddClusterToArray(AliTRDcluster* cluster);
  virtual void     AddTrackletsToArray();

private:
  inline void      CalcAdditionalInfo(const MaxStruct &Max, Short_t *const signals, Int_t &nPadCount);

protected:
  const AliTRDReconstructor *fReconstructor; //! reconstructor
  AliRunLoader        *fRunLoader;           //! Run Loader
  TTree               *fClusterTree;         //! Tree with the cluster
  TClonesArray        *fRecPoints;           //! Array of clusters
  TClonesArray        *fTracklets;           //! Array of online tracklets

  TTree               *fTrackletTree;        //! Tree for tracklets

  AliTRDdigitsManager *fDigitsManager;       //! TRD digits manager

  UInt_t              **fTrackletContainer;  //! tracklet container

  Int_t                fRawVersion;          //  Expected raw version of the data - default is 2

  AliTRDtransform     *fTransform;           //! Transforms the reconstructed space points

  AliTRDarrayADC      *fDigits;               // Array holding the digits
  AliTRDSignalIndex   *fIndexes;              // Array holding the indexes to the digits
  Float_t              fMaxThresh;            // Threshold value for the maximum
  Float_t              fSigThresh;            // Threshold value for the digit signal
  Float_t              fMinMaxCutSigma;       // Threshold value for the maximum (cut noise)
  Float_t              fMinLeftRightCutSigma; // Threshold value for the sum pad (cut noise)
  Int_t                fLayer;                // Current layer of the detector
  Int_t                fDet;                  // Current detecor
  UShort_t             fVolid;                // Volume ID
  Int_t                fColMax;               // Number of Colums in one detector
  Int_t                fTimeTotal;            // Number of time bins
  AliTRDCalROC        *fCalGainFactorROC;     // Calibration object with pad wise values for the gain factors
  Float_t              fCalGainFactorDetValue;// Calibration value for chamber wise noise
  AliTRDCalROC        *fCalNoiseROC;          // Calibration object with pad wise values for the noise
  Float_t              fCalNoiseDetValue;     // Calibration value for chamber wise noise
  AliTRDCalSingleChamberStatus *fCalPadStatusROC; // Calibration object with the pad status
  Int_t                fClusterROC;           // The index to the first cluster of a given ROC
  Int_t                firstClusterROC;       // The number of cluster in a given ROC
  Int_t                fNoOfClusters;         // Number of Clusters already processed and still owned by the clusterizer
  Int_t                fBaseline;             // Baseline of the ADC values
  AliTRDrawStreamBase *fRawStream;            // Currently used RawStream

  ClassDef(AliTRDclusterizer,6)               //  TRD clusterfinder

};

#endif
Commit	Line	Data
	1	#ifndef ALITRDCLUSTERIZER_H
	2	#define ALITRDCLUSTERIZER_H
	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5
	6	/* $Id$ */
	7
	8	////////////////////////////////////////////////////////////////////////////
	9	// //
	10	// TRD cluster finder //
	11	// //
	12	////////////////////////////////////////////////////////////////////////////
	13
	14	#include <TNamed.h>
	15
	16	class TFile;
	17	class TTree;
	18	class TClonesArray;
	19
	20	class AliRunLoader;
	21	class AliRawReader;
	22
	23	class AliTRD;
	24	class AliTRDcluster;
	25
	26	class AliTRDarrayADC;
	27	class AliTRDarraySignal;
	28	class AliTRDdigitsManager;
	29	class AliTRDSignalIndex;
	30	class AliTRDtransform;
	31	class AliTRDCalROC;
	32	class AliTRDReconstructor;
	33	class AliTRDCalSingleChamberStatus;
	34	class AliTRDrawStreamBase;
	35
	36	class AliTRDclusterizer : public TNamed
	37	{
	38
	39	public:
	40
	41	// steering flags
	42	enum{
	43	kTrOwner= BIT(13) // toggle online tracklets ownership
	44	,kClOwner= BIT(14) // toggle cluster ownership
	45	,kLabels = BIT(15) // toggle MC labels for clusters
	46	,kHLT = BIT(16) // HLT mode
	47	,kLUT = BIT(17) // using look up table for cluster's r-phi position
	48	,kGAUS = BIT(18) // using gauss approx. for cluster's r-phi position
	49	,knewDM = BIT(19) // was the digitsmanger created by raw2clusters?
	50	};
	51
	52	struct MaxStruct
	53	{
	54	Int_t row; // row of the current cluster candidate
	55	Int_t col; // col of the current cluster candidate
	56	Int_t time; // time -"-
	57	Short_t signals[3]; // signals of the maximum pad and it's twon neigbours
	58	UChar_t padStatus; // padStatus of the current cluster candidate
	59	Bool_t fivePad; // is this cluster candidate part of a 5 pad cluster (two overlaping clusters)?
	60	MaxStruct():row(-1),col(0),time(0),padStatus(0),fivePad(kFALSE)
	61	{memset(signals, 0, 3*sizeof(Short_t));}
	62	MaxStruct &operator=(const MaxStruct &a)
	63	{memcpy(this, &a, sizeof(MaxStruct)); return *this;}
	64	};
	65
	66	AliTRDclusterizer(const AliTRDReconstructor *const rec = 0x0);
	67	AliTRDclusterizer(const Text_t* name, const Text_t* title, const AliTRDReconstructor *const rec = 0x0);
	68	AliTRDclusterizer(const AliTRDclusterizer &c);
	69	virtual ~AliTRDclusterizer();
	70	AliTRDclusterizer &operator=(const AliTRDclusterizer &c);
	71
	72	void Copy(TObject &c) const;
	73
	74	Bool_t Open(const Char_t *name, Int_t nEvent = 0);
	75	Bool_t OpenInput(Int_t nEvent = 0);
	76	Bool_t OpenOutput();
	77	Bool_t OpenOutput(TTree *const clusterTree);
	78	Bool_t OpenTrackletOutput();
	79
	80	Bool_t ReadDigits();
	81	Bool_t ReadDigits(AliRawReader *rawReader);
	82	Bool_t ReadDigits(TTree *digitsTree);
	83
	84	Bool_t WriteClusters(Int_t det);
	85	void ResetRecPoints();
	86	virtual TClonesArray *RecPoints();
	87	virtual TClonesArray *TrackletsArray();
	88	Bool_t WriteTracklets(Int_t det);
	89
	90	Bool_t Raw2Clusters(AliRawReader *rawReader);
	91	Bool_t Raw2ClustersChamber(AliRawReader *rawReader);
	92
	93	Bool_t MakeClusters();
	94	Bool_t MakeClusters(Int_t det);
	95
	96	Bool_t AddLabels();
	97	Bool_t SetUseLabels(const Bool_t kset) { SetBit(kLabels, kset); return TestBit(kLabels); } // should we assign labels to clusters
	98	void SetRawVersion(const Int_t iver) { fRawVersion = iver; } // set the expected raw data version
	99	void SetReconstructor(const AliTRDReconstructor *rec) {fReconstructor = rec;}
	100	static UChar_t GetStatus(Short_t &signal);
	101	Int_t GetAddedClusters() const {return fNoOfClusters;}
	102
	103	Bool_t IsClustersOwner() const {return TestBit(kClOwner);}
	104	virtual void SetClustersOwner(Bool_t own=kTRUE) {SetBit(kClOwner, own); if(!own) {fRecPoints = 0x0; fNoOfClusters=0;} }
	105	void SetTrackletsOwner(Bool_t own=kTRUE) {SetBit(kTrOwner, own); if(!own) {fTracklets = 0x0; } }
	106
	107	protected:
	108
	109	void DeConvExp (const Double_t const source, Double_t const target
	110	,const Int_t nTimeTotal, const Int_t nexp);
	111	void TailCancelation();
	112
	113	Float_t Unfold(Double_t eps, Int_t layer, const Double_t *const padSignal) const;
	114
	115	void SetPadStatus(const UChar_t status, UChar_t &encoding) const;
	116	UChar_t GetPadStatus(UChar_t encoding) const;
	117	Int_t GetCorruption(UChar_t encoding) const;
	118
	119	Bool_t IsMaximum(const MaxStruct &Max, UChar_t &padStatus, Short_t *const Signals); //for const correctness reasons not const parameters are given separately
	120	Bool_t FivePadCluster(MaxStruct &ThisMax, MaxStruct &NeighbourMax);
	121	void CreateCluster(const MaxStruct &Max);
	122
	123	virtual void AddClusterToArray(AliTRDcluster* cluster);
	124	virtual void AddTrackletsToArray();
	125
	126	private:
	127	inline void CalcAdditionalInfo(const MaxStruct &Max, Short_t *const signals, Int_t &nPadCount);
	128
	129	protected:
	130	const AliTRDReconstructor *fReconstructor; //! reconstructor
	131	AliRunLoader *fRunLoader; //! Run Loader
	132	TTree *fClusterTree; //! Tree with the cluster
	133	TClonesArray *fRecPoints; //! Array of clusters
	134	TClonesArray *fTracklets; //! Array of online tracklets
	135
	136	TTree *fTrackletTree; //! Tree for tracklets
	137
	138	AliTRDdigitsManager *fDigitsManager; //! TRD digits manager
	139
	140	UInt_t **fTrackletContainer; //! tracklet container
	141
	142	Int_t fRawVersion; // Expected raw version of the data - default is 2
	143
	144	AliTRDtransform *fTransform; //! Transforms the reconstructed space points
	145
	146	AliTRDarrayADC *fDigits; // Array holding the digits
	147	AliTRDSignalIndex *fIndexes; // Array holding the indexes to the digits
	148	Float_t fMaxThresh; // Threshold value for the maximum
	149	Float_t fSigThresh; // Threshold value for the digit signal
	150	Float_t fMinMaxCutSigma; // Threshold value for the maximum (cut noise)
	151	Float_t fMinLeftRightCutSigma; // Threshold value for the sum pad (cut noise)
	152	Int_t fLayer; // Current layer of the detector
	153	Int_t fDet; // Current detecor
	154	UShort_t fVolid; // Volume ID
	155	Int_t fColMax; // Number of Colums in one detector
	156	Int_t fTimeTotal; // Number of time bins
	157	AliTRDCalROC *fCalGainFactorROC; // Calibration object with pad wise values for the gain factors
	158	Float_t fCalGainFactorDetValue;// Calibration value for chamber wise noise
	159	AliTRDCalROC *fCalNoiseROC; // Calibration object with pad wise values for the noise
	160	Float_t fCalNoiseDetValue; // Calibration value for chamber wise noise
	161	AliTRDCalSingleChamberStatus *fCalPadStatusROC; // Calibration object with the pad status
	162	Int_t fClusterROC; // The index to the first cluster of a given ROC
	163	Int_t firstClusterROC; // The number of cluster in a given ROC
	164	Int_t fNoOfClusters; // Number of Clusters already processed and still owned by the clusterizer
	165	Int_t fBaseline; // Baseline of the ADC values
	166	AliTRDrawStreamBase *fRawStream; // Currently used RawStream
	167
	168	ClassDef(AliTRDclusterizer,6) // TRD clusterfinder
	169
	170	};
	171
	172	#endif