[u/mrichter/AliRoot.git] / FMD / AliFMDReconstructor.h

#ifndef ALIFMDRECONSTRUCTOR_H
#define ALIFMDRECONSTRUCTOR_H
//
//  Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
//  reserved. 
//
//  See cxx source for full Copyright notice                               
//
//  AliFMDReconstructor.h 
//  Task Class for making TreeR for FMD                        
//
//-- Authors: Evgeny Karpechev (INR) and Alla Maevskaia (INR)
//   Latest changes by Christian Holm Christensen <cholm@nbi.dk>
/* $Id$ */
/** @file    AliFMDReconstructor.h
    @author  Christian Holm Christensen <cholm@nbi.dk>
    @date    Mon Mar 27 12:47:09 2006
    @brief   FMD reconstruction 
*/

//____________________________________________________________________
// Header guards in the header files speeds up the compilation
// considerably.  Please leave them in. 
#ifndef ALIRECONSTRUCTOR_H
# include <AliReconstructor.h>
#endif

//____________________________________________________________________
class TTree;
class TClonesArray;
class AliFMDDigit;
class AliRawReader;
class AliRunLoader;
class AliESDEvent;
class AliESDFMD;
class TH1;


/** @defgroup FMD_rec Reconstruction */
//____________________________________________________________________
/** @brief This is a class that reconstructs AliFMDRecPoint objects from of
    Digits.  
    This class reads either digits from a TClonesArray or raw data
    from a DDL file (or similar), and applies calibrations to get
    psuedo-inclusive multiplicities per strip.

    @ingroup FMD_rec
 */
class AliFMDReconstructor: public AliReconstructor 
{
public:
  /** CTOR */
  AliFMDReconstructor();
  /** DTOR */
  virtual ~AliFMDReconstructor();

