StRoot: StHbtMaker/Infrastructure/StHbtAnalysis.h Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StHbtAnalysis.h,v 1.17 2002/11/03 16:38:54 magestro Exp $
00004  *
00005  * Author: Mike Lisa, Ohio State, lisa@mps.ohio-state.edu
00006  ***************************************************************************
00007  *
00008  * Description: part of STAR HBT Framework: StHbtMaker package
00009  *      This is the Class for Analysis objects.  Each of the simultaneous
00010  *      Analyses running should have one of these instantiated.  They link
00011  *      into the Manager in an Analysis Collection.
00012  *
00013  ***************************************************************************
00014  *
00015  * $Log: StHbtAnalysis.h,v $
00016  * Revision 1.17  2002/11/03 16:38:54  magestro
00017  * New MakePairs() method, new StHbtPicoEventCollectionVectorHideAway data member
00018  *
00019  * Revision 1.16  2002/06/22 17:53:32  lisa
00020  * implemented switch to allow user to require minimum number of particles in First and Second ParticleCollections - default value is zero so if user does not Set this value then behaviour is like before
00021  *
00022  * Revision 1.15  2001/04/05 21:57:45  laue
00023  * current pico-event becomes a member of the analysis (mPicoEvent) and gets
00024  * an access-function (CurrentPicoEvent)
00025  *
00026  * Revision 1.14  2000/08/31 22:31:30  laue
00027  * StHbtAnalysis: output changed (a little bit less)
00028  * StHbtEvent: new version, members for reference mult added
00029  * StHbtIOBinary: new IO for new StHbtEvent version
00030  * StHbtTypes: TTree typedef to StHbtTTree added
00031  * StHbtVertexAnalysis: overflow and underflow added
00032  *
00033  * Revision 1.13  2000/08/11 16:35:41  rcwells
00034  * Added number of events processed to each HBT analysis
00035  *
00036  * Revision 1.12  2000/06/15 18:54:08  willson
00037  * Methods to access cuts and correlation functions moved to derived analysis
00038  * classes.
00039  *
00040  * Revision 1.11  2000/05/11 21:18:56  willson
00041  * Removed StHbtThreeParticleCorrFctn's...put methods in StHbtCorrFctn
00042  * Some methods in derived analysis classes moved to base analysis class
00043  *
00044  * Revision 1.10  2000/04/03 16:21:50  laue
00045  * some include files changed
00046  * Multi track cut added
00047  *
00048  * Revision 1.9  2000/03/17 17:23:05  laue
00049  * Roberts new three particle correlations implemented.
00050  *
00051  * Revision 1.8  2000/03/16 02:07:04  laue
00052  * Copy constructor added to StHbtAnalysis (only known cuts, corrfctn).
00053  *
00054  * StHbtBinaryReader can now derive filename from StIOMaker and read a list
00055  * of files.
00056  *
00057  * StHbtManager now holds a collection of StHbtEventWriters (multiple writes
00058  * possible now)
00059  *
00060  * Revision 1.7  2000/02/13 17:17:12  laue
00061  * Calls to the EventBegin() and EventEnd() functions implemented
00062  * The actual analysis is moved from StHbtManager to StHbtAnalysis
00063  *
00064  * Revision 1.6  2000/01/25 17:35:17  laue
00065  * I. In order to run the stand alone version of the StHbtMaker the following
00066  * changes have been done:
00067  * a) all ClassDefs and ClassImps have been put into #ifdef __ROOT__ statements
00068  * b) unnecessary includes of StMaker.h have been removed
00069  * c) the subdirectory StHbtMaker/doc/Make has been created including everything
00070  * needed for the stand alone version
00071  *
00072  * II. To reduce the amount of compiler warning
00073  * a) some variables have been type casted
00074  * b) some destructors have been declared as virtual
00075  *
00076  * Revision 1.5  1999/12/03 22:24:36  lisa
00077  * (1) make Cuts and CorrFctns point back to parent Analysis (as well as other way). (2) Accommodate new PidTraits mechanism
00078  *
00079  * Revision 1.4  1999/10/15 01:57:23  lisa
00080  * Important enhancement of StHbtMaker - implement Franks CutMonitors
00081  * ----------------------------------------------------------
00082  * This means 3 new files in Infrastructure area (CutMonitor),
00083  * several specific CutMonitor classes in the Cut area
00084  * and a new base class in the Base area (StHbtCutMonitor).
00085  * This means also changing all Cut Base class header files from .hh to .h
00086  * so we have access to CutMonitor methods from Cint command line.
00087  * This last means
00088  * 1) files which include these header files are slightly modified
00089  * 2) a side benefit: the TrackCuts and V0Cuts no longer need
00090  * a SetMass() implementation in each Cut class, which was stupid.
00091  * Also:
00092  * -----
00093  * Include Franks StHbtAssociationReader
00094  * ** None of these changes should affect any user **
00095  *
00096  * Revision 1.3  1999/10/04 15:38:56  lisa
00097  * include Franks new accessor methods StHbtAnalysis::CorrFctn and StHbtManager::Analysis as well as McEvent example macro
00098  *
00099  * Revision 1.2  1999/07/06 22:33:22  lisa
00100  * Adjusted all to work in pro and new - dev itself is broken
00101  *
00102  * Revision 1.1.1.1  1999/06/29 16:02:57  lisa
00103  * Installation of StHbtMaker
00104  *
00105  **************************************************************************/
00106 
00107 #ifndef StHbtAnalysis_hh
00108 #define StHbtAnalysis_hh
00109 //#ifndef StMaker_H
00110 //#include "StMaker.h"
00111 //#endif
00112 
00113 #include "StHbtMaker/Base/StHbtBaseAnalysis.h"        // base analysis class
00114 #include "StHbtMaker/Base/StHbtPairCut.h"     
00115 #include "StHbtMaker/Base/StHbtEventCut.h"
00116 #include "StHbtMaker/Base/StHbtParticleCut.h"
00117 #include "StHbtMaker/Base/StHbtCorrFctn.hh"
00118 #include "StHbtMaker/Infrastructure/StHbtCorrFctnCollection.hh"
00119 #include "StHbtMaker/Infrastructure/StHbtPicoEventCollection.hh"
00120 #include "StHbtMaker/Infrastructure/StHbtParticleCollection.hh"
00121 #include "StHbtMaker/Infrastructure/StHbtPicoEvent.hh"
00122 
00123 class StHbtPicoEventCollectionVectorHideAway;
00124 
00125 
00126 class StHbtAnalysis : public StHbtBaseAnalysis {
00127 
00128 public:
00129 
00130   StHbtAnalysis();
00131   StHbtAnalysis(const StHbtAnalysis&);  // copy constructor
00132   virtual ~StHbtAnalysis();
00133 
00134   // Gets and Sets
00135 
00136   virtual StHbtPairCut*       PairCut();
00137   virtual StHbtEventCut*      EventCut();
00138   virtual StHbtParticleCut*   FirstParticleCut();
00139   virtual StHbtParticleCut*   SecondParticleCut();
00140 
00141   StHbtCorrFctnCollection* CorrFctnCollection();
00142   virtual StHbtCorrFctn* CorrFctn(int n);     // Access to CFs within the collection
00143   void AddCorrFctn(StHbtCorrFctn*);
00144 
00145   void SetPairCut(StHbtPairCut*);
00146   void SetEventCut(StHbtEventCut*);
00147   void SetFirstParticleCut(StHbtParticleCut*);
00148   void SetSecondParticleCut(StHbtParticleCut*);
00149 
00150   void SetMinSizePartCollection(unsigned int minSize);
00151 
00152 
00153   unsigned int NumEventsToMix();
00154   void SetNumEventsToMix(const unsigned int&);
00155   StHbtPicoEvent* CurrentPicoEvent();
00156   StHbtPicoEventCollection* MixingBuffer();
00157   bool MixingBufferFull();
00158 
00159   bool AnalyzeIdenticalParticles();
00160   virtual StHbtString Report();       
00161 
00162   virtual void ProcessEvent(const StHbtEvent*);
00163   virtual void EventBegin(const StHbtEvent*); // startup for EbyE
00164   virtual void EventEnd(const StHbtEvent*);   // cleanup for EbyE
00165   int GetNeventsProcessed();
00166 
00167   virtual void Finish();
00168 
00169   friend class StHbtLikeSignAnalysis;
00170 
00171 protected:
00172 
00173   void AddEventProcessed();
00174   void MakePairs(const char* type,StHbtParticleCollection*,StHbtParticleCollection* p2=0);
00175 
00176   StHbtPicoEventCollectionVectorHideAway* mPicoEventCollectionVectorHideAway;
00177 
00178   StHbtPairCut*             mPairCut;
00179   StHbtCorrFctnCollection*  mCorrFctnCollection;
00180   StHbtEventCut*            mEventCut;
00181   StHbtParticleCut*         mFirstParticleCut;
00182   StHbtParticleCut*         mSecondParticleCut;
00183   StHbtPicoEventCollection* mMixingBuffer;
00184   StHbtPicoEvent*           mPicoEvent;
00185   unsigned int mNumEventsToMix;
00186   unsigned int mNeventsProcessed;
00187 
00188   unsigned int mMinSizePartCollection;  // minimum # particles in ParticleCollection
00189 
00190 
00191 #ifdef __ROOT__
00192   ClassDef(StHbtAnalysis, 0)
00193 #endif
00194 
00195 };
00196 
00197 // Get's
00198 inline StHbtPairCut*             StHbtAnalysis::PairCut() {return mPairCut;}
00199 inline StHbtEventCut*            StHbtAnalysis::EventCut() {return mEventCut;}
00200 inline StHbtParticleCut*         StHbtAnalysis::FirstParticleCut() {return mFirstParticleCut;}
00201 inline StHbtParticleCut*         StHbtAnalysis::SecondParticleCut() {return mSecondParticleCut;}
00202 inline StHbtCorrFctnCollection*  StHbtAnalysis::CorrFctnCollection() {return mCorrFctnCollection;}
00203 inline unsigned int              StHbtAnalysis::NumEventsToMix(){return mNumEventsToMix;}
00204 inline StHbtPicoEvent*           StHbtAnalysis::CurrentPicoEvent() {return mPicoEvent;}
00205 
00206 inline StHbtPicoEventCollection*  StHbtAnalysis::MixingBuffer() {return mMixingBuffer;}
00207 
00208 // Set's
00209 inline bool StHbtAnalysis::AnalyzeIdenticalParticles(){return (mFirstParticleCut==mSecondParticleCut);}
00210 inline void StHbtAnalysis::SetPairCut(StHbtPairCut* x) { mPairCut = x; x->SetAnalysis((StHbtBaseAnalysis*)this);}
00211 inline void StHbtAnalysis::AddCorrFctn(StHbtCorrFctn* cf) {mCorrFctnCollection->push_back(cf); cf->SetAnalysis((StHbtBaseAnalysis*)this);}
00212 inline void StHbtAnalysis::SetEventCut(StHbtEventCut* x) {mEventCut = x; x->SetAnalysis((StHbtBaseAnalysis*)this);}
00213 inline void StHbtAnalysis::SetFirstParticleCut(StHbtParticleCut* x) {mFirstParticleCut = x; x->SetAnalysis((StHbtBaseAnalysis*)this);}
00214 inline void StHbtAnalysis::SetSecondParticleCut(StHbtParticleCut* x) {mSecondParticleCut = x; x->SetAnalysis((StHbtBaseAnalysis*)this);}
00215 
00216 inline void StHbtAnalysis::SetNumEventsToMix(const unsigned int& nmix){ mNumEventsToMix = nmix;}
00217 inline bool StHbtAnalysis::MixingBufferFull(){return (mMixingBuffer->size() >= mNumEventsToMix);}
00218 inline int StHbtAnalysis::GetNeventsProcessed() {return mNeventsProcessed;}
00219 
00220 inline void StHbtAnalysis::SetMinSizePartCollection(unsigned int minSize){mMinSizePartCollection = minSize;}
00221 
00222 #endif