[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>

#include "AliTRDgeometry.h"

class TFile;
class TTree;
class TClonesArray;

class AliRunLoader;
class AliRawReader;

class AliTRD;
class AliTRDcluster;

class AliTRDrawStream;
class AliTRDarrayADC;
class AliTRDarraySignal;
class AliTRDdigitsManager;
class AliTRDSignalIndex;
class AliTRDtransform;
class AliTRDCalROC;
class AliTRDReconstructor;
class AliTRDCalSingleChamberStatus;
class AliTRDrecoParam;
class AliTRDCalOnlineGainTableROC;

class AliTRDclusterizer : public TNamed 
{

 public:

  // steering flags
  // bits from 0-13 are reserved by ROOT (see TObject.h)
  enum{
    kTrOwner = BIT(14)  //  toggle online tracklets ownership
    ,kClOwner= BIT(15)  //  toggle cluster ownership
    ,kLabels = BIT(16)  //  toggle MC labels for clusters
    ,kSkipTrafo = BIT(17)  //  skip the coordinate transformation of clusters?
    ,kLUT    = BIT(18)  //  using look up table for cluster's r-phi position
    ,kGAUS   = BIT(19)  //  using gauss approx. for cluster's r-phi position
    ,knewDM  = BIT(20)  //  was the digitsmanger created by raw2clusters?
    ,kTracksOwner = BIT(21) //  toggle GTU track ownership
  };

  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   ReadDigits();
  Bool_t   ReadDigits(AliRawReader *rawReader);
  Bool_t   ReadDigits(TTree *digitsTree);

  Bool_t   ReadTracklets();
  Bool_t   ReadTracks();

  Bool_t   WriteClusters(Int_t det);
  void     ResetRecPoints();
  virtual TClonesArray    *RecPoints();
  virtual TClonesArray    *TrackletsArray(const TString &trkltype = "");
  virtual TClonesArray    *TracksArray();

  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;}
  Int_t            GetNTimeBins() const {return fTimeTotal;}

  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; } }
  void             SetTracksOwner(Bool_t own=kTRUE) {SetBit(kTracksOwner, own); if(!own) {fTracks = 0x0; } }
  void             SetSkipTransform(Bool_t b=kTRUE) {SetBit(kSkipTrafo, b); }

  UInt_t   GetTriggerFlags(const Int_t sector) const { return fTrgFlags[sector]; }

protected:

  void             ApplyTCTM(Short_t *const arr, const Int_t nTime, const Int_t nexp);
  void             DeConvExp (Short_t *const arr, const Int_t nTime, const Int_t nexp);
  void             ConvExp(Short_t *const arr, const Int_t nTime);
  void             TailCancelation(const AliTRDrecoParam* const recoParam);

  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);

  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
  TClonesArray        *fTracks;                   //! Array of GTU tracks

  TTree               *fTrackletTree;             //! Tree for tracklets

  AliTRDdigitsManager *fDigitsManager;            //! TRD digits manager

  UInt_t              **fTrackletContainer;       //! tracklet container
					          // legacy code to avoid breakint AliHLTTRDClusterizer
					          // but it's useless

  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
  Short_t              fMaxThresh;                // Threshold value for the maximum
  Short_t              fMaxThreshTest;            // Threshold value for the maximum to test agains
  Short_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
  AliTRDCalOnlineGainTableROC *fCalOnGainROC;     // Calibration table of online gain factors
  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
  AliTRDrawStream     *fRawStream;                // Raw data streamer
  UInt_t               fTrgFlags[AliTRDgeometry::kNsector]; // trigger flags

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

  ClassDef(AliTRDclusterizer,6)                   //  TRD clusterfinder

};

#endif
Commit	Line	Data
8230f242	1	#ifndef ALITRDCLUSTERIZER_H
8230f242	2	#define ALITRDCLUSTERIZER_H
f7336fa3	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5
	6	/* $Id$ */
	7
