StRoot: StMuDSTMaker/COMMON/StMuTrack.h Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StMuTrack.h,v 1.41 2012/05/07 14:47:06 fisyak Exp $
00004  * Author: Frank Laue, BNL, laue@bnl.gov
00005  *
00006  ***************************************************************************/
00007 
00016 #ifndef StMuTrack_h
00017 #define StMuTrack_h
00018 
00019 #include "StMuDst.h"
00020 #include "StMuEvent.h"
00021 #include "StMuHelix.h"
00022 #include "StMuUtilities.h"
00023 #include "StMuProbPidTraits.h"
00024 #include "StMuBTofPidTraits.h" 
00025 #include "StMuPrimaryTrackCovariance.h"
00026 
00027 
00028 #include "StEvent/StTrackTopologyMap.h"
00029 #include "StEvent/StRunInfo.h"
00030 #include "StEvent/StDcaGeometry.h"
00031 #include "StarClassLibrary/StPhysicalHelixD.hh"
00032 #include "StarClassLibrary/StThreeVectorD.hh"
00033 #include "StarClassLibrary/StThreeVectorF.hh"
00034 #include "StarClassLibrary/SystemOfUnits.h"
00035 
00036 #include "TObject.h"
00037 #include "TVector.h"
00038 
00039 #define __PROB_SCALE__  1000.
00040 #define __SIGMA_SCALE__ 1000.
00041 #define __NOVALUE__     -999
00042 
00043 class StRichSpectra;
00044 class StEvent;
00045 class StTrack;
00046 class StVertex;
00047 class StEmcGeom;
00048 class StEmcPosition;
00049 class StuProbabilityPidAlgorithm;
00050 
00051 class TObjArray;
00052 
00053 class StMuTrack : public TObject {
00054  public:
00055   StMuTrack(): mVertexIndex(0), mNHitsPossInner(0), mNHitsFitInner(0), mNHitsPossTpc(255), mNHitsFitTpc(255), mIndex2Cov(-1), 
00056     mIdTruth(0), mQuality(0), mIdParentVx(0) {/* no-op*/}; 
00057     StMuTrack(const StEvent*, const StTrack*, const StVertex*, int index2Global=-2, int index2RichSpectra=-2, bool l3=false, TObjArray *vtx_list=0); 
00058     short id() const; 
00059     short type() const; 
00060     short flag() const; 
00061     UInt_t                         flagExtension() const { return mFlagExtension; }
00062     int   bad () const; // track is bad
00064     int index2Global() const;
00065     int index2Cov() const;
00066     int index2RichSpectra() const; 
00067     int index2BTofHit() const; 
00068     int vertexIndex() const; 
00069         const StMuTrack* globalTrack() const; 
00070         const StMuTrack* primaryTrack() const; 
00071         const StRichSpectra* richSpectra() const; 
00072     const StMuBTofHit* tofHit() const;  
00073     unsigned short nHits() const;     
00074     unsigned short nHitsPoss() const; 
00075     unsigned short nHitsPoss(StDetectorId) const; 
00076     unsigned short nHitsDedx() const; 
00077     unsigned short nHitsFit() const;  
00078     unsigned short nHitsFit(StDetectorId) const;  
00079     double pidProbElectron() const; 
00080     double pidProbPion() const;     
00081     double pidProbKaon() const;     
00082     double pidProbProton() const;   
00083     double nSigmaElectron() const;  
00084     double nSigmaPion() const;      
00085     double nSigmaKaon() const;      
00086     double nSigmaProton() const;    
00087     double dEdx() const; 
00088     double chi2() const;     
00089     double chi2prob() const; 
00090     double chi2xy() const;   
00091     double chi2z() const;    
00092     double pt() const;   
00093     double phi() const;  
00094     double eta() const;  
00095     double length() const; 
00096     double lengthMeasured() const;  
00097     StTrackTopologyMap topologyMap() const; 
00098     Short_t charge() const;  
00099     const StThreeVectorF &p() const; 
00100     const StThreeVectorF &momentum() const; 
00101     StThreeVectorF dca(Int_t vtx_id=-1) const; 
00102     StThreeVectorF dcaGlobal(Int_t vtx_id=-1) const; 
00103     Float_t dcaD(Int_t vtx_id=-1) const; 
00104     Float_t dcaZ(Int_t vtx_id=-1) const; 
00105     const StThreeVectorF &firstPoint() const; 
00106     const StThreeVectorF &lastPoint() const; 
00107     StPhysicalHelixD helix() const; 
00108     StPhysicalHelixD outerHelix() const; 
00109     const StMuProbPidTraits &probPidTraits() const; 
00110     const StMuBTofPidTraits &btofPidTraits() const; 
00111     void setBTofPidTraits(const StMuBTofPidTraits& pid); 
00112     static void setProbabilityPidAlgorithm(StuProbabilityPidAlgorithm*); 
00113     static void setProbabilityPidCentrality(double cent); 
00114     virtual void Print(Option_t* option = "") const;  
00115     void setIndex2BTofHit(int i) {mIndex2BTofHit=i;} 
00116     void setIndex2Cov(int i) {mIndex2Cov=i;}    
00117 
00118         //Matching to BEMC related functions
00119         TArrayI getTower(bool useExitRadius=false, int det=1) const; //Get Tower track is pointing too -  1=BTOW, 3=BSMDE, 4=BSMDP //1=BTOW, 3=BSMDE, 4=BSMDP Returns TVector tower. tower[0] is module, tower[1] is eta, tower[2] is sub, and tower[3] is id
00120         double energyBEMC() const;
00121         bool matchBEMC() const;
00122   Int_t            idTruth() const { return mIdTruth;}
00123   Int_t            qaTruth() const { return mQuality; }
00124   Int_t           idParentVx() const {return mIdParentVx;}
00125   void            setIdTruth(Int_t idtru,Int_t qatru=0) {mIdTruth = (UShort_t) idtru; mQuality = (UShort_t) qatru;}
00126   void         setIdParentVx(Int_t id) {mIdParentVx = id;}
00127 
00128 protected:
00129   Short_t mId;
00130   Short_t mType;
00131   Short_t mFlag;
00132   UInt_t  mFlagExtension; // bit wise fast detector matching status
00133   Int_t mIndex2Global;
00134   Int_t mIndex2RichSpectra;
00135   Int_t mIndex2BTofHit;     // dongx
00136   Int_t mVertexIndex;       // Primary vertex id for this track's dca
00137   UChar_t mNHits;           // Total number of points (was (F)tpc only)
00138   UChar_t mNHitsPoss;       // Total possible points (was (F)tpc only)
00139   UChar_t mNHitsDedx;       
00140   UChar_t mNHitsFit;        // Total fitted points (was (F)tpc only)
00141   UChar_t mNHitsPossInner;  // Svt/Ist (3 bit) and Ssd (2 bit) possible hits, Pixel (3 bits)
00142   UChar_t mNHitsFitInner;   // Svt/Ist (3 bit) and Ssd (2 bit) fitted hits, Pixel (3 bits)
00143   UChar_t mNHitsPossTpc;    // Possible (F)tpc hits (Ftpc flagged with first 2 bits)
00144   UChar_t mNHitsFitTpc;     // Fitted (F)tpc hits (Ftpc flagged with first 2 bits)
00145   UShort_t mPidProbElectron;
00146   UShort_t mPidProbPion;
00147   UShort_t mPidProbKaon;
00148   UShort_t mPidProbProton;
00149   Int_t mNSigmaElectron;
00150   Int_t mNSigmaPion;
00151   Int_t mNSigmaKaon;
00152   Int_t mNSigmaProton;
00153   Float_t mdEdx;
00154   Float_t mChiSqXY;
00155   Float_t mChiSqZ;
00156   Float_t mPt;
00157   Float_t mEta;
00158   Float_t mPhi;
00159   StTrackTopologyMap mTopologyMap;
00160   StThreeVectorF mP;
00161   StThreeVectorF mDCA;
00162   StThreeVectorF mDCAGlobal;
00163   StThreeVectorF mFirstPoint;
00164   StThreeVectorF mLastPoint;
00165   StMuHelix mHelix;
00166   StMuHelix mOuterHelix;
00167   StMuProbPidTraits mProbPidTraits; 
00168   StMuBTofPidTraits mBTofPidTraits; 
00169   Int_t mIndex2Cov;
00170   // IdTruth
00171   UShort_t         mIdTruth; // MC track id if any 
00172   UShort_t         mQuality; // quality of this information (percentage of hits coming the above MC track)
00173   Int_t         mIdParentVx;
00174   void setIndex2Global(int i) {mIndex2Global=i;} 
00175   void setIndex2RichSpectra(int i) {mIndex2RichSpectra=i;} 
00176   void setVertexIndex(int i) { mVertexIndex=i; } 
00177   StThreeVectorF dca(const StThreeVectorF &pos) const; 
00178   StThreeVectorD dca(const StTrack*, const StVertex *vertex) const; 
00179   StThreeVectorD momentumAtPrimaryVertex(const StEvent *event, const StTrack* track, const StVertex *vertex) const; 
00180   void fillMuProbPidTraits(const StEvent*, const StTrack*); 
00181   void fillMuBTofPidTraits(const StTrack*); 
00182   static StuProbabilityPidAlgorithm* mProbabilityPidAlgorithm; 
00183   static double mProbabilityPidCentrality; 
00184   friend class StMuDst;
00185   friend class StMuDstFilterMaker;
00186   friend class StMuMomentumShiftMaker;
00187   ClassDef(StMuTrack,13)
00188 };
00189 
00190 inline short StMuTrack::id() const {return mId;}
00191 inline short StMuTrack::type() const {return mType;}
00192 inline short StMuTrack::flag() const {return mFlag;}
00193 inline int StMuTrack::index2Global() const {return mIndex2Global;}
00194 inline int StMuTrack::index2Cov() const {return mIndex2Cov;}
00195 inline int StMuTrack::index2RichSpectra() const {return mIndex2RichSpectra;}
00196 inline int StMuTrack::index2BTofHit() const {return mIndex2BTofHit;}  
00197 inline unsigned short StMuTrack::nHits() const {return mNHits;}
00198 inline unsigned short  StMuTrack::nHitsDedx() const {return mNHitsDedx;}
00199 inline unsigned short  StMuTrack::nHitsFit() const {return mNHitsFit;}
00200 inline double StMuTrack::pidProbElectron() const {return unPack(mPidProbElectron,__PROB_SCALE__);}
00201 inline double StMuTrack::pidProbPion() const     {return unPack(mPidProbPion,    __PROB_SCALE__);}
00202 inline double StMuTrack::pidProbKaon() const     {return unPack(mPidProbKaon,    __PROB_SCALE__);}
00203 inline double StMuTrack::pidProbProton() const   {return unPack(mPidProbProton,  __PROB_SCALE__);}
00204 inline double StMuTrack::nSigmaElectron() const  {return unPack(mNSigmaElectron, __SIGMA_SCALE__);}
00205 inline double StMuTrack::nSigmaPion() const      {return unPack(mNSigmaPion,     __SIGMA_SCALE__);}
00206 inline double StMuTrack::nSigmaKaon() const      {return unPack(mNSigmaKaon,     __SIGMA_SCALE__);}
00207 inline double StMuTrack::nSigmaProton() const    {return unPack(mNSigmaProton,   __SIGMA_SCALE__);}
00208 inline double StMuTrack::dEdx() const {return mdEdx;}
00209 inline double StMuTrack::chi2xy() const {return mChiSqXY;}
00210 inline double StMuTrack::chi2z() const {return mChiSqZ;}
00211 inline double StMuTrack::chi2() const {return mChiSqXY;}
00212 inline double StMuTrack::chi2prob() const {return mChiSqZ;}
00213 inline StTrackTopologyMap StMuTrack::topologyMap() const {return mTopologyMap;}
00214 inline short StMuTrack::charge() const {return mHelix.q();}
00215 inline double StMuTrack::pt() const {return mPt;}
00216 inline double StMuTrack::eta() const {return mEta;}
00217 inline double StMuTrack::phi() const {return mPhi;}
00218 inline const StThreeVectorF &StMuTrack::p() const {return mP;}
00219 inline const StThreeVectorF &StMuTrack::momentum() const {return mP;}
00220 inline const StThreeVectorF &StMuTrack::firstPoint() const {return mFirstPoint;}
00221 inline const StThreeVectorF &StMuTrack::lastPoint() const {return mLastPoint;}
00224 inline const StMuProbPidTraits &StMuTrack::probPidTraits() const { return mProbPidTraits;} 
00225 inline const StMuBTofPidTraits &StMuTrack::btofPidTraits() const { return mBTofPidTraits;} 
00226 inline void StMuTrack::setProbabilityPidAlgorithm(StuProbabilityPidAlgorithm* p) { mProbabilityPidAlgorithm=p;}
00227 inline void StMuTrack::setProbabilityPidCentrality(double cent) { mProbabilityPidCentrality = cent;}
00228 inline void StMuTrack::setBTofPidTraits(const StMuBTofPidTraits& pid) { mBTofPidTraits = pid; }
00229 
00230 inline const StMuTrack* StMuTrack::globalTrack() const { return (mIndex2Global>=0) ? (StMuTrack*)StMuDst::array(muGlobal)->UncheckedAt(mIndex2Global) :0;}
00231 inline const StRichSpectra* StMuTrack::richSpectra() const { return (mIndex2RichSpectra>=0) ? (StRichSpectra*)StMuDst::array(muRich)->UncheckedAt(mIndex2RichSpectra) : 0;}
00232 inline const StMuBTofHit* StMuTrack::tofHit() const { return (mIndex2BTofHit>=0) ? (StMuBTofHit*)StMuDst::btofArray(muBTofHit)->UncheckedAt(mIndex2BTofHit) :0;} 
00233 ostream&              operator<<(ostream& os, StMuTrack const & v);
00234 #endif
00235 
00236 /***************************************************************************
00237  *
00238  * $Log: StMuTrack.h,v $
00239  * Revision 1.41  2012/05/07 14:47:06  fisyak
00240  * Add handles for track to fast detector matching
00241  *
00242  * Revision 1.40  2011/10/17 00:19:14  fisyak
00243  * Active handing of IdTruth
00244  *
00245  * Revision 1.39  2011/10/11 20:35:43  fisyak
00246  * Make idTruth public
00247  *
00248  * Revision 1.38  2011/04/08 01:25:51  fisyak
00249  * Add branches for MC track and vertex information, add IdTruth to  tracks and vertices, reserve a possiblity to remove Strange MuDst
00250  *
00251  * Revision 1.37  2010/04/27 20:47:17  tone421
00252  * Added extra functions for BEMC matching. See this post for more details:
00253  *
00254  * http://www.star.bnl.gov/HyperNews-star/get/starsofi/7816.html
00255  *
00256  * Revision 1.36  2009/12/08 23:24:46  fine
00257  * Fix issue  #1748 http://www.star.bnl.gov/rt2/Ticket/Display.html?id=1748
00258  *
00259  * Revision 1.35  2009/12/01 21:56:35  tone421
00260  * Implemented changes as per http://www.star.bnl.gov/rt2/Ticket/Display.html?id=1734
00261  *
00262  * Revision 1.31  2009/09/01 16:37:11  tone421
00263  * Fixed in a bug for setBTofPidTraits
00264  *
00265  * Revision 1.30  2009/02/27 19:54:25  tone421
00266  * Iterated Class Def by 1 to accommodate new BTOF data member
00267  *
00268  * Revision 1.29  2009/02/20 16:37:44  tone421
00269  * *** empty log message ***
00270  *
00271  * Revision 1.27  2008/03/19 17:22:39  fisyak
00272  * Increase Version number
00273  *
00274  * Revision 1.26  2008/03/19 14:51:04  fisyak
00275  * Add two clone arrays for global and primary track covariance matrices, remove mSigmaDcaD and mSigmaDcaZ
00276  *
00277  * Revision 1.25  2007/10/18 03:44:24  mvl
00278  * Added Ist and Pixel hits to mNPossInner and mNFitInner
00279  *
00280  * Revision 1.24  2007/09/18 02:29:58  mvl
00281  * Added basic printing functionality. For convenience and to assist data consistency checks
00282  *
00283  * Revision 1.23  2007/04/20 06:23:46  mvl
00284  * Removed Q-vector flag (will implement utility class)
00285  *
00286  * Revision 1.21  2007/01/29 18:34:44  mvl
00287  * Updates to use StDcaGeometry for global DCA and momentum.
00288  * Added helper functions for radial and Z component: dcaD and dcaZ.
00289  * Uncertainties on those are stored in sigmaDcaD and sigmaDcaZ.
00290  * dcaD and dcaZ only work for the primary vertex to which the track belongs (avoid long extrapolations).
00291  *
00292  * Revision 1.20  2006/07/27 18:55:42  fisyak
00293  * Remove DCA hack used in SSD+SVT test production (P06id)
00294  *
00295  * Revision 1.17  2005/12/13 03:12:13  mvl
00296  * Changes to StMuDst2StEventMaker (code in StMuDst) and StMuDstFilterMaker
00297  * to no longer rely on track keys for matching global and primary tracks.
00298  * This was needed because track keys are not guaranteed to be unique anymore.
00299  *
00300  * Revision 1.16  2005/08/19 19:46:06  mvl
00301  * Further updates for multiple vertices. The main changes are:
00302  * 1) StMudst::primaryTracks() now returns a list (TObjArray*) of tracks
00303  *    belonging to the 'current' primary vertex. The index number of the
00304  *    'current' vertex can be set using StMuDst::setCurrentVertex().
00305  *    This also affects StMuDst::primaryTracks(int i) and
00306  *    StMuDst::numberOfprimaryTracks().
00307  * 2) refMult is now stored for all vertices, in StMuPrimaryVertex. The
00308  *    obvious way to access these numbers is from the StMuprimaryVertex structures,
00309  *    but for ebakcward compatibility a function is provided in StMuEvent as well
00310  *    (this is the only function taht works for existing MuDst)
00311  *
00312  * As an aside, I've also changes the internals of StMuDst::createStEvent and
00313  * StMuDst::fixTrackIndices() to be able to deal with a larger range of index numbers for tracks as generated by Ittf.
00314  *
00315  * BIG FAT WARNING: StMudst2StEventMaker and StMuDstFilterMaker
00316  * do not fully support the multiple vertex functionality yet.
00317  *
00318  * Revision 1.15  2005/07/15 21:45:08  mvl
00319  * 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())
00320  *
00321  * Revision 1.14  2005/07/06 21:40:18  fisyak
00322  * use template version of StPhysicalHelixD
00323  *
00324  * Revision 1.13  2005/03/17 21:55:00  mvl
00325  * Added StMuMomentumShiftMaker for applying a magnetic field scaling to the reconstructed MuDst. This class accesses StMuTrack, StMuEvent and StMuHelix and some Strangeness MuDst data members as 'friend'
00326  *
00327  * Revision 1.12  2004/10/22 23:44:16  mvl
00328  * Fixed StMuDst::fixTrackIndices()
00329  *
00330  * Revision 1.11  2004/08/14 00:53:42  mvl
00331  * Added 1 to possibel points for primary tracks, like in StEvent
00332  *
00333  * Revision 1.10  2004/08/07 02:44:06  mvl
00334  * Added support for fitted and possible points in different detectors, for ITTF
00335  *
00336  * Revision 1.9  2004/05/02 04:10:14  perev
00337  * private => protected
00338  *
00339  * Revision 1.8  2004/04/14 03:27:30  jeromel
00340  * Change init of mNSigma
00341  *
00342  * Revision 1.7  2003/10/28 18:57:56  perev
00343  * BadData protection added
00344  *
00345  * Revision 1.6  2002/11/18 14:29:32  laue
00346  * update for Yuri's new StProbPidTraits
00347  *
00348  * Revision 1.5  2002/09/19 21:54:01  laue
00349  * fix bug in length() method
00350  *
00351  * Revision 1.4  2002/08/20 19:55:49  laue
00352  * Doxygen comments added
00353  *
00354  * Revision 1.3  2002/04/01 22:42:30  laue
00355  * improved chain filter options
00356  *
00357  * Revision 1.2  2002/03/20 16:04:12  laue
00358  * minor changes, mostly added access functions
00359  *
00360  * Revision 1.1  2002/03/08 17:04:18  laue
00361  * initial revision
00362  *
00363  *
00364  **************************************************************************/