[u/mrichter/AliRoot.git] / ITS / AliITS.h

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

/* $Id$ */

////////////////////////////////////////////////////////////////////////
//           Manager class for set: ITS                               //
////////////////////////////////////////////////////////////////////////

#include <TObjArray.h> // used in inline function GetModule.
#include <TBranch.h>   // used in inline function SetHitsAddressBranch

#include "AliRun.h"
#include "AliLoader.h"
#include "AliDetector.h"
#include "AliITSDetType.h"

class TString;
class TTree;
class TFile;

//class AliITSDetType;
class AliITSsimulation;
class AliITSClusterFinder;
class AliITSLoader;
class AliITSsegmentation;
class AliITSresponse;
class AliITShit;
class AliITSgeom;
class AliITSpListItem;
class AliITSdigit;
class AliITSRecPoint;
class AliITSRawCluster;
class AliITSmodule;

const Int_t kNTYPES=3;

class AliITS : public AliDetector {

 public:
    //================= Standard Classes ===============================
    AliITS();  // Default creator.
    AliITS(const char *name, const char *title); // standard Creator
    virtual ~AliITS(); // destructor
    AliITS(const AliITS &source); // copy constructor. Not to be used!
    AliITS& operator=(AliITS &source); // = operator. Not to be used!
    virtual Int_t IsVersion() const {return 1;}
    virtual Int_t DistancetoPrimitive(Int_t px, Int_t py) const;

    //===================== Simulation Geometry ========================
    // get geometry version - detailed (major) or coarse (minor)
    virtual Int_t GetMajorVersion() const {return -1;}
    virtual Int_t GetMinorVersion() const {return -1;}
    virtual void  GetGeometryVersion(Int_t &a,Int_t &b) 
	                   {a = GetMajorVersion();b=GetMinorVersion();return;}
    virtual void  SetEUCLID(Bool_t euclid=kTRUE) {fEuclidOut = euclid;}
    //-------------------- Geometry Transformations --------------------
    // ITS geometry functions
    AliITSgeom   *GetITSgeom() const {return fITSgeom;}
    // Sets ITS geometry ! be very careful using this function.
    void   SetITSgeom(AliITSgeom *geom) {fITSgeom = geom;}
    // return pointer to the array of modules
    TObjArray    *GetModules() const {return fITSmodules;}
    // return pointer to a particular module
    AliITSmodule *GetModule(Int_t index) {return (AliITSmodule *)
					      (fITSmodules->At(index));}

    //================ Necessary general Classes =======================
    virtual void Init();
    virtual AliLoader* MakeLoader(const char* topfoldername);
    virtual void SetDefaults();
    virtual void SetDefaultSimulation();
    virtual void SetDefaultClusterFinders();
    virtual void MakeBranch(Option_t *opt=" ");
    virtual void SetTreeAddress();
    // For a given branch from the treeH sets the TClonesArray address.
    virtual void SetHitsAddressBranch(TBranch *b) {b->SetAddress(&fHits);}
    // Return pointer to DetType #id
    AliITSDetType *DetType(Int_t id);
    //Int_t           NDetTypes() {return fNDetTypes;}
    //---------- Configuration Methods (per detector type) -------------
    // Determines which ITS subdetectors will be processed. Effects
    // digitization, and Reconstruction only.
    void SetDetectors(Option_t *opt="All"){fOpt = opt;}
    // Returns the list of ITS subdetectors that will be processed.
    Option_t* GetDetectors(){return fOpt;}
    // Set response 
    virtual void SetResponseModel(Int_t id, AliITSresponse *response);
    // Set segmentation 
    virtual void SetSegmentationModel(Int_t id, AliITSsegmentation *seg);
    // Set simulation - temporary 
    virtual void SetSimulationModel(Int_t id, AliITSsimulation *sim);
    // Set simulation - temporary 
    virtual AliITSsimulation* GetSimulationModel(Int_t id){
	return ((AliITSDetType*)(fDetTypes->At(id)))->GetSimulationModel();}
    // Set reconstruction 
    virtual void SetReconstructionModel(Int_t id, AliITSClusterFinder *rec);
    // Set class names for digit and rec point 
    virtual void SetClasses(Int_t id, const char *digit, const char *cluster);

    //=================== Hits =========================================
    virtual void StepManager() {} // See Step Manager for specific geometry.
    virtual void AddHit(Int_t track, Int_t *vol, Float_t *hits);
    //------------ sort hits by module for Digitisation ----------------
    virtual void InitModules(Int_t size,Int_t &nmodules);  
    virtual void FillModules(TTree *treeH, Int_t mask = 0);
    virtual void FillModules(Int_t evnt,Int_t bgrev,Int_t nmodules,
			     Option_t *opt,Text_t *filename);
    virtual void ClearModules();

