[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 AliTRDrawStream;
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); }

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

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

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