6d50f529	8	////////////////////////////////////////////////////////////////////////////
6d50f529	9	// //
3fe61b77	10	// TRD cluster finder //
6d50f529	11	// //
	12	////////////////////////////////////////////////////////////////////////////
	13
f7336fa3	14	#include <TNamed.h>
793ff80c	15
e2cea5e3	16	#include "AliTRDgeometry.h"
8eab6a01	17
793ff80c	18	class TFile;
bdbb05bb	19	class TTree;
66f6bfd9	20	class TClonesArray;
6d50f529	21
88cb7938	22	class AliRunLoader;
3fe61b77	23	class AliRawReader;
6d50f529	24
bdbb05bb	25	class AliTRD;
c85a4951	26	class AliTRDcluster;
b65e5048	27
04e58504	28	class AliTRDrawStream;
b65e5048	29	class AliTRDarrayADC;
b65e5048	30	class AliTRDarraySignal;
3fe61b77	31	class AliTRDdigitsManager;
	32	class AliTRDSignalIndex;
	33	class AliTRDtransform;
	34	class AliTRDCalROC;
3a039a31	35	class AliTRDReconstructor;
1b3a719f	36	class AliTRDCalSingleChamberStatus;
fc0882f3	37	class AliTRDrecoParam;
e8e7f17e	38	class AliTRDCalOnlineGainTableROC;
b65e5048	39
3a039a31	40	class AliTRDclusterizer : public TNamed
3a039a31	41	{
b65e5048	42
	43	public:
	44
66f6bfd9	45	// steering flags
4806451b	46	// bits from 0-13 are reserved by ROOT (see TObject.h)
66f6bfd9	47	enum{
4806451b	48	kTrOwner = BIT(14) // toggle online tracklets ownership
	49	,kClOwner= BIT(15) // toggle cluster ownership
	50	,kLabels = BIT(16) // toggle MC labels for clusters
d03bfe2b	51	,kSkipTrafo = BIT(17) // skip the coordinate transformation of clusters?
4806451b	52	,kLUT = BIT(18) // using look up table for cluster's r-phi position
	53	,kGAUS = BIT(19) // using gauss approx. for cluster's r-phi position
	54	,knewDM = BIT(20) // was the digitsmanger created by raw2clusters?
a1c095f1	55	,kTracksOwner = BIT(21) // toggle GTU track ownership
66f6bfd9	56	};
486c2339	57
	58	struct MaxStruct
	59	{
4dab9275	60	Int_t row; // row of the current cluster candidate
	61	Int_t col; // col of the current cluster candidate
	62	Int_t time; // time -"-
	63	Short_t signals[3]; // signals of the maximum pad and it's twon neigbours
	64	UChar_t padStatus; // padStatus of the current cluster candidate
	65	Bool_t fivePad; // is this cluster candidate part of a 5 pad cluster (two overlaping clusters)?
615f0826	66	MaxStruct():row(-1),col(0),time(0),padStatus(0),fivePad(kFALSE)
615f0826	67	{memset(signals, 0, 3*sizeof(Short_t));}
486c2339	68	MaxStruct &operator=(const MaxStruct &a)
6b0d4ad5	69	{memcpy(this, &a, sizeof(MaxStruct)); return *this;}
486c2339	70	};
66f6bfd9	71
486c2339	72	AliTRDclusterizer(const AliTRDReconstructor *const rec = 0x0);
486c2339	73	AliTRDclusterizer(const Text_t* name, const Text_t* title, const AliTRDReconstructor *const rec = 0x0);
dd9a6ee3	74	AliTRDclusterizer(const AliTRDclusterizer &c);
6d50f529	75	virtual ~AliTRDclusterizer();
dd9a6ee3	76	AliTRDclusterizer &operator=(const AliTRDclusterizer &c);
dd9a6ee3	77
0ab5ff49	78	void Copy(TObject &c) const;
3fe61b77	79
6cd9a21f	80	Bool_t Open(const Char_t *name, Int_t nEvent = 0);
	81	Bool_t OpenInput(Int_t nEvent = 0);
	82	Bool_t OpenOutput();
e7295a3a	83	Bool_t OpenOutput(TTree *const clusterTree);
3fe61b77	84
6cd9a21f	85	Bool_t ReadDigits();
	86	Bool_t ReadDigits(AliRawReader *rawReader);
	87	Bool_t ReadDigits(TTree *digitsTree);
3fe61b77	88
cb8b99ee	89	Bool_t ReadTracklets();
	90	Bool_t ReadTracks();
	91
6cd9a21f	92	Bool_t WriteClusters(Int_t det);
3d0c7d6d	93	void ResetRecPoints();
3d0c7d6d	94	virtual TClonesArray *RecPoints();
cb8b99ee	95	virtual TClonesArray *TrackletsArray(const TString &trkltype = "");
a1c095f1	96	virtual TClonesArray *TracksArray();
bdbb05bb	97
6cd9a21f	98	Bool_t Raw2Clusters(AliRawReader *rawReader);
6cd9a21f	99	Bool_t Raw2ClustersChamber(AliRawReader *rawReader);
3fe61b77	100
6cd9a21f	101	Bool_t MakeClusters();
6cd9a21f	102	Bool_t MakeClusters(Int_t det);
3fe61b77	103
6cd9a21f	104	Bool_t AddLabels();
b72f4eaf	105	Bool_t SetUseLabels(const Bool_t kset) { SetBit(kLabels, kset); return TestBit(kLabels); } // should we assign labels to clusters
6cd9a21f	106	void SetRawVersion(const Int_t iver) { fRawVersion = iver; } // set the expected raw data version
3a039a31	107	void SetReconstructor(const AliTRDReconstructor *rec) {fReconstructor = rec;}
66f6bfd9	108	static UChar_t GetStatus(Short_t &signal);
e7295a3a	109	Int_t GetAddedClusters() const {return fNoOfClusters;}
293e8ba7	110	Int_t GetNTimeBins() const {return fTimeTotal;}
66f6bfd9	111
8c499dbf	112	Bool_t IsClustersOwner() const {return TestBit(kClOwner);}
29f3223b	113	virtual void SetClustersOwner(Bool_t own=kTRUE) {SetBit(kClOwner, own); if(!own) {fRecPoints = 0x0; fNoOfClusters=0;} }
8c499dbf	114	void SetTrackletsOwner(Bool_t own=kTRUE) {SetBit(kTrOwner, own); if(!own) {fTracklets = 0x0; } }
a1c095f1	115	void SetTracksOwner(Bool_t own=kTRUE) {SetBit(kTracksOwner, own); if(!own) {fTracks = 0x0; } }
d03bfe2b	116	void SetSkipTransform(Bool_t b=kTRUE) {SetBit(kSkipTrafo, b); }
3a039a31	117
e2cea5e3	118	UInt_t GetTriggerFlags(const Int_t sector) const { return fTrgFlags[sector]; }
8eab6a01	119
b72f4eaf	120	protected:
b65e5048	121
9dcc64cc	122	void ApplyTCTM(Short_t *const arr, const Int_t nTime, const Int_t nexp);
1ab4da8c	123	void DeConvExp (Short_t *const arr, const Int_t nTime, const Int_t nexp);
9dcc64cc	124	void ConvExp(Short_t *const arr, const Int_t nTime);
fc0882f3	125	void TailCancelation(const AliTRDrecoParam* const recoParam);
064d808d	126
8c499dbf	127	Float_t Unfold(Double_t eps, Int_t layer, const Double_t *const padSignal) const;
6d9e79cc	128
e7295a3a	129	void SetPadStatus(const UChar_t status, UChar_t &encoding) const;
064d808d	130	UChar_t GetPadStatus(UChar_t encoding) const;
	131	Int_t GetCorruption(UChar_t encoding) const;
	132
1b3a719f	133	Bool_t IsMaximum(const MaxStruct &Max, UChar_t &padStatus, Short_t *const Signals); //for const correctness reasons not const parameters are given separately
1b3a719f	134	Bool_t FivePadCluster(MaxStruct &ThisMax, MaxStruct &NeighbourMax);
486c2339	135	void CreateCluster(const MaxStruct &Max);
8dbc94c7	136
e7295a3a	137	virtual void AddClusterToArray(AliTRDcluster* cluster);
3fe61b77	138
04e58504	139	const AliTRDReconstructor *fReconstructor; //! reconstructor
	140	AliRunLoader *fRunLoader; //! Run Loader
	141	TTree *fClusterTree; //! Tree with the cluster
	142	TClonesArray *fRecPoints; //! Array of clusters
	143	TClonesArray *fTracklets; //! Array of online tracklets
	144	TClonesArray *fTracks; //! Array of GTU tracks
	145
	146	TTree *fTrackletTree; //! Tree for tracklets
	147
	148	AliTRDdigitsManager *fDigitsManager; //! TRD digits manager
	149
	150	UInt_t **fTrackletContainer; //! tracklet container
	151	// legacy code to avoid breakint AliHLTTRDClusterizer
	152	// but it's useless
	153
	154	Int_t fRawVersion; // Expected raw version of the data - default is 2
	155
	156	AliTRDtransform *fTransform; //! Transforms the reconstructed space points
	157
	158	AliTRDarrayADC *fDigits; // Array holding the digits
	159	AliTRDSignalIndex *fIndexes; // Array holding the indexes to the digits
	160	Short_t fMaxThresh; // Threshold value for the maximum
	161	Short_t fMaxThreshTest; // Threshold value for the maximum to test agains
	162	Short_t fSigThresh; // Threshold value for the digit signal
	163	Float_t fMinMaxCutSigma; // Threshold value for the maximum (cut noise)
	164	Float_t fMinLeftRightCutSigma; // Threshold value for the sum pad (cut noise)
	165	Int_t fLayer; // Current layer of the detector
	166	Int_t fDet; // Current detecor
	167	UShort_t fVolid; // Volume ID
	168	Int_t fColMax; // Number of Colums in one detector
	169	Int_t fTimeTotal; // Number of time bins
	170	AliTRDCalROC *fCalGainFactorROC; // Calibration object with pad wise values for the gain factors
	171	Float_t fCalGainFactorDetValue; // Calibration value for chamber wise noise
	172	AliTRDCalROC *fCalNoiseROC; // Calibration object with pad wise values for the noise
	173	Float_t fCalNoiseDetValue; // Calibration value for chamber wise noise
3d0c7d6d	174	AliTRDCalSingleChamberStatus *fCalPadStatusROC; // Calibration object with the pad status
04e58504	175	AliTRDCalOnlineGainTableROC *fCalOnGainROC; // Calibration table of online gain factors
	176	Int_t fClusterROC; // The index to the first cluster of a given ROC
	177	Int_t firstClusterROC; // The number of cluster in a given ROC
	178	Int_t fNoOfClusters; // Number of Clusters already processed and still owned by the clusterizer
	179	Int_t fBaseline; // Baseline of the ADC values
	180	AliTRDrawStream *fRawStream; // Raw data streamer
e2cea5e3	181	UInt_t fTrgFlags[AliTRDgeometry::kNsector]; // trigger flags
064d808d	182
04e58504	183	private:
	184	inline void CalcAdditionalInfo(const MaxStruct &Max, Short_t *const signals, Int_t &nPadCount);
	185
	186	ClassDef(AliTRDclusterizer,6) // TRD clusterfinder
f7336fa3	187
	188	};
	189
f7336fa3	190	#endif