    //===================== Digitisation ===============================
    void MakeBranchS(const char *file);
    void SetTreeAddressS(TTree *treeS);
    TClonesArray * GetSDigits() { return fSDigits; }
    void MakeBranchInTreeD(TTree *treeD,const char *file=0);
    void MakeBranchD(const char *file){
	MakeBranchInTreeD(gAlice->TreeD(),file);}
    void SetTreeAddressD(TTree *treeD);
    void Hits2SDigits(); // Turn hits into SDigits
    void Hits2PreDigits(); // Turn hits into SDigits
    AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
    void SDigits2Digits(){SDigitsToDigits("All");} // Turn SDigits to Digits
    void SDigitsToDigits(Option_t *opt="All"); // Turn SDigits to Digits
    void Hits2Digits(); // Turn hits straight into Digits.
    //------------------ Internal functions ----------------------------
    // Standard Hits To SDigits function
    void HitsToSDigits(Int_t evNumber,Int_t bgrev,Int_t size,
                 Option_t *add, Option_t *det, Text_t *filename);
    // Standard Hits To SDigits function
    void HitsToPreDigits(Int_t evNumber,Int_t bgrev,Int_t size,
                 Option_t *add, Option_t *det, Text_t *filename);
    // Standard Hits To Digits function
    void HitsToDigits(Int_t evNumber,Int_t bgrev,Int_t size,
                 Option_t *add, Option_t *det, Text_t *filename);
    void ResetSDigits();                  // Resets the Summable digits.
    void ResetDigits();                   // depending on how the
    void ResetDigits(Int_t branch);       // tree will be filled only
    void AddSumDigit(AliITSpListItem &sdig);
    void AddRealDigit(Int_t branch, Int_t *digits);
    void AddSimDigit(Int_t branch, AliITSdigit *d);
    void AddSimDigit(Int_t branch,Float_t phys,Int_t* digits,
		     Int_t* tracks,Int_t *hits,Float_t* trkcharges);
    // Return pointers to digits 
    TObjArray    *Dtype() {return fDtype;}
    Int_t        *Ndtype() {return fNdtype;}
    TClonesArray *DigitsAddress(Int_t id)
	{return ((TClonesArray *) (*fDtype)[id]);}

    //===================== Raw Data IO ================================
    // Write digits into raw data format
    virtual void Digits2RawData() {}
    // Decode raw data and store digits
    virtual void RawData2Digits() {}

    //==================== Clusterization ==============================
    // create separate tree for clusters - declustering refining
    void MakeTreeC(Option_t *option="C");
    void GetTreeC(Int_t event);
    void AddCluster(Int_t branch, AliITSRawCluster *c);
    void ResetClusters();                 // one of the methods in 
    void ResetClusters(Int_t branch);     // the pair will be kept
    // Return pointers to clusters 
    TObjArray    *Ctype() {return fCtype;}
    Int_t        *Nctype() {return fNctype;}
    TClonesArray *ClustersAddress(Int_t id) 
                   {return ((TClonesArray *) (*fCtype)[id]);}

    //=================== Reconstruction ===============================
    void MakeBranchR(const char *file, Option_t *opt=" ");
    void MakeBranchRF(const char *file){MakeBranchR(file,"Fast");}
    void MakeBranchC();
    void SetTreeAddressR(TTree *treeR);
    void AddRecPoint(const AliITSRecPoint &p);
    void HitsToFastRecPoints(Int_t evNumber,Int_t bgrev,Int_t size,
                 Option_t *add, Option_t *det, Text_t *filename);
    void Digits2Reco();
    void DigitsToRecPoints(Int_t evNumber,Int_t lastEntry,Option_t *det);
    void ResetRecPoints();
    // Return pointer to rec points 
    TClonesArray  *RecPoints()   {return fRecPoints;}

    virtual void Reconstruct() const;
    virtual AliTracker* CreateTracker() const;
    virtual void FillESD(AliESD* esd) const;
     
 protected:
    //================== Data Members ==================================
    AliITSgeom   *fITSgeom;    // Pointer to ITS geometry
    Bool_t        fEuclidOut;  // Flag to write geometry in euclid format
    TObjArray    *fITSmodules; //! Pointer to ITS modules
    Option_t     *fOpt;        //! Detector option ="All" unless changed.

