StRoot: StMuDSTMaker/COMMON/StMuDstMaker.h Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StMuDstMaker.h,v 1.53 2011/05/04 19:51:32 tone421 Exp $
00004  * Author: Frank Laue, BNL, laue@bnl.gov
00005  ***************************************************************************/
00006 #ifndef StMuDstMaker_hh
00007 #define StMuDstMaker_hh
00008 
00009 #include <string>
00010 
00011 #ifndef ST_NO_NAMESPACES
00012 using namespace std;
00013 #endif
00014 
00015 #include "StMaker.h"
00016 #include "StChain.h"
00017 #include "StIOInterFace.h"
00018 #include "St_DataSetIter.h"
00019 
00020 #include "StMuArrays.h"
00021 
00022 #include "StMuFilter.h"
00023 #include "StMuL3Filter.h"
00024 
00025 
00026 class StMuEvent;
00027 class StMuDst;
00028 class StMuCut;
00029 
00030 class StEvent;
00031 class StTrackNode;
00032 class StTrack;
00033 class StVertex;
00034 class StRichSpectra;
00035 class StDetectorState;
00036 class StL3AlgorithmInfo;
00037 
00038 class StuProbabilityPidAlgorithm;
00039 
00040 class StIOMaker;
00041 class StTreeMaker;
00042 #ifndef __NO_STRANGE_MUDST__
00044 class StStrangeEvMuDst;
00045 class StStrangeMuDstMaker;
00046 class StV0MuDst;
00047 class StV0Mc;
00048 class StXiMuDst;
00049 class StXiMc;
00050 class StKinkMuDst;
00051 class StKinkMc;
00052 class StStrangeAssoc;
00053 class StStrangeCuts;
00054 #endif
00056 #include "StMuEmcCollection.h"
00057 class StMuEmcUtil;
00058 
00060 #include "StMuFmsCollection.h"
00061 class StMuFmsUtil;
00062 
00064 #include "StMuPmdCollection.h"
00065 class StMuPmdUtil;
00066 
00067 // tof stuff
00068 class StMuTofHit;
00069 class StMuTofHitCollection;
00070 class StTofCollection;
00071 class StTofDataCollection;
00072 // run 5 - dongx
00073 class StTofRawDataCollection;
00074 class StMuTofUtil;
00075 // new btof
00076 class StBTofCollection;
00077 class StBTofRawHitCollection;
00078 class StMuBTofHit;
00079 class StMuBTofHitCollection;
00080 class StMuBTofUtil;
00081 
00082 // ezTree stuff
00083 class StMuEzTree;
00084 
00085 class TFile;
00086 class TTree;
00087 class TChain;
00088 class TClonesArray;
00089 class TEventList;
00090 
00091 class StMuRpsCollection;
00092 class StMuMtdCollection;
00093 
00094 
00106 class StMuDstMaker : public StIOInterFace {
00107  public:
00109     StMuDstMaker(const char* name="MuDst");
00111     StMuDstMaker(int mode, int nameMode, const char* dirName="./", const char* fileName="", const char* filter=".", int maxfiles=10,
00112                  const char* name="MuDst");
00113   
00114     ~StMuDstMaker();
00115 
00116   virtual int Init();
00117   virtual void Clear(Option_t *option="");
00118   virtual int  Make();
00119   virtual  Int_t MakeRead(const StUKey &RunEvent);
00120   virtual  Int_t MakeRead();
00121   virtual  Int_t MakeWrite();
00122   virtual int  Finish();
00123           void printArrays();
00124           void SetStatus(const char *arrType,int status);
00126   void SetEventList( TEventList *e ) { mEventList = e; }
00128   void setTrackFilter(StMuCut* c);
00129   StMuFilter* trackFilter();
00131   void setL3TrackFilter(StMuCut* c);
00132   StMuL3Filter* l3TrackFilter();
00134 
00149   void setProbabilityPidFile(const char* file=NULL);
00152   StMuDst* muDst();
00154   TChain* chain();
00156   TTree* tree();
00157 
00159   virtual const char *GetFile() const;
00160 
00162   void setSplit(int=99);
00164   void setBufferSize(int=65536*4);
00166   void setCompression(int comp=9);
00167 
00168   //Set for StTriggerData. Default is 2009.
00169   void setStTriggerYear(int);
00170 
00171   StMuEmcUtil* muEmcUtil() { return mEmcUtil; } 
00172   StMuFmsUtil* muFmsUtil() { return mFmsUtil; } 
00173   StMuPmdUtil* muPmdUtil() { return mPmdUtil; } 
00174 
00175   virtual const char *GetCVS() const {  
00176 
00177     static const char cvs[]="Tag $Name:  $ $Id: StMuDstMaker.h,v 1.53 2011/05/04 19:51:32 tone421 Exp $ built "__DATE__" "__TIME__ ;
00178     return cvs;
00179   }
00180 
00181 
00182 
00183 protected:
00185   void connectEmcCollection();
00186   void connectFmsCollection();
00187   void connectPmdCollection();
00188   enum ioMode {ioRead, ioWrite};
00197   enum ioNameMode {ioFix=0, ioIOMaker, ioTreeMaker};
00198 
00199   StEvent* mStEvent;
00200   StMuDst* mStMuDst;
00201 #ifndef __NO_STRANGE_MUDST__
00202   StStrangeMuDstMaker* mStStrangeMuDstMaker;
00203 #endif
00204   StIOMaker* mIOMaker;
00205   StTreeMaker* mTreeMaker;
00206   StMuEmcUtil* mEmcUtil;
00207   StMuFmsUtil* mFmsUtil;
00208   StMuPmdUtil* mPmdUtil;
00209   StMuTofUtil* mTofUtil;
00211   StMuBTofUtil* mBTofUtil;
00212   StMuEzTree* mEzTree; 
00213 
00214   int mIoMode;
00215   int mIoNameMode;
00216   string mDirName;
00217   string mFileName;
00218   string mFilter;
00219   int mMaxFiles;
00220 
00221   TEventList *mEventList;
00222 
00223   unsigned int mTrackType;
00224   bool mReadTracks;
00225   bool mReadV0s;
00226   bool mReadXis;
00227   bool mReadKinks;
00228   bool mFinish;
00229 
00230   StMuCut* mTrackFilter;
00231   StMuCut* mL3TrackFilter;
00232 
00233   TFile* mCurrentFile;
00234   string mCurrentFileName;
00235 
00236   TChain* mChain;
00237   TTree* mTTree;
00238 
00239   int mEventCounter;
00240   int mSplit;
00241   int mCompression;
00242   int mBufferSize;
00243 
00244   TObjArray mVtxList;  // List of pointers to vertices to keep track of track-vertex assignment when copying from StEvent
00245 
00246   StuProbabilityPidAlgorithm* mProbabilityPidAlgorithm;
00247 
00248 
00249 #define saveDelete(t) { delete t; t=0;}
00250 
00252 
00253 virtual void openWrite(string fileName);
00254 virtual   void write();
00255 virtual   void closeWrite();
00256 
00257   void streamerOff();
00258 
00259 virtual   int openRead();
00260 virtual   void read();
00261 void setBranchAddresses();
00262 virtual   void closeRead();
00263 
00264   void setBranchAddresses(TChain*);
00265 
00266   void assignArrays();
00267   void clearArrays();
00268   void zeroArrays();
00269   void createArrays();
00270   TClonesArray* clonesArray(TClonesArray*& p, const char* type, int size, int& counter);
00271 
00272   void fill();
00273   void fillTrees(StEvent* ev, StMuCut* cut=0);
00274   void fillEvent(StEvent* ev, StMuCut* cut=0);
00275   void fillVertices(StEvent* ev);
00276   void fillpp2pp(StEvent* ev);
00277         void fillmtd(StEvent* ev);
00278 
00279         void fillsttrigger(StEvent* ev);        
00280   void fillPmd(StEvent* ev);
00281   void fillEmc(StEvent* ev);
00282   void fillFms(StEvent* ev);
00283 #ifndef __NO_STRANGE_MUDST__
00284   void fillStrange(StStrangeMuDstMaker*);
00285 #endif
00286   void fillMC();
00287   void fillL3Tracks(StEvent* ev, StMuCut* cut=0);
00288   void fillTracks(StEvent* ev, StMuCut* cut=0);
00289   void fillDetectorStates(StEvent* ev);
00290   void fillL3AlgorithmInfo(StEvent* ev);
00291   void fillTof(StEvent* ev);
00293   void fillBTof(StEvent* ev);
00294   void fillEzt(StEvent* ev);
00295 
00296   void fillHddr();
00297 
00298   template <class T, class U> int addType(TClonesArray* tcaTo  , U &u, T *t);
00299   template <class T>          int addType(TClonesArray* tcaFrom, TClonesArray* &tcaTo ,T *t);
00300   template <class T>          int addType(TClonesArray* tcaTo  , T &t);
00301   void addTrackNode(const StEvent* ev, const StTrackNode* node, StMuCut* cut, TClonesArray* gTCA=0, TClonesArray* pTCA=0, TClonesArray* oTCA=0, 
00302                     TClonesArray* covgTCA=0, TClonesArray* covpTCA=0, bool l3=false);
00303   int  addTrack(TClonesArray* tca, const StEvent* event, const StTrack* track, const StVertex *vtx, StMuCut* cut, int index2Global, bool l3=false, 
00304                 TClonesArray* covgTCA=0, TClonesArray* covpTCA=0);
00305 /*   int addType(TClonesArray* tcaTo , StMuEmcCollection t); */
00306 
00307   StRichSpectra* richSpectra(const StTrack* track);
00308 
00309   void setStEvent(StEvent*);
00310   StEvent* stEvent();
00311 #ifndef __NO_STRANGE_MUDST__
00312   void setStStrangeMuDstMaker(StStrangeMuDstMaker*);
00313   StStrangeMuDstMaker* stStrangeMuDstMaker();
00314 #endif
00315   unsigned int trackType();
00316   bool readTracks();
00317 #ifndef __NO_STRANGE_MUDST__
00318   bool readV0s();
00319   bool readXis();
00320   bool readKinks();
00321 #endif
00322   void setTrackType(unsigned int);
00323   void setReadTracks(bool);
00324 #ifndef __NO_STRANGE_MUDST__
00325   void setReadV0s(bool);
00326   void setReadXis(bool);
00327   void setReadKinks(bool);
00328 #endif
00329   string basename(string);
00330   string dirname(string);
00331   string buildFileName(string dir, string fileName, string extention);
00332 
00333   friend class StMuDst;
00334   friend class StMuDstFilterMaker;
00335 
00336   // Beware that this was added to counteract contiguous memory.
00337   // See implementation for caveat
00338   TClonesArray*  mAArrays         [__NALLARRAYS__];
00339   TClonesArray** mArrays;       //[__NARRAYS__       ];
00340 #ifndef __NO_STRANGE_MUDST__
00341   TClonesArray** mStrangeArrays;//[__NSTRANGEARRAYS__];
00342 #endif
00343   TClonesArray** mMCArrays;//[__NMCARRAYS__];
00344   TClonesArray** mEmcArrays;    //[__NEMCARRAYS__    ];
00345   TClonesArray** mFmsArrays;    //[__NFMSARRAYS__    ];
00346   TClonesArray** mPmdArrays;    //[__NPMDARRAYS__    ];
00347   TClonesArray** mTofArrays;    //[__NTOFARRAYS__    ];
00349   TClonesArray** mBTofArrays;   //[__NBTOFARRAYS__    ];
00350   TClonesArray** mEztArrays;    //[__NEZTARRAYS__    ];
00351   char           mStatusArrays    [__NALLARRAYS__    ];
00352   TClonesArray*  mEmcCollectionArray; // Needed to hold old format
00353   StMuEmcCollection *mEmcCollection;
00354   StMuFmsCollection *mFmsCollection;
00355   TClonesArray*  mPmdCollectionArray; // Needed to hold old format
00356   StMuPmdCollection *mPmdCollection;
00357 
00358   ClassDef(StMuDstMaker, 0)
00359 };
00360 
00361 inline StMuDst* StMuDstMaker::muDst() { return mStMuDst;}
00362 inline TChain* StMuDstMaker::chain() { return mChain; }
00363 inline TTree* StMuDstMaker::tree() { return mTTree; }
00364 inline void StMuDstMaker::setTrackFilter(StMuCut* c) { mTrackFilter=c;}
00365 inline void StMuDstMaker::setL3TrackFilter(StMuCut* c) { mL3TrackFilter=c;}
00366 inline StMuFilter* StMuDstMaker::trackFilter() { return (StMuFilter*)mTrackFilter;}
00367 inline StMuL3Filter* StMuDstMaker::l3TrackFilter() { return (StMuL3Filter*)mL3TrackFilter;}
00368 #ifndef __NO_STRANGE_MUDST__
00369 inline void StMuDstMaker::setStStrangeMuDstMaker(StStrangeMuDstMaker* s) {mStStrangeMuDstMaker=s;}
00370 inline StStrangeMuDstMaker* StMuDstMaker::stStrangeMuDstMaker() {return mStStrangeMuDstMaker;}
00371 #endif
00372 inline void StMuDstMaker::setTrackType(unsigned int t) {mTrackType=t;}
00373 inline unsigned int StMuDstMaker::trackType() {return mTrackType;}
00374 
00375 inline bool StMuDstMaker::readTracks() { return mReadTracks;}
00376 #ifndef __NO_STRANGE_MUDST__
00377 inline bool StMuDstMaker::readV0s() { return mReadV0s;}
00378 inline bool StMuDstMaker::readXis() { return mReadXis;}
00379 inline bool StMuDstMaker::readKinks() { return mReadKinks;}
00380 #endif
00381 inline void StMuDstMaker::setReadTracks(bool b) { mReadTracks=b;}
00382 #ifndef __NO_STRANGE_MUDST__
00383 inline void StMuDstMaker::setReadV0s(bool b) { mReadV0s=b;}
00384 inline void StMuDstMaker::setReadXis(bool b) { mReadXis=b;}
00385 inline void StMuDstMaker::setReadKinks(bool b) { mReadKinks=b;}
00386 #endif
00387 
00388 inline void StMuDstMaker::setSplit(int split) { mSplit = split;}
00389 inline void StMuDstMaker::setCompression(int comp) { mCompression = comp;}
00390 inline void StMuDstMaker::setBufferSize(int buf) { mBufferSize = buf; }
00391 
00392 
00393 #endif
00394 
00395 /***************************************************************************
00396  *
00397  * $Log: StMuDstMaker.h,v $
00398  * Revision 1.53  2011/05/04 19:51:32  tone421
00399  * Added MTD infomation
00400  *
00401  * Revision 1.52  2011/04/08 01:25:50  fisyak
00402  * Add branches for MC track and vertex information, add IdTruth to  tracks and vertices, reserve a possiblity to remove Strange MuDst
00403  *
00404  * Revision 1.51  2010/05/26 04:25:50  tone421
00405  * Added StTriggerData arrays in muevent and fixed an issue with PMD arrays being read....
00406  *
00407  * Revision 1.50  2010/01/25 03:57:39  tone421
00408  * Added FMS and Roman pot arrays
00409  *
00410  * Revision 1.49  2010/01/21 02:08:17  fine
00411  * RT #1803: Restore the broken MakeRead/MakeWrite interface to fix Skip event method
00412  *
00413  * Revision 1.48  2009/02/20 16:37:44  tone421
00414  * *** empty log message ***
00415  *
00416  * Revision 1.46  2008/03/19 14:51:04  fisyak
00417  * Add two clone arrays for global and primary track covariance matrices, remove mSigmaDcaD and mSigmaDcaZ
00418  *
00419  * Revision 1.45  2007/04/20 06:26:01  mvl
00420  * Removed Q-vector calculation. Will implement utility class instead.
00421  *
00422  * Revision 1.43  2007/02/07 07:53:09  mvl
00423  * Added SetEventList function to read only pre-selected events (by J. Webb)
00424  *
00425  * Revision 1.42  2006/02/08 23:35:36  mvl
00426  * Added overloaded version for StIOInterface::GetFile() to return name
00427  * of current input or output file (depending on read or write mode)
00428  * StIOInterface::GetFileName() is an alias for this function.
00429  *
00430  * Revision 1.41  2005/07/15 21:45:09  mvl
00431  * Added support for multiple primary vertices (StMuPrimaryVertex). Track Dcas are now calculated with repect to the first vertex in the list (highest rank), but another vertex number can be specified. Tarcks also store the index of the vertex they belong to (StMuTrack::vertexIndex())
00432  *
00433  * Revision 1.40  2005/04/12 21:56:29  mvl
00434  * Changes by Xin Dong for year-5 TOF data format: extra TClonesArray and routines to fill it from StEvent (StTofRawData).
00435  *
00436  * Revision 1.39  2004/10/28 00:11:33  mvl
00437  * Added stuff to support ezTree mode of MuDstMaker.
00438  * This is a special mode for fast-online processing of fast-detector data.
00439  *
00440  * Revision 1.38  2004/10/19 01:42:29  mvl
00441  * Changes for splitting Emc and Pmd collections. Emc clusters and points dropped
00442  *
00443  * Revision 1.37  2004/09/18 20:35:09  jeromel
00444  * Little bit baffled by what CVS did around here
00445  * http://www.star.bnl.gov/cgi-bin/cvsweb.cgi/StRoot/StMuDSTMaker/COMMON/StMuDstMaker.h.diff?r1=1.35&r2=1.36
00446  * but re-comitting without the mess up (seems like source and h were merged)
00447  *
00448  * Revision 1.35  2004/09/18 01:28:18  jeromel
00449  * *** empty log message ***
00450  *
00451  * Revision 1.34  2004/05/04 00:09:17  perev
00452  *
00453  * //  Selecting SetBranchStatus for particular MuDst branches
00454  * //  Special names:
00455  * //  MuEventAll - all branches related to StMuEvent
00456  * //  StrangeAll - all branches related to StrangeMuDst
00457  * //  EmcAll     - all branches related to Emc
00458  * //  PmdAll     - all branches related to Pmd
00459  * //  TofAll     - all branches related to Tof
00460  * //  By default all branches of MuDst are read. If user wants to read only some of
00461  * //  them, then:
00462  * //  SetStatus("*",0)           // all branches off
00463  * //  SetStatus("MuEventAll",1)  // all standard MuEvent branches ON
00464  * //  SetStatus("StrangeAll",1)  // all standard Strange branches ON
00465  * //  SetStatus("EmcAll"    ,1)  // all standard Emc     branches ON
00466  * //  SetStatus("PmdAll"    ,1)  // all standard Pmd     branches ON
00467  * //  SetStatus("TofAll"    ,1)  // all standard Tof     branches ON
00468  * //
00469  * //  SetStatus("XiAssoc"    ,1) // Strange branch "XiAssoc" is ON
00470  * //  Names of branches look StMuArrays::arrayTypes[]
00471  * //  It allows to speed up reading MuDst significantly
00472  *
00473  * Revision 1.33  2004/04/26 00:13:28  perev
00474  * Cleanup+simplification
00475  *
00476  * Revision 1.32  2004/04/20 18:42:40  perev
00477  * remove redundant arrays
00478  *
00479  * Revision 1.31  2004/04/15 00:26:14  perev
00480  * fillHddr() added to fill time stamp ...
00481  *
00482  * Revision 1.30  2004/04/09 22:03:47  subhasis
00483  * after tof createevent fix by Xin
00484  *
00485  * Revision 1.29  2004/04/09 03:36:15  jeromel
00486  * Removed TOF support entirely for now as we need a working version ... Will
00487  * revisit later.
00488  *
00489  * Revision 1.28  2004/04/02 03:24:54  jeromel
00490  * Changes implements PMD and TOF.  TOF is clearly incomplete.
00491  *
00492  * Revision 1.27  2004/02/17 04:56:36  jeromel
00493  * Extended help, added crs support, restored __GNUC__ for PRETTY_FUNCTION(checked once
00494  * more and yes, it is ONLY defined in GCC and so is __FUCTION__),  use of a consistent
00495  * internal __PRETTYF__, return NULL if no case selected (+message) and protected against
00496  * NULL mChain.
00497  *
00498  * Revision 1.26  2003/11/09 01:02:59  perev
00499  * more sofisticated clear() to fix leaks
00500  *
00501  * Revision 1.25  2003/10/30 20:08:13  perev
00502  * Check of quality added
00503  *
00504  * Revision 1.24  2003/10/27 23:54:33  perev
00505  * weird template bug fized and templates simplified
00506  *
00507  * Revision 1.23  2003/10/20 19:50:13  perev
00508  * workaround added for TClonesArray::Delete + some cleanup of MuEmc
00509  *
00510  * Revision 1.22  2003/09/19 01:45:18  jeromel
00511  * A few problems hopefully fixed i.e. one constructor lacked zeroing
00512  * emcArrays were not  zeroed, mStMuDst not zeroed.
00513  * For maintainability zeroArrays() added.
00514  *
00515  * Revision 1.21  2003/09/02 17:58:44  perev
00516  * gcc 3.2 updates + WarnOff
00517  *
00518  * Revision 1.20  2003/04/15 18:48:36  laue
00519  * Minor changes to be able to filter MuDst.root files and an example
00520  * how to do this. The StMuDstFilterMaker is just an example, it has to be
00521  * customized (spoilers, chrome weels, etc.) by the user.
00522  *
00523  * Revision 1.19  2003/02/19 15:38:10  jeromel
00524  * Modifications made to account for the new location of the PIDTable file.
00525  * The setProbabilityPidFile() method has been modified to take care of a default
00526  * file loading if unspecified. Messages will be displayed appropriatly.
00527  * Macros mdoofied to not call the method (leave it handled through the default
00528  * file).
00529  *
00530  * Revision 1.18  2003/01/29 03:04:57  laue
00531  * !!DIRTY FIX FOR StMuEmcCollection
00532  * !! Was memor leaking. Leak fixed, but slow and dirty.
00533  * !! Propose to change the structure as soon as possible.
00534  *
00535  * Revision 1.17  2003/01/23 21:59:50  laue
00536  * Modification to compile on Solaris.
00537  *
00538  * Revision 1.16  2003/01/09 18:59:45  laue
00539  * initial check in of new EMC classes and the changes required
00540  *
00541  * Revision 1.15  2002/11/08 14:18:59  laue
00542  * saveDelete(<T>) added, sets pointer=null after delete
00543  *
00544  * Revision 1.14  2002/09/11 21:02:41  laue
00545  * added cut on track encoded method for ITTF
00546  *
00547  * Revision 1.13  2002/08/20 19:55:49  laue
00548  * Doxygen comments added
00549  *
00550  * Revision 1.12  2002/05/20 17:23:31  laue
00551  * StStrangeCuts added
00552  *
00553  * Revision 1.11  2002/05/04 23:56:30  laue
00554  * some documentation added
00555  *
00556  * Revision 1.10  2002/04/26 20:57:31  jeromel
00557  * Added GetCVS()
00558  *
00559  * Revision 1.9  2002/04/11 14:19:30  laue
00560  * - update for RH 7.2
00561  * - decrease default arrays sizes
00562  * - add data base readerfor number of events in a file
00563  *
00564  * Revision 1.8  2002/04/01 22:42:30  laue
00565  * improved chain filter options
00566  *
00567  * Revision 1.7  2002/03/28 05:10:34  laue
00568  * update for running in the production
00569  *
00570  * Revision 1.6  2002/03/27 03:47:27  laue
00571  * better filter options
00572  *
00573  * Revision 1.5  2002/03/27 00:50:11  laue
00574  * bux fix from earlier check in
00575  *
00576  * Revision 1.4  2002/03/26 19:33:15  laue
00577  * minor updates
00578  *
00579  * Revision 1.3  2002/03/20 16:04:11  laue
00580  * minor changes, mostly added access functions
00581  *
00582  * Revision 1.2  2002/03/08 20:04:31  laue
00583  * change from two trees to 1 tree per file
00584  *
00585  *
00586  **************************************************************************/