StRoot: StEvent/StTrack.h Source File

00001 
00005 /***************************************************************************
00006  *
00007  * $Id: StTrack.h,v 2.28 2012/05/07 14:42:58 fisyak Exp $
00008  *
00009  * Author: Thomas Ullrich, Sep 1999
00010  ***************************************************************************
00011  *
00012  * Description:
00013  *
00014  * Note the following: with the arrival of ITTF it is now possible to
00015  * store the numberOfPossiblePoints for every detector individually. Before
00016  * that and because of the way the tables were defined TPC and FTPC were
00017  * one and the same. This caused confusion. However, since we have to
00018  * stay backwards compatible the "old way" is still working.
00019  *    mNumberOfPossiblePoints ==>  seedQuality 
00020  *    mNumberOfPossiblePointsTpc
00021  *    mNumberOfPossiblePointsFtpcWest 
00022  *    mNumberOfPossiblePointsFtpcEast 
00023  *    mNumberOfPossiblePointsSvt 
00024  *    mNumberOfPossiblePointsSsd 
00025  *    are the ones that count
00026   * --------------------------------------------------------------------------
00027  *  The track flag (mFlag accessed via flag() method) definitions with ITTF 
00028  *  (flag definition in EGR era can be found at
00029  *   http://www.star.bnl.gov/STAR/html/all_l/html/dst_track_flags.html)
00030  *
00031  *  mFlag= zxyy, where  z = 1 for pile up track in TPC (otherwise 0) 
00032  *                      x indicates the detectors included in the fit and 
00033  *                     yy indicates the status of the fit. 
00034  *  Positive mFlag values are good fits, negative values are bad fits. 
00035  *
00036  *  The first digit indicates which detectors were used in the refit: 
00037  *
00038  *      x=1 -> TPC only 
00039  *      x=3 -> TPC       + primary vertex 
00040  *      x=5 -> SVT + TPC 
00041  *      x=6 -> SVT + TPC + primary vertex 
00042  *      x=7 -> FTPC only 
00043  *      x=8 -> FTPC      + primary 
00044  *      x=9 -> TPC beam background tracks            
00045  *
00046  *  The last two digits indicate the status of the refit: 
00047  *       = +x01 -> good track 
00048  *
00049  *      = -x01 -> Bad fit, outlier removal eliminated too many points 
00050  *      = -x02 -> Bad fit, not enough points to fit 
00051  *      = -x03 -> Bad fit, too many fit iterations 
00052  *      = -x04 -> Bad Fit, too many outlier removal iterations 
00053  *      = -x06 -> Bad fit, outlier could not be identified 
00054  *      = -x10 -> Bad fit, not enough points to start 
00055  *
00056  *      = +x11 -> Short track pointing to EEMC
00057  *
00058  ***************************************************************************
00059  *
00060  * $Log: StTrack.h,v $
00061  * Revision 2.28  2012/05/07 14:42:58  fisyak
00062  * Add handilings for Track to Fast Detectors Matching
00063  *
00064  * Revision 2.27  2011/10/13 21:25:27  perev
00065  * setting IdTruth from the hits is added
00066  *
00067  * Revision 2.26  2011/04/26 21:41:29  fisyak
00068  * Make mKey Int_t instead of UShort_t (no. of tracks might be more that 64k)
00069  *
00070  * Revision 2.25  2011/03/31 19:29:01  fisyak
00071  * Add IdTruth information for tracks and vertices
00072  *
00073  * Revision 2.24  2010/08/31 20:00:09  fisyak
00074  * Clean up, add mSeedQuality
00075  *
00076  * Revision 2.23  2009/11/23 16:34:07  fisyak
00077  * Cleanup, remove dependence on dst tables, clean up software monitors
00078  *
00079  * Revision 2.22  2008/08/26 12:47:38  fisyak
00080  * add track pule up flag description
00081  *
00082  * Revision 2.21  2007/10/11 21:51:40  ullrich
00083  * Added member to handle number of possible points fpr PXL and IST.
00084  *
00085  * Revision 2.20  2006/08/28 17:03:54  fisyak
00086  * Add track flag definitions from EGR (we suppose that this will be primary information from now)
00087  *
00088  * Revision 2.19  2004/08/05 22:24:51  ullrich
00089  * Changes to the handling of numberOfPoints() to allow ITTF more flexibility.
00090  *
00091  * Revision 2.18  2004/07/15 16:36:26  ullrich
00092  * Removed all clone() declerations and definitions. Use StObject::clone() only.
00093  *
00094  * Revision 2.17  2003/10/31 16:00:04  ullrich
00095  * Added setKey() method.
00096  *
00097  * Revision 2.16  2003/10/30 20:07:32  perev
00098  * Check of quality added
00099  *
00100  * Revision 2.15  2002/03/14 17:42:15  ullrich
00101  * Added method to set mNumberOfPossiblePoints.
00102  *
00103  * Revision 2.14  2002/02/22 22:56:52  jeromel
00104  * Doxygen basic documentation in all header files. None of this is required
00105  * for QM production.
00106  *
00107  * Revision 2.13  2001/09/28 22:20:50  ullrich
00108  * Added helix geometry at last point.
00109  *
00110  * Revision 2.12  2001/05/30 17:45:55  perev
00111  * StEvent branching
00112  *
00113  * Revision 2.11  2001/04/05 04:00:45  ullrich
00114  * Replaced all (U)Long_t by (U)Int_t and all redundant ROOT typedefs.
00115  *
00116  * Revision 2.10  2001/03/24 03:34:59  perev
00117  * clone() -> clone() const
00118  *
00119  * Revision 2.9  2001/03/16 20:56:46  ullrich
00120  * Added non-const version of fitTraits().
00121  *
00122  * Revision 2.8  1999/12/01 15:58:10  ullrich
00123  * New decoding for dst_track::method. New enum added.
00124  *
00125  * Revision 2.7  1999/11/30 23:20:32  didenko
00126  * temporary solution to get library compiled
00127  *
00128  * Revision 2.6  1999/11/29 17:32:45  ullrich
00129  * Added non-const method pidTraits().
00130  *
00131  * Revision 2.5  1999/11/15 18:48:22  ullrich
00132  * Adapted new enums for dedx and track reco methods.
00133  *
00134  * Revision 2.4  1999/11/05 15:27:07  ullrich
00135  * Added non-const versions of several methods
00136  *
00137  * Revision 2.3  1999/11/04 13:32:03  ullrich
00138  * Added non-const versions of some methods
00139  *
00140  * Revision 2.2  1999/11/01 12:45:06  ullrich
00141  * Modified unpacking of point counter
00142  *
00143  * Revision 2.1  1999/10/28 22:27:24  ullrich
00144  * Adapted new StArray version. First version to compile on Linux and Sun.
00145  *
00146  * Revision 2.0  1999/10/12 18:42:56  ullrich
00147  * Completely Revised for New Version
00148  *
00149  * 
00150  **************************************************************************/
00151 #ifndef StTrack_hh
00152 #define StTrack_hh
00153 #include "StObject.h"
00154 #include "StContainers.h"
00155 #include "StEnumerations.h"
00156 #include "StTrackTopologyMap.h"
00157 #include "StFunctional.h"
00158 #include "StTrackFitTraits.h"
00159 
00160 class StParticleDefinition;
00161 class StVertex;
00162 class StTrackGeometry;
00163 class StTrackDetectorInfo;
00164 class StTrackPidTraits;
00165 class StTrackNode;
00166 
00167 class StTrack : public StObject {
00168 public:
00169     StTrack();
00170     StTrack(const StTrack&);
00171     StTrack & operator=(const StTrack&);
00172     virtual ~StTrack();
00173 
00174     virtual StTrackType            type() const = 0;
00175     virtual const StVertex*        vertex() const = 0;
00176     virtual Int_t                  key() const { return mKey; }
00177     Short_t                        flag() const;
00178     UInt_t                         flagExtension() const { return mFlagExtension; }
00179     UShort_t                       encodedMethod() const;
00180     bool                           finderMethod(StTrackFinderMethod) const;
00181     StTrackFittingMethod           fittingMethod() const;
00182     Float_t                        impactParameter() const;
00183     Float_t                        length() const;
00184     UShort_t                       numberOfPossiblePoints() const;
00185     UShort_t                       numberOfPossiblePoints(StDetectorId) const;
00186     const StTrackTopologyMap&      topologyMap() const;
00187     StTrackGeometry*               geometry();
00188     const StTrackGeometry*         geometry() const;
00189     StTrackGeometry*               outerGeometry();
00190     const StTrackGeometry*         outerGeometry() const;
00191     StTrackDetectorInfo*           detectorInfo();
00192     const StTrackDetectorInfo*     detectorInfo() const;
00193     StTrackFitTraits&              fitTraits();
00194     const StTrackFitTraits&        fitTraits() const;
00195     const StSPtrVecTrackPidTraits& pidTraits() const;
00196     StSPtrVecTrackPidTraits&       pidTraits();
00197     StPtrVecTrackPidTraits         pidTraits(StDetectorId) const;
00198     const StParticleDefinition*    pidTraits(StPidAlgorithm&) const;
00199     StTrackNode*                   node();
00200     const StTrackNode*             node() const;
00201     UShort_t                       seedQuality() const {return mSeedQuality;}
00202     Bool_t       isCtbMatched()            {return testBit(kCtbMatched);}   
00203     Bool_t       isToFMatched()            {return testBit(kToFMatched);}   
00204     Bool_t       isBToFMatched()           {return testBit(kToFMatched);}   
00205     Bool_t       isBemcMatched()           {return testBit(kBemcMatched);}  
00206     Bool_t       isEemcMatched()           {return testBit(kEemcMatched);}  
00207 
00208     Bool_t       isCtbNotMatched()         {return testBit(kCtbNotMatched);}   
00209     Bool_t       isToFNotMatched()         {return testBit(kToFNotMatched);}   
00210     Bool_t       isBToFNotMatched()        {return testBit(kToFNotMatched);}   
00211     Bool_t       isBemcNotMatched()        {return testBit(kBemcNotMatched);}  
00212     Bool_t       isEemcNotMatched()        {return testBit(kEemcNotMatched);}  
00213 
00214     Bool_t       isDecayTrack()            {return testBit(kDecayTrack);}   
00215     Bool_t       isPromptTrack()           {return testBit(kPromptTrack);}       
00216     Bool_t       isPostXTrack()            {return testBit(kPostXTrack);} 
00217     Bool_t       isMembraneCrossingTrack() {return testBit(kXMembrane);} 
00218     Bool_t       isShortTrack2EMC()        {return testBit(kShortTrack2EMC);}
00219     Bool_t       isRejected()              {return testBit(kRejectedTrack);}
00220 
00221     virtual void setCtbMatched()           {setBit(kCtbMatched);}   
00222     virtual void setToFMatched()           {setBit(kToFMatched);}   
00223     virtual void setBToFMatched()          {setBit(kToFMatched);}   
00224     virtual void setBemcMatched()          {setBit(kBemcMatched);}  
00225     virtual void setEemcMatched()          {setBit(kEemcMatched);}  
00226 
00227     virtual void setCtbNotMatched()        {setBit(kCtbNotMatched);}   
00228     virtual void setToFNotMatched()        {setBit(kToFNotMatched);}   
00229     virtual void setBToFNotMatched()       {setBit(kToFNotMatched);}   
00230     virtual void setBemcNotMatched()       {setBit(kBemcNotMatched);}  
00231     virtual void setEemcNotMatched()       {setBit(kEemcNotMatched);}  
00232     virtual void setDecayTrack()           {setBit(kDecayTrack);}   
00233     virtual void setPromptTrack()          {setBit(kPromptTrack);}       
00234     virtual void setPostCrossingTrack()    {setBit(kPostXTrack);} 
00235     virtual void setMembraneCrossingTrack(){setBit(kXMembrane);} 
00236     virtual void setShortTrack2EMC()       {reSetBit(kRejectedTrack); setBit(kShortTrack2EMC);}
00237     virtual void setRejected()             {setBit(kRejectedTrack);}
00238     virtual void setFlagExtension(UInt_t i){mFlagExtension = i;}
00239     void         setFlag(Short_t);
00240     void         setKey(Int_t val) { mKey = val; }
00241     void         setEncodedMethod(UShort_t);
00242     void         setImpactParameter(float);
00243     void         setLength(float);
00244     void         setTopologyMap(const StTrackTopologyMap&);
00245     void         setGeometry(StTrackGeometry*);
00246     void         setOuterGeometry(StTrackGeometry*);
00247     void         setFitTraits(const StTrackFitTraits&);
00248     void         addPidTraits(StTrackPidTraits*);
00249     void         setDetectorInfo(StTrackDetectorInfo*);
00250     void         setNode(StTrackNode*);
00251     Int_t        bad() const;
00252     void         setNumberOfPossiblePoints(unsigned char, StDetectorId);
00253     void         setSeedQuality(UShort_t qa)            {mSeedQuality = qa;}
00254     Int_t        idTruth() const                        { return mIdTruth;}
00255     Int_t        qaTruth() const                        { return mQuality; }
00256     Int_t        idParentVx() const {return mIdParentVx;}
00257     void         setIdTruth(Int_t idtru,Int_t qatru=0)  {mIdTruth = (UShort_t) idtru; mQuality = (UShort_t) qatru;}
00258     void         setIdTruth();                          //setting on hits info
00259     void         setIdParentVx(Int_t id) {mIdParentVx = id;}
00260    //----- bit manipulation
00261     void         setBit(UInt_t f, Bool_t set) {(set) ? setBit(f) : reSetBit(f);}
00262     void         setBit(UInt_t f) { mFlagExtension |= f; }
00263     void         reSetBit(UInt_t f) { mFlagExtension &= ~(f); }
00264     Bool_t       testBit(UInt_t f) const { return (Bool_t) ((mFlagExtension & f) != 0); }
00265     Int_t        testBits(UInt_t f) const { return (Int_t) (mFlagExtension & f); }
00266     void         invertBit(UInt_t f) { mFlagExtension ^= f; }
00267     
00268 protected:
00269     void         setNumberOfPossiblePoints(UShort_t); // obsolete
00270     
00271 protected:
00272     Char_t                  mBeg[1]; 
00273     Int_t                   mKey;
00274     Short_t                 mFlag;
00275     UInt_t                  mFlagExtension; // bit wise fast detector matching status
00276     UShort_t                mEncodedMethod;
00277     UShort_t                mSeedQuality;   // ITTF: this is seed quality
00278     UChar_t                 mNumberOfPossiblePointsTpc;
00279     UChar_t                 mNumberOfPossiblePointsFtpcWest;
00280     UChar_t                 mNumberOfPossiblePointsFtpcEast;
00281     UChar_t                 mNumberOfPossiblePointsSvt;
00282     UChar_t                 mNumberOfPossiblePointsSsd;
00283     UChar_t                 mNumberOfPossiblePointsPxl;
00284     UChar_t                 mNumberOfPossiblePointsIst;
00285     Float_t                 mImpactParameter;
00286     Float_t                 mLength;
00287     StTrackGeometry        *mGeometry;
00288     StTrackGeometry        *mOuterGeometry;
00289     UShort_t                mIdTruth; // MC track id 
00290     UShort_t                mQuality; // quality of this information (percentage of hits coming from the above MC track)
00291     Int_t                   mIdParentVx; // MC Parent vertex Id
00292     Char_t                  mEnd[1]; 
00293     StTrackTopologyMap      mTopologyMap;
00294     StTrackFitTraits        mFitTraits;
00295     
00296 //  StTrackDetectorInfo         *mDetectorInfo;         //$LINK
00297 //  StTrackNode                 *mNode;                 //$LINK
00298 #ifdef __CINT__
00299     StObjLink                mDetectorInfo;         
00300     StObjLink                    mNode;                         
00301 #else
00302     StLink<StTrackDetectorInfo>  mDetectorInfo;         
00303     StLink<StTrackNode>          mNode;                         
00304 #endif //__CINT__
00305 
00306     StSPtrVecTrackPidTraits mPidTraitsVec;
00307 
00308     ClassDef(StTrack,9)
00309 };
00310 #endif