    Int_t         fIdN;        // the number of layers
    Int_t        *fIdSens;     //[fIdN] layer identifier
    TString      *fIdName;     //[fIdN] layer identifier

    Int_t         fNDetTypes;  // Number of detector types
    TObjArray    *fDetTypes;   // List of detector types

    TClonesArray  *fSDigits;    //! List of Summable digits.
    Int_t         fNSDigits;   // Number of Summable Digits.

    TObjArray    *fDtype;      //! List of digits
    Int_t        *fNdtype;     //[fNDetTypes] Num. of digits per type of det. 

    TObjArray    *fCtype;      //! List of clusters
    Int_t        *fNctype;     //[fNDetTypes] Num. of clust. per type of det.

    TClonesArray *fRecPoints;  //! List of reconstructed points
    Int_t         fNRecPoints; // Number of rec points

    ClassDef(AliITS,3) // Base class for ITS
};

#endif
Commit	Line	Data
3bd79107	1	#ifndef ALIITS_H
3bd79107	2	#define ALIITS_H
3da30618	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5
	6	/* $Id$ */
	7
58005f18	8	////////////////////////////////////////////////////////////////////////
3bd79107	9	// Manager class for set: ITS //
58005f18	10	////////////////////////////////////////////////////////////////////////
fe4da5cc	11
143d1056	12	#include <TObjArray.h> // used in inline function GetModule.
cd77595e	13	#include <TBranch.h> // used in inline function SetHitsAddressBranch
3bd79107	14
9ad8b5dd	15	#include "AliRun.h"
88cb7938	16	#include "AliLoader.h"
fe4da5cc	17	#include "AliDetector.h"
54b8cf3b	18	#include "AliITSDetType.h"
de82972f	19
d5da1ecf	20	class TString;
d5da1ecf	21	class TTree;
55b5a0b3	22	class TFile;
fe4da5cc	23
54b8cf3b	24	//class AliITSDetType;
3bd79107	25	class AliITSsimulation;
3bd79107	26	class AliITSClusterFinder;
88cb7938	27	class AliITSLoader;
de82972f	28	class AliITSsegmentation;
	29	class AliITSresponse;
	30	class AliITShit;
	31	class AliITSgeom;
2aea926d	32	class AliITSpListItem;
de82972f	33	class AliITSdigit;
	34	class AliITSRecPoint;
	35	class AliITSRawCluster;
	36	class AliITSmodule;