  /** Initialize the reconstructor.  Here, we initialize the geometry
      manager, and finds the local to global transformations from the
      geometry.   The calibration parameter manager is also
      initialized (meaning that the calibration parameters is read
      from CDB).
  */
  virtual void   Init(AliRunLoader* /*runLoader*/);
  /** Flag that we can convert raw data into digits. 
      @return always @c true */
  virtual Bool_t HasDigitConversion() const { return kTRUE; }
  /** Convert raw data read from the AliRawReader @a reader into
      digits.  This is done using AliFMDRawReader and
      AliFMDAltroReader.  The digits are put in the passed TTree @a
      digitsTree. 
      @param reader     Raw reader. 
      @param digitsTree Tree to store read digits in. */
  virtual void   ConvertDigits(AliRawReader* reader, TTree* digitsTree) const;
  /** Flag that we can do one-event reconstruction. 
      @return always @c true  */
  virtual Bool_t HasLocalReconstruction() const { return kTRUE; }
  /** Reconstruct one event from the digits passed in @a digitsTree.
      The member function creates AliFMDRecPoint objects and stores
      them on the output tree @a clusterTree.  An FMD ESD object is
      created in parallel. 
      @todo Make sure we get a vertex. 
      @param digitsTree  Tree holding the digits of this event
      @param clusterTree Tree to store AliFMDRecPoint objects in. */
  virtual void   Reconstruct(TTree* digitsTree, TTree* clusterTree) const;
  /** Reconstruct one event from the raw data, via a digits read using
      @a reader. The member function @e does @e not create
      AliFMDRecPoint objects, and the read AliFMDDigit objects are not
      stored. An FMD ESD object is created in parallel. 
      @todo Make sure we get a vertex. 
      @param reader      Raw data reader
      @param clusterTree Tree to store AliFMDRecPoint objects in (not used). */
  void Reconstruct(AliRawReader* reader, TTree* clusterTree) const;
  /** Put in the ESD data, the FMD ESD data.  The object created by
      the Reconstruct member function is copied to the ESD object. 
      @param digitsTree   Tree of digits for this event - not used
      @param clusterTree  Tree of reconstructed points for this event
      - not used. 
      @param esd ESD object to store data in. 
  */
  virtual void   FillESD(TTree* digitsTree, TTree* clusterTree, 
			 AliESDEvent* esd) const;
  /** Put in the ESD data, the FMD ESD data.  The object created by
      the Reconstruct member function is copied to the ESD object. 
      @param reader       Raw data reader - not used.
      @param clusterTree  Tree of reconstructed points for this event
                          - not used. 
      @param esd          ESD object to store data in. */
  void FillESD(AliRawReader* reader, TTree* clusterTree, 
	       AliESDEvent* esd) const;
  /** Not used */
  virtual void   SetESD(AliESDEvent* esd) { fESD = esd; }
  /** Set the noise factor 
      @param f Factor to use */
  virtual void SetNoiseFactor(Float_t f=3) { fNoiseFactor = f; }
  /** Set whether we should do angle correction or nor 
      @param use If true, do angle correction */
  virtual void SetAngleCorrect(Bool_t use=kTRUE) { fAngleCorrect = use; }
  /** Set whether we want to do diagnostics.  If this is enabled, a
      file named @c FMD.Diag.root will be made.  It contains a set of
      histograms for each event, filed in separate directories in the
      file.  The histograms are 
      @verbatim 
      diagStep1   Read ADC vs. Noise surpressed ADC 
      diagStep2   Noise surpressed ADC vs. calculated Energy dep.
      diagStep3   Energy deposition vs. angle corrected Energy dep.
      diagStep4   Energy deposition vs. calculated multiplicity
      diagAll     Read ADC vs. calculated multiplicity
      @endverbatim 
      @param use If true, make the diagnostics file */
  void SetDiagnose(Bool_t use=kTRUE) { fDiagnostics = use; }
protected:
  /** Copy CTOR 
      @param other Object to copy from. */
  AliFMDReconstructor(const AliFMDReconstructor& other);
  /** Assignment operator 
      @param other Object to assign from
      @return reference to this object */
  AliFMDReconstructor& operator=(const AliFMDReconstructor& other);
  /** Try to get the vertex from either ESD or generator header.  Sets
      @c fCurrentVertex to the found Z posistion of the vertex (if 
      found), and sets the flag @c fVertexType accordingly */
  virtual void GetVertex() const;
  /** Process AliFMDDigit objects in @a digits.  For each digit, find
      the psuedo-rapidity @f$ \eta@f$, azimuthal angle @f$ \varphi@f$,
      energy deposited @f$ E@f$, and psuedo-inclusive multiplicity @f$
      M@f$.
      @param digits Array of digits. */
  virtual void     ProcessDigits(TClonesArray* digits) const;
  /** Substract pedestals from raw ADC in @a digit
      @param digit Digit data
      @return Pedestal subtracted ADC count. */
  virtual UShort_t SubtractPedestal(AliFMDDigit* digit) const;
  /** Converts number of ADC counts to energy deposited.   This is
      done by 
      @f[
      E_i = A_i g_i
      @f]
      where @f$ A_i@f$ is the pedestal subtracted ADC counts, and @f$
      g_i@f$ is the gain for the @f$ i^{\mbox{th}}@f$ strip. 
      @param digit Raw data
      @param eta   Psuedo-rapidity of digit.
      @param count Pedestal subtracted ADC counts
      @return Energy deposited @f$ E_i@f$ */
  virtual Float_t  Adc2Energy(AliFMDDigit* digit, Float_t eta, 
			      UShort_t count) const;
  /** Converts an energy signal to number of particles. In this
      implementation, it's done by 
      @f[
      M_i = E_i / E_{\mbox{MIP}}
      @f]
      where @f$ E_i@f$ is the energy deposited, and @f$
      E_{\mbox{MIP}}@f$ is the average energy deposited by a minimum
      ionizing particle
      @param digit Raw data
      @param edep Energy deposited @f$ E_i@f$
      @return Psuedo-inclusive multiplicity @f$ M@f$ */
  virtual Float_t  Energy2Multiplicity(AliFMDDigit* digit, Float_t edep) const;
  /** Calculate the physical coordinates psuedo-rapidity @f$ \eta@f$,
      azimuthal angle @f$ \varphi@f$ of the strip corresponding to
      the digit @a digit.   This is done by using the information
      obtained, and previously cached by AliFMDGeometry, from the
      TGeoManager. 
      @param digit Digit.
      @param eta   On return, psuedo-rapidity @f$ \eta@f$
      @param phi   On return, azimuthal angle @f$ \varphi@f$ */
  virtual void     PhysicalCoordinates(AliFMDDigit* digit, Float_t& eta, 
				       Float_t& phi) const;
  
