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

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

#include <TNtuple.h>
#include <TArrayF.h>

#include "AliITSsimulation.h"

class TH1F;
class TFile;
class TVector;
class TArrayI;
class TArrayF;
class AliITS;
class AliITSpList;
class AliITSMap;
class AliITSMapA1;
class AliITSMapA2;
class AliITSetfSDD;
class AliITSsegmentationSDD;
class AliITSInStream;
class AliITSresponse;
class AliITSresponseSDD;

class AliITSsimulationSDD : public AliITSsimulation {

 public:
    AliITSsimulationSDD(); // default constructor
    //Standard Constructor
    AliITSsimulationSDD(AliITSsegmentation *seg, AliITSresponse *res);
    // Copy opporator
    AliITSsimulationSDD(AliITSsimulationSDD &source);
    virtual ~AliITSsimulationSDD(); // Destructor
    // = opporator
    AliITSsimulationSDD& operator=(AliITSsimulationSDD &source);
    // Initilize variables for this simulation
    void Init(AliITSsegmentationSDD *seg,AliITSresponseSDD *resp);

    // get the address of the array mapping the signal or pointers to arrays
//    virtual AliITSMap*  HitMap(Int_t i);

    // set the scale size factor for the smples in FFT
    virtual void SetScaleFourier(Int_t scale=4) {fScaleSize=scale;}
    Int_t ScaleFourier() const {return fScaleSize;} // returns the scale factor
    // set perpendicular tracks flag
    virtual void SetPerpendTracksFlag(Bool_t flag=kFALSE) {fFlag=flag;}
    // returns perpendicular track flag.
    Bool_t PerpendTracksFlag() const {return fFlag;} 
    // set crosstalk flag
    virtual void SetCrosstalkFlag(Bool_t flag=kFALSE) {fCrosstalkFlag=flag;}
    // return crosstalk flag
    Bool_t CrosstalkFlag() const {return fCrosstalkFlag;}
    // set compression parameters for 2D or 1D via response functions
    void SetCompressParam();
    // retrieve compression parameters for 2D or 1D
    void CompressionParam(Int_t i, Int_t &db, Int_t &tl, Int_t &th);
    // retrieve compression parameters for 2D or 1D
    void CompressionParam(Int_t i, Int_t &db, Int_t &tl);

    virtual Int_t Convert10to8(Int_t signal) const;// 10 to 8 bit SDD compresion
    virtual Int_t Convert8to10(Int_t signal) const;//undo 10 to 8 bit SDD compresion
    virtual void ZeroSuppression(const char *opt); // Apply zero suppresion
    virtual void Init2D();   // initiilzes 2D compresion algorithm
    virtual void Compress2D(); // Applies 2D compresion algorithm
    virtual void Init1D();   // initilizes 1D compresion algorithm
    virtual void Compress1D(); // Applies 1D compresion algorithm
    virtual void StoreAllDigits(); // if No compresion run this.
    virtual void ReadBaseline();  // read baseline values from a file
    // returns baseline and noise for a given anode i.
    virtual void GetAnodeBaseline(Int_t i, Float_t &baseline, Float_t &noise);
    // local implementation of ITS->AddDigit. Specific for SDD
    virtual void AddDigit(Int_t i, Int_t j, Int_t signal);
    // Finds clulsters of signals. Use with regards to Compresion algorithms
    virtual void  FindCluster(Int_t i, Int_t j,Int_t signal,
			      Int_t minval,Bool_t &cond);

    // get parameters for 1D - this could be changed when we get more
    // input from Torino after they have a look at the code 
    virtual Int_t Tolerance(Int_t i) {return fTol[i];}//returns tolerance
    virtual Int_t Disable(Int_t i)  {return fT2[i];}//high threshold  2D
    // Set the output file name - for 1D encoding 
    virtual void SetFileName(const char *filnam) {fFileName=filnam;}

    // add baseline, noise, electronics and ADC saturation effects
    void ChargeToSignal(Bool_t bAddNoise=kFALSE);
    // add dead channels
    void ApplyDeadChannels();
    // add crosstalk effect
    void ApplyCrosstalk();
    