27a043b1	37
a8a6107b	38	const Int_t kNTYPES=3;
de82972f	39
3bd79107	40	class AliITS : public AliDetector {
58005f18	41
2aea926d	42	public:
	43	//================= Standard Classes ===============================
	44	AliITS(); // Default creator.
	45	AliITS(const char name, const char title); // standard Creator
	46	virtual ~AliITS(); // destructor
ac74f489	47	AliITS(const AliITS &source); // copy constructor. Not to be used!
2aea926d	48	AliITS& operator=(AliITS &source); // = operator. Not to be used!
2aea926d	49	virtual Int_t IsVersion() const {return 1;}
93f82b23	50	virtual Int_t DistancetoPrimitive(Int_t px, Int_t py) const;
2aea926d	51
2aea926d	52	//===================== Simulation Geometry ========================
e8189707	53	// get geometry version - detailed (major) or coarse (minor)
93f82b23	54	virtual Int_t GetMajorVersion() const {return -1;}
93f82b23	55	virtual Int_t GetMinorVersion() const {return -1;}
2aea926d	56	virtual void GetGeometryVersion(Int_t &a,Int_t &b)
2aea926d	57	{a = GetMajorVersion();b=GetMinorVersion();return;}
41b19549	58	virtual void SetEUCLID(Bool_t euclid=kTRUE) {fEuclidOut = euclid;}
2aea926d	59	//-------------------- Geometry Transformations --------------------
	60	// ITS geometry functions
	61	AliITSgeom *GetITSgeom() const {return fITSgeom;}
f91c3e58	62	// Sets ITS geometry ! be very careful using this function.
f91c3e58	63	void SetITSgeom(AliITSgeom *geom) {fITSgeom = geom;}
2aea926d	64	// return pointer to the array of modules
	65	TObjArray *GetModules() const {return fITSmodules;}
	66	// return pointer to a particular module
	67	AliITSmodule GetModule(Int_t index) {return (AliITSmodule )
	68	(fITSmodules->At(index));}
3bd79107	69
88cb7938	70	//================ Necessary general Classes =======================
2aea926d	71	virtual void Init();
88cb7938	72	virtual AliLoader* MakeLoader(const char* topfoldername);
2aea926d	73	virtual void SetDefaults();
	74	virtual void SetDefaultSimulation();
	75	virtual void SetDefaultClusterFinders();
88cb7938	76	virtual void MakeBranch(Option_t *opt=" ");
2aea926d	77	virtual void SetTreeAddress();
93f82b23	78	// For a given branch from the treeH sets the TClonesArray address.
93f82b23	79	virtual void SetHitsAddressBranch(TBranch *b) {b->SetAddress(&fHits);}
2aea926d	80	// Return pointer to DetType #id
	81	AliITSDetType *DetType(Int_t id);
	82	//Int_t NDetTypes() {return fNDetTypes;}
	83	//---------- Configuration Methods (per detector type) -------------
7d8046e8	84	// Determines which ITS subdetectors will be processed. Effects
	85	// digitization, and Reconstruction only.
	86	void SetDetectors(Option_t *opt="All"){fOpt = opt;}
	87	// Returns the list of ITS subdetectors that will be processed.
	88	Option_t* GetDetectors(){return fOpt;}
3bd79107	89	// Set response
2aea926d	90	virtual void SetResponseModel(Int_t id, AliITSresponse *response);
3bd79107	91	// Set segmentation
2aea926d	92	virtual void SetSegmentationModel(Int_t id, AliITSsegmentation *seg);
3bd79107	93	// Set simulation - temporary
2aea926d	94	virtual void SetSimulationModel(Int_t id, AliITSsimulation *sim);
54b8cf3b	95	// Set simulation - temporary
	96	virtual AliITSsimulation* GetSimulationModel(Int_t id){
	97	return ((AliITSDetType*)(fDetTypes->At(id)))->GetSimulationModel();}
3bd79107	98	// Set reconstruction
2aea926d	99	virtual void SetReconstructionModel(Int_t id, AliITSClusterFinder *rec);
3bd79107	100	// Set class names for digit and rec point
2aea926d	101	virtual void SetClasses(Int_t id, const char digit, const char cluster);
	102
	103	//=================== Hits =========================================
	104	virtual void StepManager() {} // See Step Manager for specific geometry.
	105	virtual void AddHit(Int_t track, Int_t vol, Float_t hits);
	106	//------------ sort hits by module for Digitisation ----------------
	107	virtual void InitModules(Int_t size,Int_t &nmodules);
b4012daf	108	virtual void FillModules(TTree *treeH, Int_t mask = 0);
2aea926d	109	virtual void FillModules(Int_t evnt,Int_t bgrev,Int_t nmodules,
	110	Option_t opt,Text_t filename);
	111	virtual void ClearModules();
	112
	113	//===================== Digitisation ===============================
	114	void MakeBranchS(const char *file);
	115	void SetTreeAddressS(TTree *treeS);
f91c3e58	116	TClonesArray * GetSDigits() { return fSDigits; }
9ad8b5dd	117	void MakeBranchInTreeD(TTree treeD,const char file=0);
	118	void MakeBranchD(const char *file){
	119	MakeBranchInTreeD(gAlice->TreeD(),file);}
2aea926d	120	void SetTreeAddressD(TTree *treeD);
	121	void Hits2SDigits(); // Turn hits into SDigits
	122	void Hits2PreDigits(); // Turn hits into SDigits
c92eb8ad	123	AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
e0fc0305	124	void SDigits2Digits(){SDigitsToDigits("All");} // Turn SDigits to Digits
e0fc0305	125	void SDigitsToDigits(Option_t *opt="All"); // Turn SDigits to Digits
2aea926d	126	void Hits2Digits(); // Turn hits straight into Digits.
	127	//------------------ Internal functions ----------------------------
	128	// Standard Hits To SDigits function
	129	void HitsToSDigits(Int_t evNumber,Int_t bgrev,Int_t size,
	130	Option_t add, Option_t det, Text_t *filename);
	131	// Standard Hits To SDigits function
	132	void HitsToPreDigits(Int_t evNumber,Int_t bgrev,Int_t size,
	133	Option_t add, Option_t det, Text_t *filename);
	134	// Standard Hits To Digits function
	135	void HitsToDigits(Int_t evNumber,Int_t bgrev,Int_t size,
	136	Option_t add, Option_t det, Text_t *filename);
	137	void ResetSDigits(); // Resets the Summable digits.
	138	void ResetDigits(); // depending on how the
	139	void ResetDigits(Int_t branch); // tree will be filled only
	140	void AddSumDigit(AliITSpListItem &sdig);
	141	void AddRealDigit(Int_t branch, Int_t *digits);
	142	void AddSimDigit(Int_t branch, AliITSdigit *d);
	143	void AddSimDigit(Int_t branch,Float_t phys,Int_t* digits,
	144	Int_t* tracks,Int_t hits,Float_t trkcharges);
	145	// Return pointers to digits
	146	TObjArray *Dtype() {return fDtype;}
	147	Int_t *Ndtype() {return fNdtype;}
	148	TClonesArray *DigitsAddress(Int_t id)
	149	{return ((TClonesArray ) (fDtype)[id]);}
3bd79107	150
2aea926d	151	//===================== Raw Data IO ================================
	152	// Write digits into raw data format
	153	virtual void Digits2RawData() {}
	154	// Decode raw data and store digits
	155	virtual void RawData2Digits() {}
58005f18	156
2aea926d	157	//==================== Clusterization ==============================
	158	// create separate tree for clusters - declustering refining
	159	void MakeTreeC(Option_t *option="C");
	160	void GetTreeC(Int_t event);
	161	void AddCluster(Int_t branch, AliITSRawCluster *c);
	162	void ResetClusters(); // one of the methods in
	163	void ResetClusters(Int_t branch); // the pair will be kept
3bd79107	164	// Return pointers to clusters
2aea926d	165	TObjArray *Ctype() {return fCtype;}
	166	Int_t *Nctype() {return fNctype;}
	167	TClonesArray *ClustersAddress(Int_t id)
3bd79107	168	{return ((TClonesArray ) (fCtype)[id]);}
3bd79107	169
2aea926d	170	//=================== Reconstruction ===============================
ff0e455e	171	void MakeBranchR(const char file, Option_t opt=" ");
ff0e455e	172	void MakeBranchRF(const char *file){MakeBranchR(file,"Fast");}
88cb7938	173	void MakeBranchC();
2aea926d	174	void SetTreeAddressR(TTree *treeR);
	175	void AddRecPoint(const AliITSRecPoint &p);
	176	void HitsToFastRecPoints(Int_t evNumber,Int_t bgrev,Int_t size,
	177	Option_t add, Option_t det, Text_t *filename);
	178	void Digits2Reco();
	179	void DigitsToRecPoints(Int_t evNumber,Int_t lastEntry,Option_t *det);
	180	void ResetRecPoints();
3bd79107	181	// Return pointer to rec points
3bd79107	182	TClonesArray *RecPoints() {return fRecPoints;}
596a855f	183
	184	virtual void Reconstruct() const;
	185	virtual AliTracker* CreateTracker() const;
	186	virtual void FillESD(AliESD* esd) const;
88cb7938	187
2aea926d	188	protected:
	189	//================== Data Members ==================================
	190	AliITSgeom *fITSgeom; // Pointer to ITS geometry
e0fc0305	191	Bool_t fEuclidOut; // Flag to write geometry in euclid format
2aea926d	192	TObjArray *fITSmodules; //! Pointer to ITS modules
7d8046e8	193	Option_t *fOpt; //! Detector option ="All" unless changed.
3bd79107	194
e0fc0305	195	Int_t fIdN; // the number of layers
2aea926d	196	Int_t *fIdSens; //[fIdN] layer identifier
2aea926d	197	TString *fIdName; //[fIdN] layer identifier
3bd79107	198
e0fc0305	199	Int_t fNDetTypes; // Number of detector types
2aea926d	200	TObjArray *fDetTypes; // List of detector types
e8189707	201
88cb7938	202	TClonesArray *fSDigits; //! List of Summable digits.
2aea926d	203	Int_t fNSDigits; // Number of Summable Digits.
55b5a0b3	204
88cb7938	205	TObjArray *fDtype; //! List of digits
2aea926d	206	Int_t *fNdtype; //[fNDetTypes] Num. of digits per type of det.
3bd79107	207
88cb7938	208	TObjArray *fCtype; //! List of clusters
2aea926d	209	Int_t *fNctype; //[fNDetTypes] Num. of clust. per type of det.
3bd79107	210
88cb7938	211	TClonesArray *fRecPoints; //! List of reconstructed points
2aea926d	212	Int_t fNRecPoints; // Number of rec points
3bd79107	213
88cb7938	214	ClassDef(AliITS,3) // Base class for ITS
fe4da5cc	215	};
3bd79107	216
fe4da5cc	217	#endif