  enum Vertex_t {
    kNoVertex,   // Got no vertex
    kGenVertex,  // Got generator vertex 
    kESDVertex   // Got ESD vertex 
  };
  mutable TClonesArray* fMult;          // Cache of RecPoints
  mutable Int_t         fNMult;         // Number of entries in fMult 
  mutable TTree*        fTreeR;         // Output tree 
  mutable Float_t       fCurrentVertex; // Z-coordinate of primary vertex
  mutable AliESDFMD*    fESDObj;        // ESD output object
  Float_t               fNoiseFactor;   // Factor of noise to check
  Bool_t                fAngleCorrect;  // Whether to angle correct
  mutable Vertex_t      fVertexType;    // What kind of vertex we got
  AliESDEvent*          fESD;           // ESD object(?)
  Bool_t                fDiagnostics;   // Wheter to do diagnostics
  TH1*                  fDiagStep1;	// Diagnostics histogram
  TH1*                  fDiagStep2;	// Diagnostics histogram
  TH1*                  fDiagStep3;	// Diagnostics histogram
  TH1*                  fDiagStep4;	// Diagnostics histogram
  TH1*                  fDiagAll;	// Diagnostics histogram
private:
  /** Hide base classes unused function */
  void Reconstruct(AliRunLoader*) const;
  /** Hide base classes unused function */
  void Reconstruct(AliRunLoader*, AliRawReader*) const;
  // /** Hide base classes unused function */
  // void FillESD(AliRawReader*, TTree*, AliESDEvent*) const;
  /** Hide base classes unused function */
  void FillESD(AliRunLoader*, AliESDEvent*) const;
  /** Hide base classes unused function */
  void FillESD(AliRunLoader*, AliRawReader*, AliESDEvent*) const;
  
  ClassDef(AliFMDReconstructor, 2)  // class for the FMD reconstruction
}; 
#endif
//____________________________________________________________________
//
// Local Variables:
//   mode: C++
// End:
//
// EOF
//
Commit	Line	Data
8f1cfb0c	1	#ifndef ALIFMDRECONSTRUCTOR_H
8f1cfb0c	2	#define ALIFMDRECONSTRUCTOR_H
4347b38f	3	//
	4	// Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
	5	// reserved.
	6	//
121a60bd	7	// See cxx source for full Copyright notice
4347b38f	8	//
121a60bd	9	// AliFMDReconstructor.h
4347b38f	10	// Task Class for making TreeR for FMD
4347b38f	11	//
121a60bd	12	//-- Authors: Evgeny Karpechev (INR) and Alla Maevskaia (INR)
4347b38f	13	// Latest changes by Christian Holm Christensen <cholm@nbi.dk>
121a60bd	14	/* $Id$ */
c2fc1258	15	/** @file AliFMDReconstructor.h
	16	@author Christian Holm Christensen <cholm@nbi.dk>
	17	@date Mon Mar 27 12:47:09 2006
	18	@brief FMD reconstruction
	19	*/