    // create maps to build the lists of tracks for each summable digit
    void InitSimulationModule( Int_t module, Int_t event );
    // clear maps
    void ClearMaps();
    // Summable Digitses a SDD module
    void SDigitiseModule(AliITSmodule *mod,Int_t md,Int_t ev);
    // Add Summable digits to module maps.
    Bool_t AddSDigitsToModule( TClonesArray *pItemArray, Int_t mask );
    // digitize module from the sum of summable digits.
    void FinishSDigitiseModule();
    // Writes summable digits
    void WriteSDigits();
    // Introduces electronics effects and does zero-suppresion if required
    void FinishDigits();
    // Digitses a SDD module
    void DigitiseModule(AliITSmodule *mod,Int_t md,Int_t ev);
    // Spread charge in a SDD module
    void HitsToAnalogDigits(AliITSmodule *mod);
    // Sorts tracks for the 3 most highly contributed one to be added to digit.
    //void SortTracks(Int_t *tracks,Float_t *charges,Int_t *hits,Int_t ntracks);
    // collects and returns the fired SDD cells (uses AliITSMapA2...).
    //void ListOfFiredCells(Int_t *arg,Double_t timeAmplitude,TObjArray *list,
	//		  TClonesArray *padr);

    // Creates histograms of maps for debugging
    void CreateHistograms(Int_t scale);
    // Fills histograms of maps for debugging
    void FillHistograms();
    // Resets histograms of maps for debugging
    void ResetHistograms();
    // Get the pointer to the array of histograms
    TObjArray*  GetHistArray() {return fHis;}
    // create a separate tree for background monitoring (2D) 
    virtual  void  MakeTreeB(Option_t *option="B") 
	{ fTreeB = new TNtuple("ntuple","2D backgr","nz:nl:nh:low:anode");}
    // presently a dummy routine use TreeB() instead
    void GetTreeB(Int_t) { }
    // Return pointer to TreeB
    TNtuple *TreeB() {return fTreeB;}
    void WriteToFile(TFile *fp);// Writes the histograms to a file
    // Get's histogram of a particular anode.
    TH1F *GetAnode(Int_t wing, Int_t anode);

    // Sets the check noise flag.
    void SetCheckNoise(Bool_t check=kFALSE) {fCheckNoise=check;}
    // Returns the noise value
    Float_t GetNoise();
    // sets DoFFT value.
    void SetDoFFT(Int_t doFFT=1) {fDoFFT=doFFT;}

    // Print SSD simulation Parameters
    virtual void Print();

 private:
    // Variables and pointers for local use only. Not Streamed out.
    AliITS         *fITS;          //! local pointer to ITS
//    AliITSMapA1    *fHitMap1;      //! local pointer to map of digits
    AliITSMapA2    *fHitMap2;      //! local pointer to map of signals
    AliITSMapA2    *fHitSigMap2;   //! local pointer to map of signals
    AliITSMapA2    *fHitNoiMap2;   //! local pointer to map of signals
//    AliITSpList    *fpList;        //! 
//    TObjArray      *falist;        //
//    TClonesArray   *fpadr;         //
    AliITSInStream *fStream;       //! input file stream
    AliITSetfSDD   *fElectronics;  //! local pointer to electronics simulation
    Double_t       *fInZR;         //! [fScaleSize*fMaxNofSamples] input of the
                                   // real part of FFT
    Double_t       *fInZI;         //! [fScaleSize*fMaxNofSamples] 
                                   // input of the imaginary part of FFT
    Double_t       *fOutZR;        //! [fScaleSize*fMaxNofSamples] 
                                   // output of the real part of FFT
    Double_t       *fOutZI;        //! [fScaleSize*fMaxNofSamples] 
                                   // output of the imaginary part of FFT
    Bool_t         *fAnodeFire;     //! [#of anodes] Flag if there is a signal

