[u/mrichter/AliRoot.git] / HBTAN / AliHBTAnalysis.h

#ifndef ALIHBTANALYSIS_H
#define ALIHBTANALYSIS_H
//_________________________________________________________
////////////////////////////////////////////////////////////////////////////
//
// class AliHBTAnalysis
//
// Central Object Of HBTAnalyser: 
// This class performs main looping within HBT Analysis
// User must plug a reader of Type AliHBTReader
// User plugs in coorelation and monitor functions
// as well as monitor functions
//
// HBT Analysis Tool, which is integral part of AliRoot,
// ALICE Off-Line framework:
//
// Piotr.Skowronski@cern.ch
// more info: http://alisoft.cern.ch/people/skowron/analyzer/index.html
//
////////////////////////////////////////////////////////////////////////////
//_________________________________________________________

#include <TObject.h>
#include "AliHBTPairCut.h"
#include "AliHBTParticleCut.h"

class AliHBTCut;
class AliHBTPair;

class AliHBTRun;
class AliHBTEvent;
class AliHBTReader;
class AliHBTOnePairFctn;      
class AliHBTTwoPairFctn;

class AliHBTMonOneParticleFctn;
class AliHBTMonTwoParticleFctn;

class TList;

class AliHBTAnalysis: public TObject
 {
   public:
     AliHBTAnalysis();
     AliHBTAnalysis(const AliHBTAnalysis& in);
     AliHBTAnalysis& operator=(const AliHBTAnalysis& /*right*/);
     virtual ~AliHBTAnalysis();

     virtual void Process(Option_t* option = "TracksAndParticles");
     
     void SetGlobalPairCut(AliHBTPairCut* cut);
     
     void AddTrackFunction(AliHBTOnePairFctn* f);
     void AddParticleFunction(AliHBTOnePairFctn* f);
     void AddParticleAndTrackFunction(AliHBTTwoPairFctn* f);
     
     void AddParticleMonitorFunction(AliHBTMonOneParticleFctn* f);    //z.ch.
     void AddTrackMonitorFunction(AliHBTMonOneParticleFctn* f);    //z.ch.
     void AddParticleAndTrackMonitorFunction(AliHBTMonTwoParticleFctn* f);//z.ch.

     void AddResolutionFunction(AliHBTTwoPairFctn* f){AddParticleAndTrackFunction(f);}
     
     void SetReader(AliHBTReader* r){fReader = r;}
     
     void WriteFunctions();
     
     void SetBufferSize(Int_t buffsize){fBufferSize=buffsize;}
     void SetOwner(Bool_t owner=kTRUE){fIsOwner=owner;}
     Bool_t IsOwner() const {return fIsOwner;}
     Bool_t IsNonIdentAnalysis();
     void   Init();
     void   ResetFunctions();
     void   SetDisplayInfo(Int_t howoften){fDisplayMixingInfo = howoften;}//defines every each line info about mixing is displayed
     
     void   SetCutsOnParticles(); // -- aplies only to Process Tracks And Particles
     void   SetCutsOnTracks();// -- aplies only to Process Tracks And Particles
     void   SetCutsOnTracksAndParticles();// Default // -- aplies only to Process Tracks And Particles
     
     static void PressAnyKey();//small utility function that helps to make comfortable macros
   protected:
     
     Bool_t RunCoherencyCheck();
     
     void FilterOut(AliHBTEvent* outpart1, AliHBTEvent* outpart2, AliHBTEvent* inpart,
                    AliHBTEvent* outtrack1, AliHBTEvent* outtrack2, AliHBTEvent* intrack)const;
     void FilterOut(AliHBTEvent* out1, AliHBTEvent* out2, AliHBTEvent* in)const;
     void DeleteFunctions();
     
     virtual void ProcessTracks();
     virtual void ProcessParticles();
     virtual void ProcessTracksAndParticles();
     
     virtual void ProcessTracksAndParticlesNonIdentAnal();
     virtual void ProcessParticlesNonIdentAnal();
     virtual void ProcessTracksNonIdentAnal();

     AliHBTReader* fReader;//! Pointer to reader
     
     UInt_t fNTrackFunctions; //! Number of Tracks functions 
     UInt_t fNParticleFunctions; //! Number of particles functions
     UInt_t fNParticleAndTrackFunctions; //! Number of resolution functions
		
     UInt_t fNTrackMonitorFunctions; //! Number of Track Monitor functions 
     UInt_t fNParticleMonitorFunctions; //! Number of Particles Monitor functions 
     UInt_t fNParticleAndTrackMonitorFunctions; //! Number of Resolution Monitor functions 

     AliHBTOnePairFctn**  fTrackFunctions; //!array of pointers to functions that analyze rekonstructed tracks
     AliHBTOnePairFctn**  fParticleFunctions; //!array of pointers to functions that analyze generated particles
     AliHBTTwoPairFctn**  fParticleAndTrackFunctions; //!array of pointers to functions that analyze both 
                                        //reconstructed tracks and generated particles
		//i.e. - resolution analyzers
     AliHBTMonOneParticleFctn**  fParticleMonitorFunctions; //! array of pointers to monitoring functions
     AliHBTMonOneParticleFctn**  fTrackMonitorFunctions; //! which are used for single particle analysis,
     AliHBTMonTwoParticleFctn**  fParticleAndTrackMonitorFunctions;  //! cut monitoring, etc.


     /**********************************************/
     /* Control parameters  */
     /**********************************************/

     AliHBTPairCut*          fPairCut;//! Pair cut applied for all mixed particles
      
     Int_t  fBufferSize; //!defines the size of buffer for mixed events; -1==MIX All
     Int_t  fDisplayMixingInfo;//!defines every which particle mixing info is displayed
     Bool_t fIsOwner;//!defines of all functions are supposed to be deleted while by the way of analysis defaulr false

   private:
     Bool_t (AliHBTAnalysis::*fkPass)(AliHBTPair* partpair, AliHBTPair* trackpair) const;//Pointer to function that performes pair cut
     Bool_t (AliHBTAnalysis::*fkPass1)(AliHBTParticle* partpair, AliHBTParticle* trackpair) const;//Pointer to function that performes cut on first particle
     Bool_t (AliHBTAnalysis::*fkPass2)(AliHBTParticle* partpair, AliHBTParticle* trackpair) const;//Pointer to function that performes cut on second particle
     Bool_t (AliHBTAnalysis::*fkPassPairProp)(AliHBTPair* partpair, AliHBTPair* trackpair) const;//Pointer to function that performes pair cut
     
     Bool_t PassPartAndTrack (AliHBTPair* partpair, AliHBTPair* trackpair) const {return (fPairCut->Pass(partpair))?kTRUE:fPairCut->Pass(trackpair);}
     Bool_t PassPartAndTrack1(AliHBTParticle* part, AliHBTParticle* track) const;
     Bool_t PassPartAndTrack2(AliHBTParticle* part, AliHBTParticle* track) const;
     Bool_t PassPairPropPartAndTrack (AliHBTPair* partpair, AliHBTPair* trackpair) const {return (fPairCut->PassPairProp(partpair))?kTRUE:fPairCut->PassPairProp(trackpair);}
     
     Bool_t PassPart (AliHBTPair* partpair, AliHBTPair* /*trackpair*/) const{return fPairCut->Pass(partpair);}
     Bool_t PassPart1(AliHBTParticle* part, AliHBTParticle* /*track*/) const{return fPairCut->GetFirstPartCut()->Pass(part);}
     Bool_t PassPart2(AliHBTParticle* part, AliHBTParticle* /*track*/) const{return fPairCut->GetSecondPartCut()->Pass(part);}
     Bool_t PassPairPropPart (AliHBTPair* partpair, AliHBTPair* /*trackpair*/) const{return fPairCut->PassPairProp(partpair);}
     
     Bool_t PassTrack (AliHBTPair* /*partpair*/, AliHBTPair* trackpair) const{return fPairCut->Pass(trackpair);}
     Bool_t PassTrack1(AliHBTParticle* /*part*/, AliHBTParticle* track) const{return fPairCut->GetFirstPartCut()->Pass(track);}
     Bool_t PassTrack2(AliHBTParticle* /*part*/, AliHBTParticle* track) const{return fPairCut->GetSecondPartCut()->Pass(track);}
     Bool_t PassPairPropTrack (AliHBTPair* /*partpair*/, AliHBTPair* trackpair) const{return fPairCut->PassPairProp(trackpair);}

     static const UInt_t fgkFctnArraySize;//!
     static const UInt_t fgkDefaultMixingInfo;//!
     static const Int_t  fgkDefaultBufferSize;//!

     ClassDef(AliHBTAnalysis,0)
 };
 