8f1cfb0c	20
42403906	21	//____________________________________________________________________
0d0e6995	22	// Header guards in the header files speeds up the compilation
	23	// considerably. Please leave them in.
	24	#ifndef ALIRECONSTRUCTOR_H
	25	# include <AliReconstructor.h>
	26	#endif
121a60bd	27
4347b38f	28	//____________________________________________________________________
1a1fdef7	29	class TTree;
4347b38f	30	class TClonesArray;
4347b38f	31	class AliFMDDigit;
4347b38f	32	class AliRawReader;
1a1fdef7	33	class AliRunLoader;
af885e0f	34	class AliESDEvent;
8f6ee336	35	class AliESDFMD;
9684be2f	36	class TH1;
9684be2f	37
e802be3e	38
9f662337	39	/** @defgroup FMD_rec Reconstruction */
4347b38f	40	//____________________________________________________________________
c2fc1258	41	/** @brief This is a class that reconstructs AliFMDRecPoint objects from of
	42	Digits.
	43	This class reads either digits from a TClonesArray or raw data
	44	from a DDL file (or similar), and applies calibrations to get
9f662337	45	psuedo-inclusive multiplicities per strip.
c2fc1258	46
9f662337	47	@ingroup FMD_rec
9f662337	48	*/
121a60bd	49	class AliFMDReconstructor: public AliReconstructor
121a60bd	50	{
4347b38f	51	public:
9f662337	52	/** CTOR */
4347b38f	53	AliFMDReconstructor();
9f662337	54	/** DTOR */
56b1929b	55	virtual ~AliFMDReconstructor();
4347b38f	56
9f662337	57	/** Initialize the reconstructor. Here, we initialize the geometry
	58	manager, and finds the local to global transformations from the
	59	geometry. The calibration parameter manager is also
	60	initialized (meaning that the calibration parameters is read
f011bd38	61	from CDB).
9f662337	62	*/
f011bd38	63	virtual void Init(AliRunLoader* /runLoader/);
9f662337	64	/** Flag that we can convert raw data into digits.
9f662337	65	@return always @c true */
1a1fdef7	66	virtual Bool_t HasDigitConversion() const { return kTRUE; }
9f662337	67	/** Convert raw data read from the AliRawReader @a reader into
	68	digits. This is done using AliFMDRawReader and
	69	AliFMDAltroReader. The digits are put in the passed TTree @a
	70	digitsTree.
	71	@param reader Raw reader.
	72	@param digitsTree Tree to store read digits in. */
1a1fdef7	73	virtual void ConvertDigits(AliRawReader* reader, TTree* digitsTree) const;
9f662337	74	/** Flag that we can do one-event reconstruction.
9f662337	75	@return always @c true */
1a1fdef7	76	virtual Bool_t HasLocalReconstruction() const { return kTRUE; }
9f662337	77	/** Reconstruct one event from the digits passed in @a digitsTree.
	78	The member function creates AliFMDRecPoint objects and stores
	79	them on the output tree @a clusterTree. An FMD ESD object is
	80	created in parallel.
	81	@todo Make sure we get a vertex.
	82	@param digitsTree Tree holding the digits of this event
	83	@param clusterTree Tree to store AliFMDRecPoint objects in. */
1a1fdef7	84	virtual void Reconstruct(TTree* digitsTree, TTree* clusterTree) const;
69893a66	85	/** Reconstruct one event from the raw data, via a digits read using
	86	@a reader. The member function @e does @e not create
	87	AliFMDRecPoint objects, and the read AliFMDDigit objects are not
	88	stored. An FMD ESD object is created in parallel.
	89	@todo Make sure we get a vertex.
	90	@param reader Raw data reader
	91	@param clusterTree Tree to store AliFMDRecPoint objects in (not used). */
	92	void Reconstruct(AliRawReader* reader, TTree* clusterTree) const;
9f662337	93	/** Put in the ESD data, the FMD ESD data. The object created by
	94	the Reconstruct member function is copied to the ESD object.
	95	@param digitsTree Tree of digits for this event - not used
	96	@param clusterTree Tree of reconstructed points for this event
	97	- not used.
	98	@param esd ESD object to store data in.
	99	*/
1a1fdef7	100	virtual void FillESD(TTree* digitsTree, TTree* clusterTree,
af885e0f	101	AliESDEvent* esd) const;
69893a66	102	/** Put in the ESD data, the FMD ESD data. The object created by
	103	the Reconstruct member function is copied to the ESD object.
	104	@param reader Raw data reader - not used.
	105	@param clusterTree Tree of reconstructed points for this event
	106	- not used.
	107	@param esd ESD object to store data in. */
	108	void FillESD(AliRawReader* reader, TTree* clusterTree,
	109	AliESDEvent* esd) const;
9f662337	110	/** Not used */
af885e0f	111	virtual void SetESD(AliESDEvent* esd) { fESD = esd; }
a9579262	112	/** Set the noise factor
	113	@param f Factor to use */
	114	virtual void SetNoiseFactor(Float_t f=3) { fNoiseFactor = f; }
	115	/** Set whether we should do angle correction or nor
	116	@param use If true, do angle correction */
	117	virtual void SetAngleCorrect(Bool_t use=kTRUE) { fAngleCorrect = use; }
9684be2f	118	/** Set whether we want to do diagnostics. If this is enabled, a
	119	file named @c FMD.Diag.root will be made. It contains a set of
	120	histograms for each event, filed in separate directories in the
	121	file. The histograms are
	122	@verbatim
	123	diagStep1 Read ADC vs. Noise surpressed ADC
	124	diagStep2 Noise surpressed ADC vs. calculated Energy dep.
	125	diagStep3 Energy deposition vs. angle corrected Energy dep.
	126	diagStep4 Energy deposition vs. calculated multiplicity
	127	diagAll Read ADC vs. calculated multiplicity
	128	@endverbatim
	129	@param use If true, make the diagnostics file */
	130	void SetDiagnose(Bool_t use=kTRUE) { fDiagnostics = use; }
4347b38f	131	protected:
0e73cae6	132	/** Copy CTOR
	133	@param other Object to copy from. */
	134	AliFMDReconstructor(const AliFMDReconstructor& other);
	135	/** Assignment operator
	136	@param other Object to assign from
	137	@return reference to this object */
	138	AliFMDReconstructor& operator=(const AliFMDReconstructor& other);
9684be2f	139	/** Try to get the vertex from either ESD or generator header. Sets
	140	@c fCurrentVertex to the found Z posistion of the vertex (if
	141	found), and sets the flag @c fVertexType accordingly */
	142	virtual void GetVertex() const;
9f662337	143	/** Process AliFMDDigit objects in @a digits. For each digit, find
	144	the psuedo-rapidity @f$ \eta@f$, azimuthal angle @f$ \varphi@f$,
	145	energy deposited @f$ E@f$, and psuedo-inclusive multiplicity @f$
	146	M@f$.
	147	@param digits Array of digits. */
e802be3e	148	virtual void ProcessDigits(TClonesArray* digits) const;
9f662337	149	/** Substract pedestals from raw ADC in @a digit
	150	@param digit Digit data
	151	@return Pedestal subtracted ADC count. */
4347b38f	152	virtual UShort_t SubtractPedestal(AliFMDDigit* digit) const;
9f662337	153	/** Converts number of ADC counts to energy deposited. This is
	154	done by
	155	@f[
	156	E_i = A_i g_i
	157	@f]
	158	where @f$ A_i@f$ is the pedestal subtracted ADC counts, and @f$
	159	g_i@f$ is the gain for the @f$ i^{\mbox{th}}@f$ strip.
	160	@param digit Raw data
	161	@param eta Psuedo-rapidity of digit.
	162	@param count Pedestal subtracted ADC counts
	163	@return Energy deposited @f$ E_i@f$ */
8f6ee336	164	virtual Float_t Adc2Energy(AliFMDDigit* digit, Float_t eta,
8f6ee336	165	UShort_t count) const;
9f662337	166	/** Converts an energy signal to number of particles. In this
	167	implementation, it's done by
	168	@f[
	169	M_i = E_i / E_{\mbox{MIP}}
	170	@f]
	171	where @f$ E_i@f$ is the energy deposited, and @f$
	172	E_{\mbox{MIP}}@f$ is the average energy deposited by a minimum
	173	ionizing particle
	174	@param digit Raw data
	175	@param edep Energy deposited @f$ E_i@f$
	176	@return Psuedo-inclusive multiplicity @f$ M@f$ */
8f6ee336	177	virtual Float_t Energy2Multiplicity(AliFMDDigit* digit, Float_t edep) const;
9f662337	178	/** Calculate the physical coordinates psuedo-rapidity @f$ \eta@f$,
	179	azimuthal angle @f$ \varphi@f$ of the strip corresponding to
	180	the digit @a digit. This is done by using the information
	181	obtained, and previously cached by AliFMDGeometry, from the
	182	TGeoManager.
	183	@param digit Digit.
	184	@param eta On return, psuedo-rapidity @f$ \eta@f$
	185	@param phi On return, azimuthal angle @f$ \varphi@f$ */
8f6ee336	186	virtual void PhysicalCoordinates(AliFMDDigit* digit, Float_t& eta,
8f6ee336	187	Float_t& phi) const;
42403906	188
9684be2f	189	enum Vertex_t {
	190	kNoVertex, // Got no vertex
	191	kGenVertex, // Got generator vertex
	192	kESDVertex // Got ESD vertex
	193	};
8f6ee336	194	mutable TClonesArray* fMult; // Cache of RecPoints
	195	mutable Int_t fNMult; // Number of entries in fMult
	196	mutable TTree* fTreeR; // Output tree
e802be3e	197	mutable Float_t fCurrentVertex; // Z-coordinate of primary vertex
8f6ee336	198	mutable AliESDFMD* fESDObj; // ESD output object
9684be2f	199	Float_t fNoiseFactor; // Factor of noise to check
	200	Bool_t fAngleCorrect; // Whether to angle correct
	201	mutable Vertex_t fVertexType; // What kind of vertex we got
af885e0f	202	AliESDEvent* fESD; // ESD object(?)
9684be2f	203	Bool_t fDiagnostics; // Wheter to do diagnostics
	204	TH1* fDiagStep1; // Diagnostics histogram
	205	TH1* fDiagStep2; // Diagnostics histogram
	206	TH1* fDiagStep3; // Diagnostics histogram
	207	TH1* fDiagStep4; // Diagnostics histogram
	208	TH1* fDiagAll; // Diagnostics histogram
02a27b50	209	private:
02a27b50	210	/** Hide base classes unused function */
	211	void Reconstruct(AliRunLoader*) const;
	212	/** Hide base classes unused function */
	213	void Reconstruct(AliRunLoader, AliRawReader) const;
69893a66	214	// /** Hide base classes unused function */
69893a66	215	// void FillESD(AliRawReader, TTree, AliESDEvent*) const;
02a27b50	216	/** Hide base classes unused function */
af885e0f	217	void FillESD(AliRunLoader, AliESDEvent) const;
02a27b50	218	/** Hide base classes unused function */
af885e0f	219	void FillESD(AliRunLoader, AliRawReader, AliESDEvent*) const;
42403906	220
f011bd38	221	ClassDef(AliFMDReconstructor, 2) // class for the FMD reconstruction
121a60bd	222	};
121a60bd	223	#endif
4347b38f	224	//____________________________________________________________________
4347b38f	225	//
0d0e6995	226	// Local Variables:
	227	// mode: C++
	228	// End:
	229	//
4347b38f	230	// EOF
4347b38f	231	//