    TObjArray *fHis;          // just in case for histogramming
    TArrayI    fD;            // decrease values for baseline eq.
    TArrayI    fT1;           // low thresholds
    TArrayI    fT2;           // high thresholds(2D) or disable (1D) 
    TArrayI    fTol;          // tolerance
    TArrayF    fBaseline;     // Baseline
    TArrayF    fNoise;        // Noise value
    TNtuple   *fTreeB;        // Background info tree for 2D
    TString    fParam;        // Compresion algorithm options
    TString    fFileName;     // File name for possible options above
    Bool_t     fFlag;         // Flag used to simulate perpendicular tracks
    Bool_t     fCheckNoise;   // Flag used to check the simulated noise
    Bool_t     fCrosstalkFlag; // Flag used to apply the crosstalk effect
    Int_t      fDoFFT;        // Flag used to switch off electronics when 0
    Int_t      fNofMaps;      // Number of anodes used ( 1-2*nanodes per wing )
    Int_t      fMaxNofSamples;// Number of time samples
    Int_t      fScaleSize;    // scale size factor for the samples in FFT
//    Int_t      fModule;       //! in case bgr,noise,param,change module-by-mod.
//    Int_t      fEvent;        //! solely for output from bgr monitoring of 2D

  ClassDef(AliITSsimulationSDD,1)  // Simulation of SDD clusters

};
#endif
Commit	Line	Data
b0f5e3fc	1	#ifndef ALIITSSIMULATIONSDD_H
b0f5e3fc	2	#define ALIITSSIMULATIONSDD_H
8a33ae9e	3	/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
	4	* See cxx source for full Copyright notice */
	5	/* $Id$ */
1ca7869b	6
b0f5e3fc	7	#include <TNtuple.h>
1ca7869b	8	#include <TArrayF.h>
1ca7869b	9
b0f5e3fc	10	#include "AliITSsimulation.h"
b0f5e3fc	11
1ca7869b	12	class TH1F;
	13	class TFile;
	14	class TVector;
	15	class TArrayI;
	16	class TArrayF;
e8189707	17	class AliITS;
c7a4dac0	18	class AliITSpList;
e8189707	19	class AliITSMap;
	20	class AliITSMapA1;
	21	class AliITSMapA2;