inline Bool_t AliHBTAnalysis::PassPartAndTrack1(AliHBTParticle* part,AliHBTParticle* track) const
{
//Checks first particle from both, particle and track pairs
  AliHBTParticleCut* pc = fPairCut->GetFirstPartCut();
  return (pc->Pass(part))?kTRUE:pc->Pass(track);
}
/*************************************************************************************/ 
inline Bool_t AliHBTAnalysis::PassPartAndTrack2(AliHBTParticle* part,AliHBTParticle* track) const
{
//Checks second particle from both, particle and track pairs
  AliHBTParticleCut* pc = fPairCut->GetSecondPartCut();
  return (pc->Pass(part))?kTRUE:pc->Pass(track);
}
/*************************************************************************************/ 
 
#endif
Commit	Line	Data
	1	#ifndef ALIHBTANALYSIS_H
	2	#define ALIHBTANALYSIS_H
	3	//_________________________________________________________
	4	////////////////////////////////////////////////////////////////////////////
	5	//
	6	// class AliHBTAnalysis
	7	//
	8	// Central Object Of HBTAnalyser:
	9	// This class performs main looping within HBT Analysis
	10	// User must plug a reader of Type AliHBTReader
	11	// User plugs in coorelation and monitor functions
	12	// as well as monitor functions
	13	//
	14	// HBT Analysis Tool, which is integral part of AliRoot,
	15	// ALICE Off-Line framework:
	16	//
	17	// Piotr.Skowronski@cern.ch
	18	// more info: http://alisoft.cern.ch/people/skowron/analyzer/index.html
	19	//
	20	////////////////////////////////////////////////////////////////////////////
	21	//_________________________________________________________
	22
	23	#include <TObject.h>
	24	#include "AliHBTPairCut.h"
	25	#include "AliHBTParticleCut.h"
	26
	27	class AliHBTCut;
	28	class AliHBTPair;
	29
	30	class AliHBTRun;
	31	class AliHBTEvent;
	32	class AliHBTReader;
	33	class AliHBTOnePairFctn;
	34	class AliHBTTwoPairFctn;
	35
	36	class AliHBTMonOneParticleFctn;
	37	class AliHBTMonTwoParticleFctn;
	38
	39	class TList;
	40
	41	class AliHBTAnalysis: public TObject
	42	{
	43	public:
	44	AliHBTAnalysis();
	45	AliHBTAnalysis(const AliHBTAnalysis& in);
	46	AliHBTAnalysis& operator=(const AliHBTAnalysis& /right/);
	47	virtual ~AliHBTAnalysis();
	48
	49	virtual void Process(Option_t* option = "TracksAndParticles");
	50
	51	void SetGlobalPairCut(AliHBTPairCut* cut);
	52
	53	void AddTrackFunction(AliHBTOnePairFctn* f);
	54	void AddParticleFunction(AliHBTOnePairFctn* f);
	55	void AddParticleAndTrackFunction(AliHBTTwoPairFctn* f);
	56
	57	void AddParticleMonitorFunction(AliHBTMonOneParticleFctn* f); //z.ch.
	58	void AddTrackMonitorFunction(AliHBTMonOneParticleFctn* f); //z.ch.
	59	void AddParticleAndTrackMonitorFunction(AliHBTMonTwoParticleFctn* f);//z.ch.
	60
	61	void AddResolutionFunction(AliHBTTwoPairFctn* f){AddParticleAndTrackFunction(f);}
	62
	63	void SetReader(AliHBTReader* r){fReader = r;}
	64
	65	void WriteFunctions();
	66
	67	void SetBufferSize(Int_t buffsize){fBufferSize=buffsize;}
	68	void SetOwner(Bool_t owner=kTRUE){fIsOwner=owner;}
	69	Bool_t IsOwner() const {return fIsOwner;}
	70	Bool_t IsNonIdentAnalysis();
	71	void Init();
	72	void ResetFunctions();
	73	void SetDisplayInfo(Int_t howoften){fDisplayMixingInfo = howoften;}//defines every each line info about mixing is displayed
	74
	75	void SetCutsOnParticles(); // -- aplies only to Process Tracks And Particles
	76	void SetCutsOnTracks();// -- aplies only to Process Tracks And Particles
	77	void SetCutsOnTracksAndParticles();// Default // -- aplies only to Process Tracks And Particles
	78
	79	static void PressAnyKey();//small utility function that helps to make comfortable macros
	80	protected:
	81
	82	Bool_t RunCoherencyCheck();
	83
	84	void FilterOut(AliHBTEvent* outpart1, AliHBTEvent* outpart2, AliHBTEvent* inpart,
	85	AliHBTEvent* outtrack1, AliHBTEvent* outtrack2, AliHBTEvent* intrack)const;
	86	void FilterOut(AliHBTEvent* out1, AliHBTEvent* out2, AliHBTEvent* in)const;
	87	void DeleteFunctions();
	88
	89	virtual void ProcessTracks();
	90	virtual void ProcessParticles();
	91	virtual void ProcessTracksAndParticles();
	92
	93	virtual void ProcessTracksAndParticlesNonIdentAnal();
	94	virtual void ProcessParticlesNonIdentAnal();
	95	virtual void ProcessTracksNonIdentAnal();
	96
	97	AliHBTReader* fReader;//! Pointer to reader
	98
	99	UInt_t fNTrackFunctions; //! Number of Tracks functions
	100	UInt_t fNParticleFunctions; //! Number of particles functions
	101	UInt_t fNParticleAndTrackFunctions; //! Number of resolution functions
	102
	103	UInt_t fNTrackMonitorFunctions; //! Number of Track Monitor functions
	104	UInt_t fNParticleMonitorFunctions; //! Number of Particles Monitor functions
	105	UInt_t fNParticleAndTrackMonitorFunctions; //! Number of Resolution Monitor functions
	106
	107	AliHBTOnePairFctn** fTrackFunctions; //!array of pointers to functions that analyze rekonstructed tracks
	108	AliHBTOnePairFctn** fParticleFunctions; //!array of pointers to functions that analyze generated particles
	109	AliHBTTwoPairFctn** fParticleAndTrackFunctions; //!array of pointers to functions that analyze both
	110	//reconstructed tracks and generated particles
	111	//i.e. - resolution analyzers
	112	AliHBTMonOneParticleFctn** fParticleMonitorFunctions; //! array of pointers to monitoring functions
	113	AliHBTMonOneParticleFctn** fTrackMonitorFunctions; //! which are used for single particle analysis,
	114	AliHBTMonTwoParticleFctn** fParticleAndTrackMonitorFunctions; //! cut monitoring, etc.
	115
	116
	117	/**********************************************/
	118	/* Control parameters */
	119	/**********************************************/
	120
	121	AliHBTPairCut* fPairCut;//! Pair cut applied for all mixed particles
	122
	123	Int_t fBufferSize; //!defines the size of buffer for mixed events; -1==MIX All
	124	Int_t fDisplayMixingInfo;//!defines every which particle mixing info is displayed
	125	Bool_t fIsOwner;//!defines of all functions are supposed to be deleted while by the way of analysis defaulr false
	126
	127	private:
	128	Bool_t (AliHBTAnalysis::fkPass)(AliHBTPair partpair, AliHBTPair* trackpair) const;//Pointer to function that performes pair cut
	129	Bool_t (AliHBTAnalysis::fkPass1)(AliHBTParticle partpair, AliHBTParticle* trackpair) const;//Pointer to function that performes cut on first particle
	130	Bool_t (AliHBTAnalysis::fkPass2)(AliHBTParticle partpair, AliHBTParticle* trackpair) const;//Pointer to function that performes cut on second particle
	131	Bool_t (AliHBTAnalysis::fkPassPairProp)(AliHBTPair partpair, AliHBTPair* trackpair) const;//Pointer to function that performes pair cut
	132
	133	Bool_t PassPartAndTrack (AliHBTPair* partpair, AliHBTPair* trackpair) const {return (fPairCut->Pass(partpair))?kTRUE:fPairCut->Pass(trackpair);}
	134	Bool_t PassPartAndTrack1(AliHBTParticle* part, AliHBTParticle* track) const;
	135	Bool_t PassPartAndTrack2(AliHBTParticle* part, AliHBTParticle* track) const;
	136	Bool_t PassPairPropPartAndTrack (AliHBTPair* partpair, AliHBTPair* trackpair) const {return (fPairCut->PassPairProp(partpair))?kTRUE:fPairCut->PassPairProp(trackpair);}
	137
	138	Bool_t PassPart (AliHBTPair* partpair, AliHBTPair* /trackpair/) const{return fPairCut->Pass(partpair);}
	139	Bool_t PassPart1(AliHBTParticle* part, AliHBTParticle* /track/) const{return fPairCut->GetFirstPartCut()->Pass(part);}
	140	Bool_t PassPart2(AliHBTParticle* part, AliHBTParticle* /track/) const{return fPairCut->GetSecondPartCut()->Pass(part);}
	141	Bool_t PassPairPropPart (AliHBTPair* partpair, AliHBTPair* /trackpair/) const{return fPairCut->PassPairProp(partpair);}
	142
	143	Bool_t PassTrack (AliHBTPair* /partpair/, AliHBTPair* trackpair) const{return fPairCut->Pass(trackpair);}
	144	Bool_t PassTrack1(AliHBTParticle* /part/, AliHBTParticle* track) const{return fPairCut->GetFirstPartCut()->Pass(track);}
	145	Bool_t PassTrack2(AliHBTParticle* /part/, AliHBTParticle* track) const{return fPairCut->GetSecondPartCut()->Pass(track);}
	146	Bool_t PassPairPropTrack (AliHBTPair* /partpair/, AliHBTPair* trackpair) const{return fPairCut->PassPairProp(trackpair);}
	147
	148	static const UInt_t fgkFctnArraySize;//!
	149	static const UInt_t fgkDefaultMixingInfo;//!
	150	static const Int_t fgkDefaultBufferSize;//!
	151
	152	ClassDef(AliHBTAnalysis,0)
	153	};
	154
	155	inline Bool_t AliHBTAnalysis::PassPartAndTrack1(AliHBTParticle* part,AliHBTParticle* track) const
	156	{
	157	//Checks first particle from both, particle and track pairs
	158	AliHBTParticleCut* pc = fPairCut->GetFirstPartCut();
	159	return (pc->Pass(part))?kTRUE:pc->Pass(track);
	160	}
	161	/*************************************************************************************/
	162	inline Bool_t AliHBTAnalysis::PassPartAndTrack2(AliHBTParticle* part,AliHBTParticle* track) const
	163	{
	164	//Checks second particle from both, particle and track pairs
	165	AliHBTParticleCut* pc = fPairCut->GetSecondPartCut();
	166	return (pc->Pass(part))?kTRUE:pc->Pass(track);
	167	}
	168	/*************************************************************************************/
	169
	170	#endif