StRoot: StEvent/StEvent.h Source File

00001 
00005 /***************************************************************************
00006  *
00007  * $Id: StEvent.h,v 2.45 2012/04/16 20:22:16 ullrich Exp $
00008  *
00009  * Author: Thomas Ullrich, Sep 1999
00010  ***************************************************************************
00011  *
00012  * Description:
00013  *
00014  ***************************************************************************
00015  *
00016  * $Log: StEvent.h,v $
00017  * Revision 2.45  2012/04/16 20:22:16  ullrich
00018  * Changes necessary to add Fgt package.
00019  *
00020  * Revision 2.44  2012/02/21 18:47:13  perev
00021  * Add IsMain() related to I/O
00022  *
00023  * Revision 2.43  2012/01/24 03:01:24  perev
00024  * Etr detector added
00025  *
00026  * Revision 2.42  2011/10/17 00:13:49  fisyak
00027  * Add handles for IdTruth info
00028  *
00029  * Revision 2.41  2011/04/25 21:25:09  ullrich
00030  * Modifications to hold MTD data.
00031  *
00032  * Revision 2.40  2011/02/01 19:47:36  ullrich
00033  * Added HLT branch and hooks.
00034  *
00035  * Revision 2.39  2010/08/31 19:53:37  fisyak
00036  * Remove SoftwareMonitors
00037  *
00038  * Revision 2.38  2010/01/08 22:43:44  ullrich
00039  * Updates needed to add StFmsCollection and related classes.
00040  *
00041  * Revision 2.37  2009/11/23 22:22:25  ullrich
00042  * Minor cleanup performed and hooks for RPS added.
00043  *
00044  * Revision 2.36  2009/11/23 19:45:42  fisyak
00045  * remove reference to event_header_st
00046  *
00047  * Revision 2.35  2009/11/23 19:31:23  fisyak
00048  * remove reference to event_header_st
00049  *
00050  * Revision 2.33  2008/12/22 20:36:53  ullrich
00051  * Added hooks for new ToF (BTof)
00052  *
00053  * Revision 2.32  2006/04/25 23:21:25  ullrich
00054  * Modified addPrimaryVertex(). New 2nd arg: StPrimaryVertexOrder.
00055  *
00056  * Revision 2.31  2006/01/19 21:48:21  ullrich
00057  * Add RnD collection.
00058  *
00059  * Revision 2.30  2003/04/16 17:48:32  ullrich
00060  * Added StTriggerData and inherited classe(s).
00061  *
00062  * Revision 2.29  2003/01/30 18:36:31  ullrich
00063  * Added hooks for StTriggerIdCollection.
00064  *
00065  * Revision 2.28  2002/12/20 22:41:30  ullrich
00066  * Added PMD.
00067  *
00068  * Revision 2.27  2002/02/22 22:56:47  jeromel
00069  * Doxygen basic documentation in all header files. None of this is required
00070  * for QM production.
00071  *
00072  * Revision 2.26  2002/01/03 20:59:33  ullrich
00073  * Added BBC and FPD.
00074  *
00075  * Revision 2.25  2001/12/01 15:40:48  ullrich
00076  * Added StDetectorState access function.
00077  *
00078  * Revision 2.24  2001/11/10 23:53:23  ullrich
00079  * Added calibration vertices.
00080  *
00081  * Revision 2.23  2001/11/07 21:19:42  ullrich
00082  * Added L1 trigger.
00083  *
00084  * Revision 2.22  2001/09/18 00:15:25  ullrich
00085  * Added StRunInfo and access functions.
00086  *
00087  * Revision 2.21  2001/05/30 17:45:53  perev
00088  * StEvent branching
00089  *
00090  * Revision 2.20  2001/05/17 22:56:33  ullrich
00091  * Removed all usage of dst_summary_param.
00092  *
00093  * Revision 2.19  2001/04/23 19:28:14  ullrich
00094  * Added StClusteringHints and methods to access it.
00095  *
00096  * Revision 2.18  2001/04/05 04:00:36  ullrich
00097  * Replaced all (U)Long_t by (U)Int_t and all redundant ROOT typedefs.
00098  *
00099  * Revision 2.17  2001/03/14 02:35:43  ullrich
00100  * Added container and methods to handle PSDs.
00101  *
00102  * Revision 2.16  2001/03/09 05:24:01  ullrich
00103  * Added new method statistics().
00104  *
00105  * Revision 2.15  2000/12/08 03:53:41  ullrich
00106  * Prepared hooks for ToF.
00107  *
00108  * Revision 2.14  2000/09/25 14:21:30  ullrich
00109  * Removed enums for content vector. Replaced by lookup function.
00110  *
00111  * Revision 2.13  2000/09/06 22:34:17  ullrich
00112  * Changed mBunchCrossingNumber from scalar to array to hold all 64 bits.
00113  *
00114  * Revision 2.12  2000/06/19 01:32:15  perev
00115  *  Thomas StEvent branches added
00116  *
00117  * Revision 2.11  2000/05/24 15:46:10  ullrich
00118  * Added setSummary() method.
00119  *
00120  * Revision 2.10  2000/05/22 21:47:15  ullrich
00121  * Added RICH collection and related methods.
00122  *
00123  * Revision 2.9  2000/05/15 18:35:37  ullrich
00124  * All data member related to collections and containers are now
00125  * kept by pointer. The interface (public methods) stays the same.
00126  * Those methods which returns references were modified to create
00127  * an empty collection in case the pointer is null.
00128  *
00129  * Revision 2.8  2000/04/26 20:33:26  ullrich
00130  * Removed redundant virtual keywords.
00131  *
00132  * Revision 2.7  2000/04/18 17:31:28  perev
00133  * StEvent::Browse overload of TDataSet:;One
00134  *
00135  * Revision 2.6  2000/03/29 16:54:15  ullrich
00136  * Added L3 trigger.
00137  *
00138  * Revision 2.5  2000/02/23 17:36:02  ullrich
00139  * Changes due to the addition of the EMC to StEvent
00140  *
00141  * Revision 2.4  2000/01/13 21:06:22  lasiuk
00142  * add rich pixel info/containers
00143  *
00144  * Revision 2.3  2000/01/05 16:02:28  ullrich
00145  * SSD hits added to StEvent.
00146  *
00147  * Revision 2.2  1999/11/04 13:30:42  ullrich
00148  * Added constructor without summary table
00149  *
00150  * Revision 2.1  1999/10/28 22:25:10  ullrich
00151  * Adapted new StArray version. First version to compile on Linux and Sun.
00152  *
00153  * Revision 2.0  1999/10/12 18:41:58  ullrich
00154  * Completely Revised for New Version
00155  *
00156  **************************************************************************/
00157 #ifndef StEvent_hh
00158 #define StEvent_hh
00159 
00160 #include "St_DataSet.h"
00161 #include "TString.h"
00162 #include "StContainers.h"
00163 #include "StEnumerations.h"
00164 
00165 class StCalibrationVertex;
00166 class StDetectorState;
00167 class StEventClusteringHints;
00168 class StEventInfo;
00169 class StEventSummary;
00170 class StFpdCollection;
00171 class StPhmdCollection;
00172 class StTpcHitCollection;
00173 class StFtpcHitCollection;
00174 class StSvtHitCollection;
00175 class StSsdHitCollection;
00176 class StEtrHitCollection;
00177 class StEmcCollection;
00178 class StFmsCollection;
00179 class StRichCollection;
00180 class StRpsCollection;
00181 class StTofCollection;
00182 class StBTofCollection;
00183 class StMtdCollection;
00184 class StTriggerDetectorCollection;
00185 class StTriggerIdCollection;
00186 class StTriggerData;
00187 class StL0Trigger;
00188 class StL1Trigger;
00189 class StL3Trigger;
00190 class StPrimaryVertex;
00191 class StRunInfo;
00192 class StV0Vertex;
00193 class StXiVertex;
00194 class StKinkVertex;
00195 class StPsd;
00196 class StRnDHitCollection;
00197 class StHltEvent;
00198 class StFgtCollection;
00199 
00200 class StEvent : public StXRefMain {
00201 public:
00202     StEvent();
00203     virtual ~StEvent();
00204 
00205     void                                Browse(TBrowser*);
00206     static const TString&               cvsTag();
00207     
00208     TString                             type() const;
00209     int                                 id() const;
00210     int                                 runId() const;
00211     int                                 time() const;
00212     unsigned int                        triggerMask() const;
00213     unsigned int                        bunchCrossingNumber(unsigned int) const;
00214     
00215     StEventInfo*                        info();
00216     const StEventInfo*                  info() const;
00217 
00218     StRunInfo*                          runInfo();
00219     const StRunInfo*                    runInfo() const;
00220 
00221     StEventSummary*                     summary();
00222     const StEventSummary*               summary() const;
00223     
00224     StTpcHitCollection*                 tpcHitCollection();
00225     const StTpcHitCollection*           tpcHitCollection() const;
00226     StFtpcHitCollection*                ftpcHitCollection();
00227     const StFtpcHitCollection*          ftpcHitCollection() const;
00228     StSvtHitCollection*                 svtHitCollection();
00229     const StSvtHitCollection*           svtHitCollection() const;
00230     StSsdHitCollection*                 ssdHitCollection();
00231     const StSsdHitCollection*           ssdHitCollection() const;
00232     StEmcCollection*                    emcCollection();
00233     const StEmcCollection*              emcCollection() const;
00234     StFmsCollection*                    fmsCollection();
00235     const StFmsCollection*              fmsCollection() const;
00236     StRichCollection*                   richCollection();
00237     const StRichCollection*             richCollection() const;
00238     StRpsCollection*                    rpsCollection();
00239     const StRpsCollection*              rpsCollection() const;
00240     StTofCollection*                    tofCollection();
00241     const StTofCollection*              tofCollection() const;
00242     StBTofCollection*                   btofCollection();
00243     const StBTofCollection*             btofCollection() const;
00244     StMtdCollection*                    mtdCollection();
00245     const StMtdCollection*              mtdCollection() const;
00246     StFpdCollection*                    fpdCollection();
00247     const StFpdCollection*              fpdCollection() const;
00248     StPhmdCollection*                   phmdCollection();
00249     const StPhmdCollection*             phmdCollection() const;
00250     StRnDHitCollection*                 rndHitCollection();
00251     const StRnDHitCollection*           rndHitCollection() const;
00252     StEtrHitCollection*                 etrHitCollection();
00253     const StEtrHitCollection*           etrHitCollection() const;
00254     StHltEvent*                         hltEvent();
00255     const StHltEvent*                   hltEvent() const;
00256     StFgtCollection*                    fgtCollection();
00257     const StFgtCollection*              fgtCollection() const;
00258     
00259     StL0Trigger*                        l0Trigger();
00260     const StL0Trigger*                  l0Trigger() const;
00261     StL1Trigger*                        l1Trigger();
00262     const StL1Trigger*                  l1Trigger() const;
00263     StL3Trigger*                        l3Trigger();
00264     const StL3Trigger*                  l3Trigger() const;
00265     StTriggerDetectorCollection*        triggerDetectorCollection();
00266     const StTriggerDetectorCollection*  triggerDetectorCollection() const;
00267     StTriggerIdCollection*              triggerIdCollection();
00268     const StTriggerIdCollection*        triggerIdCollection() const;
00269     StTriggerData*                      triggerData();
00270     const StTriggerData*                triggerData() const;
00271     
00272     StSPtrVecTrackDetectorInfo&         trackDetectorInfo();
00273     const StSPtrVecTrackDetectorInfo&   trackDetectorInfo() const;
00274     
00275     StSPtrVecTrackNode&                 trackNodes();
00276     const StSPtrVecTrackNode&           trackNodes() const;
00277 
00278     unsigned int                        numberOfPrimaryVertices() const;
00279     StPrimaryVertex*                    primaryVertex(unsigned int = 0);
00280     const StPrimaryVertex*              primaryVertex(unsigned int = 0) const;
00281 
00282     unsigned int                        numberOfCalibrationVertices() const;
00283     StCalibrationVertex*                calibrationVertex(unsigned int);
00284     const StCalibrationVertex*          calibrationVertex(unsigned int) const;
00285 
00286     StSPtrVecV0Vertex&                  v0Vertices();
00287     const StSPtrVecV0Vertex&            v0Vertices() const;
00288     StSPtrVecXiVertex&                  xiVertices();
00289     const StSPtrVecXiVertex&            xiVertices() const;
00290     StSPtrVecKinkVertex&                kinkVertices();
00291     const StSPtrVecKinkVertex&          kinkVertices() const;
00292 
00293     StDetectorState*                    detectorState(StDetectorId);
00294     const StDetectorState*              detectorState(StDetectorId) const;
00295     
00296     StPsd*                              psd(StPwg, int);
00297     const StPsd*                        psd(StPwg, int) const;
00298     unsigned int                        numberOfPsds() const;
00299     unsigned int                        numberOfPsds(StPwg) const;
00300 
00301     StSPtrVecHit*                       hitCollection(const Char_t *name);
00302     
00303     StSPtrVecObject&                    content();               // for IO purposes only
00304 
00305     const StEventClusteringHints*       clusteringHints() const; // for IO purposes only
00306     StEventClusteringHints*             clusteringHints();       // for IO purposes only
00307     
00308     void                                statistics();            // *MENU*
00309 
00310     void setType(const char*);
00311     void setRunId(int);
00312     void setId(int);
00313     void setTime(int);
00314     void setTriggerMask(unsigned int);
00315     void setBunchCrossingNumber(unsigned int, unsigned int);
00316     void setInfo(StEventInfo*);
00317     void setRunInfo(StRunInfo*);
00318     void setSummary(StEventSummary*);
00319     void setIdTruth();
00320 
00321     void setTpcHitCollection(StTpcHitCollection*);
00322     void setRnDHitCollection(StRnDHitCollection*);
00323     void setEtrHitCollection(StEtrHitCollection*);
00324     void setFtpcHitCollection(StFtpcHitCollection*);
00325     void setSvtHitCollection(StSvtHitCollection*);
00326     void setSsdHitCollection(StSsdHitCollection*);
00327     void setEmcCollection(StEmcCollection*);
00328     void setFmsCollection(StFmsCollection*);
00329     void setRichCollection(StRichCollection*);
00330     void setRpsCollection(StRpsCollection*);
00331     void setTofCollection(StTofCollection*);
00332     void setBTofCollection(StBTofCollection*);
00333     void setMtdCollection(StMtdCollection*);
00334     void setFpdCollection(StFpdCollection*);
00335     void setPhmdCollection(StPhmdCollection*);
00336     void setTriggerDetectorCollection(StTriggerDetectorCollection*);
00337     void setTriggerIdCollection(StTriggerIdCollection*);
00338     void setTriggerData(StTriggerData*);
00339     void setL0Trigger(StL0Trigger*);
00340     void setL1Trigger(StL1Trigger*);
00341     void setL3Trigger(StL3Trigger*);
00342     void setHltEvent(StHltEvent*);
00343     void setFgtCollection(StFgtCollection*);
00344     void addPrimaryVertex(StPrimaryVertex*, StPrimaryVertexOrder = orderByNumberOfDaughters);
00345     void addCalibrationVertex(StCalibrationVertex*);
00346     void addDetectorState(StDetectorState*);
00347     void addPsd(StPsd*);
00348     void removePsd(StPsd*);
00349     void addHitCollection(StSPtrVecHit* p, const Char_t *name);
00350     void removeHitCollection(const Char_t *name);
00351     
00352     virtual Bool_t Notify();
00353     
00354 protected:
00355     mutable StSPtrVecObject  mContent;
00356     static  TString          mCvsTag;
00357     void    Split();
00358      int    IsMain() const      {return 1;}
00359 private:
00360     StEvent& operator=(const StEvent&);
00361     StEvent(const StEvent&);
00362     void initToZero();
00363     
00364     ClassDef(StEvent,5)
00365 };
00366 #endif
00367 
00368 
00369 
00370 
00371 
00372 
00373