b0f5e3fc	22	class AliITSetfSDD;
c7a4dac0	23	class AliITSsegmentationSDD;
e8189707	24	class AliITSInStream;
1ca7869b	25	class AliITSresponse;
c7a4dac0	26	class AliITSresponseSDD;
b0f5e3fc	27
b0f5e3fc	28	class AliITSsimulationSDD : public AliITSsimulation {
b0f5e3fc	29
8a33ae9e	30	public:
	31	AliITSsimulationSDD(); // default constructor
	32	//Standard Constructor
	33	AliITSsimulationSDD(AliITSsegmentation seg, AliITSresponse res);
	34	// Copy opporator
	35	AliITSsimulationSDD(AliITSsimulationSDD &source);
	36	virtual ~AliITSsimulationSDD(); // Destructor
	37	// = opporator
	38	AliITSsimulationSDD& operator=(AliITSsimulationSDD &source);
c7a4dac0	39	// Initilize variables for this simulation
c7a4dac0	40	void Init(AliITSsegmentationSDD seg,AliITSresponseSDD resp);
8a33ae9e	41
8a33ae9e	42	// get the address of the array mapping the signal or pointers to arrays
50d05d7b	43	// virtual AliITSMap* HitMap(Int_t i);
8a33ae9e	44
	45	// set the scale size factor for the smples in FFT
	46	virtual void SetScaleFourier(Int_t scale=4) {fScaleSize=scale;}
	47	Int_t ScaleFourier() const {return fScaleSize;} // returns the scale factor
	48	// set perpendicular tracks flag
	49	virtual void SetPerpendTracksFlag(Bool_t flag=kFALSE) {fFlag=flag;}
	50	// returns perpendicular track flag.
	51	Bool_t PerpendTracksFlag() const {return fFlag;}
50d05d7b	52	// set crosstalk flag
	53	virtual void SetCrosstalkFlag(Bool_t flag=kFALSE) {fCrosstalkFlag=flag;}
	54	// return crosstalk flag
	55	Bool_t CrosstalkFlag() const {return fCrosstalkFlag;}
8a33ae9e	56	// set compression parameters for 2D or 1D via response functions
	57	void SetCompressParam();
	58	// retrieve compression parameters for 2D or 1D
	59	void CompressionParam(Int_t i, Int_t &db, Int_t &tl, Int_t &th);
	60	// retrieve compression parameters for 2D or 1D
	61	void CompressionParam(Int_t i, Int_t &db, Int_t &tl);
	62
	63	virtual Int_t Convert10to8(Int_t signal) const;// 10 to 8 bit SDD compresion
	64	virtual Int_t Convert8to10(Int_t signal) const;//undo 10 to 8 bit SDD compresion
	65	virtual void ZeroSuppression(const char *opt); // Apply zero suppresion
	66	virtual void Init2D(); // initiilzes 2D compresion algorithm
	67	virtual void Compress2D(); // Applies 2D compresion algorithm
	68	virtual void Init1D(); // initilizes 1D compresion algorithm
	69	virtual void Compress1D(); // Applies 1D compresion algorithm
	70	virtual void StoreAllDigits(); // if No compresion run this.
	71	virtual void ReadBaseline(); // read baseline values from a file
	72	// returns baseline and noise for a given anode i.
	73	virtual void GetAnodeBaseline(Int_t i, Float_t &baseline, Float_t &noise);
	74	// local implementation of ITS->AddDigit. Specific for SDD
	75	virtual void AddDigit(Int_t i, Int_t j, Int_t signal);
	76	// Finds clulsters of signals. Use with regards to Compresion algorithms
	77	virtual void FindCluster(Int_t i, Int_t j,Int_t signal,
	78	Int_t minval,Bool_t &cond);
	79
	80	// get parameters for 1D - this could be changed when we get more
	81	// input from Torino after they have a look at the code
	82	virtual Int_t Tolerance(Int_t i) {return fTol[i];}//returns tolerance
	83	virtual Int_t Disable(Int_t i) {return fT2[i];}//high threshold 2D
	84	// Set the output file name - for 1D encoding
	85	virtual void SetFileName(const char *filnam) {fFileName=filnam;}
	86
	87	// add baseline, noise, electronics and ADC saturation effects
48058160	88	void ChargeToSignal(Bool_t bAddNoise=kFALSE);
50d05d7b	89	// add dead channels
	90	void ApplyDeadChannels();
	91	// add crosstalk effect
	92	void ApplyCrosstalk();
	93
	94	// create maps to build the lists of tracks for each summable digit
	95	void InitSimulationModule( Int_t module, Int_t event );
	96	// clear maps
	97	void ClearMaps();
c7a4dac0	98	// Summable Digitses a SDD module
c7a4dac0	99	void SDigitiseModule(AliITSmodule *mod,Int_t md,Int_t ev);
48058160	100	// Add Summable digits to module maps.
48058160	101	Bool_t AddSDigitsToModule( TClonesArray *pItemArray, Int_t mask );
50d05d7b	102	// digitize module from the sum of summable digits.
50d05d7b	103	void FinishSDigitiseModule();
c7a4dac0	104	// Writes summable digits
50d05d7b	105	void WriteSDigits();
c7a4dac0	106	// Introduces electronics effects and does zero-suppresion if required
50d05d7b	107	void FinishDigits();
8a33ae9e	108	// Digitses a SDD module
8a33ae9e	109	void DigitiseModule(AliITSmodule *mod,Int_t md,Int_t ev);
c7a4dac0	110	// Spread charge in a SDD module
50d05d7b	111	void HitsToAnalogDigits(AliITSmodule *mod);
8a33ae9e	112	// Sorts tracks for the 3 most highly contributed one to be added to digit.
50d05d7b	113	//void SortTracks(Int_t tracks,Float_t charges,Int_t *hits,Int_t ntracks);
8a33ae9e	114	// collects and returns the fired SDD cells (uses AliITSMapA2...).
50d05d7b	115	//void ListOfFiredCells(Int_t arg,Double_t timeAmplitude,TObjArray list,
50d05d7b	116	// TClonesArray *padr);
8a33ae9e	117
	118	// Creates histograms of maps for debugging
	119	void CreateHistograms(Int_t scale);
	120	// Fills histograms of maps for debugging
	121	void FillHistograms();
	122	// Resets histograms of maps for debugging
	123	void ResetHistograms();
	124	// Get the pointer to the array of histograms
	125	TObjArray* GetHistArray() {return fHis;}
	126	// create a separate tree for background monitoring (2D)
	127	virtual void MakeTreeB(Option_t *option="B")
	128	{ fTreeB = new TNtuple("ntuple","2D backgr","nz:nl:nh:low:anode");}
	129	// presently a dummy routine use TreeB() instead
	130	void GetTreeB(Int_t) { }
	131	// Return pointer to TreeB
	132	TNtuple *TreeB() {return fTreeB;}
	133	void WriteToFile(TFile *fp);// Writes the histograms to a file
	134	// Get's histogram of a particular anode.
	135	TH1F *GetAnode(Int_t wing, Int_t anode);
	136
	137	// Sets the check noise flag.
	138	void SetCheckNoise(Bool_t check=kFALSE) {fCheckNoise=check;}
	139	// Returns the noise value
	140	Float_t GetNoise();
	141	// sets DoFFT value.
	142	void SetDoFFT(Int_t doFFT=1) {fDoFFT=doFFT;}
	143
	144	// Print SSD simulation Parameters
	145	virtual void Print();
	146
	147	private:
	148	// Variables and pointers for local use only. Not Streamed out.
	149	AliITS *fITS; //! local pointer to ITS
50d05d7b	150	// AliITSMapA1 *fHitMap1; //! local pointer to map of digits
8a33ae9e	151	AliITSMapA2 *fHitMap2; //! local pointer to map of signals
48058160	152	AliITSMapA2 *fHitSigMap2; //! local pointer to map of signals
48058160	153	AliITSMapA2 *fHitNoiMap2; //! local pointer to map of signals
50d05d7b	154	// AliITSpList *fpList; //!
	155	// TObjArray *falist; //
	156	// TClonesArray *fpadr; //
8a33ae9e	157	AliITSInStream *fStream; //! input file stream
	158	AliITSetfSDD *fElectronics; //! local pointer to electronics simulation
	159	Double_t fInZR; //! [fScaleSizefMaxNofSamples] input of the
	160	// real part of FFT
	161	Double_t fInZI; //! [fScaleSizefMaxNofSamples]
	162	// input of the imaginary part of FFT
	163	Double_t fOutZR; //! [fScaleSizefMaxNofSamples]
	164	// output of the real part of FFT
	165	Double_t fOutZI; //! [fScaleSizefMaxNofSamples]
	166	// output of the imaginary part of FFT
43217ad9	167	Bool_t *fAnodeFire; //! [#of anodes] Flag if there is a signal
8a33ae9e	168
	169	TObjArray *fHis; // just in case for histogramming
	170	TArrayI fD; // decrease values for baseline eq.
	171	TArrayI fT1; // low thresholds
	172	TArrayI fT2; // high thresholds(2D) or disable (1D)
	173	TArrayI fTol; // tolerance
	174	TArrayF fBaseline; // Baseline
	175	TArrayF fNoise; // Noise value
	176	TNtuple *fTreeB; // Background info tree for 2D
	177	TString fParam; // Compresion algorithm options
	178	TString fFileName; // File name for possible options above
	179	Bool_t fFlag; // Flag used to simulate perpendicular tracks
	180	Bool_t fCheckNoise; // Flag used to check the simulated noise
50d05d7b	181	Bool_t fCrosstalkFlag; // Flag used to apply the crosstalk effect
8a33ae9e	182	Int_t fDoFFT; // Flag used to switch off electronics when 0
	183	Int_t fNofMaps; // Number of anodes used ( 1-2*nanodes per wing )
	184	Int_t fMaxNofSamples;// Number of time samples
	185	Int_t fScaleSize; // scale size factor for the samples in FFT
50d05d7b	186	// Int_t fModule; //! in case bgr,noise,param,change module-by-mod.
50d05d7b	187	// Int_t fEvent; //! solely for output from bgr monitoring of 2D
95d1e92f	188
b0f5e3fc	189	ClassDef(AliITSsimulationSDD,1) // Simulation of SDD clusters
8a33ae9e	190
b0f5e3fc	191	};
b0f5e3fc	192	#endif