StRoot: StEvent/StTriggerData.h Source File

00001 /***************************************************************************
00002  *
00003  * $Id: StTriggerData.h,v 2.42 2012/05/07 14:42:58 fisyak Exp $
00004  *
00005  * Author: Akio Ogawa & Mirko Planinic, Feb 2003
00006  ***************************************************************************
00007  *
00008  * Description: abstract class for trigger data
00009  *
00010  ***************************************************************************
00011  *
00012  * $Log: StTriggerData.h,v $
00013  * Revision 2.42  2012/05/07 14:42:58  fisyak
00014  * Add handilings for Track to Fast Detectors Matching
00015  *
00016  * Revision 2.41  2012/04/30 15:19:11  ullrich
00017  * Added access function for l2sum (Akio)
00018  *
00019  * Revision 2.40  2012/02/01 17:00:07  ullrich
00020  * Fixed bug concerning seg failt when MIX DSM not in run and added new arg to MtdVpdTacDiff()
00021  *
00022  * Revision 2.39  2011/11/04 19:20:38  ullrich
00023  * Added tpcMaskDSM() - Akio.
00024  *
00025  * Revision 2.38  2011/10/17 15:36:37  fisyak
00026  * increment version no.
00027  *
00028  * Revision 2.37  2011/02/15 18:56:09  ullrich
00029  * New access fct for ZDCSMD, new ZDCSMD map, spinBit() modified.
00030  *
00031  * Revision 2.36  2011/01/18 23:06:07  ullrich
00032  * New function mtdgemAtAddress added. vpdADC, vpdTDC, vpdADCHighThr, vpdTDCHighThr, vpdEarliestTDC, and vpdEarliestTDCHighThr updated.
00033  *
00034  * Revision 2.35  2010/06/01 22:18:44  ullrich
00035  * Change member debug to mDebug.
00036  *
00037  * Revision 2.34  2010/04/07 14:43:19  ullrich
00038  * Added new access function for BBC large tile earliest TAC and difference
00039  *
00040  * Revision 2.33  2010/01/13 17:55:39  ullrich
00041  * Better mErrorFlags, abort, and debug flag handling, updated MTD DSM access function for run10, clean up compiler warning messages.
00042  *
00043  * Revision 2.32  2010/01/08 22:44:37  ullrich
00044  * Updates needed to add StFmsCollection and related classes.
00045  *
00046  * Revision 2.31  2009/08/24 22:38:28  ullrich
00047  * New data member mErrorFlag and referring access fct.
00048  *
00049  * Revision 2.30  2009/06/16 15:44:26  ullrich
00050  * Added fmsADC() method.
00051  *
00052  * Revision 2.29  2009/05/15 18:16:15  ullrich
00053  * Updates for pp2pp and ToF.
00054  *
00055  * Revision 2.28  2009/05/05 20:53:16  ullrich
00056  * Updates for MTD.
00057  *
00058  * Revision 2.27  2009/03/19 02:46:01  ullrich
00059  * Add 2nd argument (pre/post) to vpdEarliestTDC().
00060  *
00061  * Revision 2.26  2009/03/04 02:01:30  ullrich
00062  * New access functions for ZDC DSM layer-1 and layer-2 data.
00063  *
00064  * Revision 2.25  2009/02/23 22:31:09  ullrich
00065  * Fixed problem when running over 2009 data (solution by Pibero) and new VPD access functions.
00066  *
00067  * Revision 2.24  2009/02/13 23:04:50  ullrich
00068  * Updates necessary for use in Online QA (P) plots.
00069  *
00070  * Revision 2.23  2009/02/11 23:33:55  jeromel
00071  * Modifications by Akio to support getDsm0_BEMCE and getDsm0_BEMCW as well as
00072  * getDsm1_BEMC. However, use of const=0 impose implementation (was not done
00073  * in years < 2009). Added methods with return 0.
00074  *
00075  * Revision 2.22  2009/01/20 18:10:14  ullrich
00076  * Bug fix and new ZDC access functions.
00077  *
00078  * Revision 2.21  2009/01/14 17:54:45  ullrich
00079  * Modified to cope with necessary changes for 2009.
00080  *
00081  * Revision 2.20  2008/03/12 15:56:41  ullrich
00082  * Add new methods tofAtAddress() and tofMultiplicity().
00083  *
00084  * Revision 2.19  2007/07/02 17:03:02  ullrich
00085  * Add two new members mtdAdc() and mtdTdc() (Akio).
00086  *
00087  * Revision 2.18  2007/05/15 16:31:26  ullrich
00088  * Add virtual function mtdAtAddress().
00089  *
00090  * Revision 2.17  2007/04/03 20:10:49  ullrich
00091  * Added access function for VPD data.
00092  *
00093  * Revision 2.16  2006/09/20 00:44:56  ullrich
00094  * Modified method to return length of L2 results.
00095  *
00096  * Revision 2.15  2006/09/19 22:53:55  ullrich
00097  * Added access method to L2 results.
00098  *
00099  * Revision 2.14  2006/09/13 23:59:55  ullrich
00100  * Added new data member mRun. Removed arg run from ctb(), ctbTraySlat(), zdcSMD()
00101  *
00102  * Revision 2.13  2006/08/21 19:41:50  ullrich
00103  * Add run number as argument to ctb(), ctbTray(), and zdcSMD(). Used 2005 only. (Akio)
00104  *
00105  * Revision 2.12  2006/05/05 16:01:41  ullrich
00106  * Added isL2Triggered().
00107  *
00108  * Revision 2.11  2006/03/22 20:58:21  ullrich
00109  * Added interface to L2 results (offsets).
00110  *
00111  * Revision 2.10  2004/11/30 19:19:11  ullrich
00112  * Added new access function for EEMC data (Akio).
00113  *
00114  * Revision 2.9  2004/10/20 18:56:22  ullrich
00115  * Add method getRawSize().
00116  *
00117  * Revision 2.8  2004/08/03 17:22:16  ullrich
00118  * Major update by Akio and Marco.
00119  *
00120  * Revision 2.7  2004/07/20 18:02:26  jeromel
00121  * Updates from Akio to fix CTB issues.
00122  *
00123  * Revision 2.6  2004/02/11 01:39:51  ullrich
00124  * Use enumeration StBeamDirector for east/west. Add member for ZDC vertex.
00125  *
00126  * Revision 2.5  2004/01/28 00:29:49  ullrich
00127  * Methods to retrieve ZDC data added.
00128  *
00129  * Revision 2.4  2003/12/23 21:58:28  ullrich
00130  * Modifications to handle StTruggerData2004.
00131  *
00132  * Revision 2.3  2003/07/16 19:58:31  perev
00133  * Cleanup of StTriggerData2003 at all
00134  *
00135  * Revision 2.2  2003/05/21 03:58:44  ullrich
00136  * Added more methods to retrieve spin bits.
00137  *
00138  * Revision 2.1  2003/04/16 17:47:41  ullrich
00139  * Initial Revision.
00140  *
00141  **************************************************************************
00142  *
00143  * prepost argument should go between -5 and 5, and 0 is triggered crossing
00144  *
00145  **************************************************************************/
00146 
00147 #ifndef StTriggerData_hh
00148 #define StTriggerData_hh
00149 
00150 #include "StObject.h"
00151 #include "StEnumerations.h"
00152 #include "StMessMgr.h"
00153 
00154 class StTriggerData : public StObject {
00155 public:
00156     StTriggerData();
00157     virtual ~StTriggerData();
00158     
00159     virtual void readData() {};
00160     virtual void dump() const = 0;   //dump data into text
00161     virtual void setDebug(unsigned int); 
00162        
00163     // version and data type information   
00164     virtual int year() const;                          // year of the data
00165     virtual unsigned int version() const = 0;          // TrgDataType Version Number 
00166     virtual unsigned int numberOfPreXing() const = 0;  // # of pre xing data for detectors
00167     virtual unsigned int numberOfPostXing() const = 0; // # of post xing data for detectors
00168     virtual unsigned int errorFlag() const;            // error flag
00169   
00170     // generic trigger infomations
00171     virtual unsigned int eventNumber() const;
00172     virtual unsigned int token() const = 0;
00173     virtual unsigned int triggerWord() const = 0;
00174     virtual unsigned int actionWord() const = 0;  
00175     virtual unsigned short busyStatus() const;
00176     virtual unsigned short dsmInput() const;
00177     virtual unsigned short trgToken() const;
00178     virtual unsigned short dsmAddress() const;
00179     virtual unsigned short mAddBits() const;
00180     virtual unsigned short bcData(int channel) const;
00181 
00182     //L2 results offsets 
00183     virtual int L2ResultsOffset(StL2AlgorithmId id) const;  
00184     bool isL2Triggered(StL2TriggerResultType id) const;
00185     virtual unsigned long long l2sum() const;
00186 
00187     // bunch and spin bits
00188     virtual unsigned int bunchCounterHigh() const;
00189     virtual unsigned int bunchCounterLow() const;
00190     virtual unsigned int bunchId48Bit() const;
00191     virtual unsigned int bunchId7Bit() const;
00192     virtual unsigned int spinBit() const;
00193     virtual unsigned int spinBitYellowFilled() const;
00194     virtual unsigned int spinBitYellowUp() const;
00195     virtual unsigned int spinBitYellowDown() const;
00196     virtual unsigned int spinBitYellowUnpol() const;
00197     virtual unsigned int spinBitBlueFilled() const;
00198     virtual unsigned int spinBitBlueUp() const;
00199     virtual unsigned int spinBitBlueDown() const;
00200     virtual unsigned int spinBitBlueUnpol() const;
00201   
00202     // high level DSM infos
00203     virtual unsigned short tcuBits() const = 0;
00204     virtual unsigned short lastDSM(int channel) const;
00205     virtual unsigned short vertexDSM(int channel) const;
00206     virtual unsigned short ctbLayer1DSM(int channel) const;
00207     virtual unsigned short ctbLayer2DSM(int channel) const;
00208     virtual unsigned short bemcLayer1DSM(int channel, int prepost=0) const;
00209     virtual unsigned short eemcLayer1DSM(int channel, int prepost=0) const;
00210     virtual unsigned short emcLayer2DSM(int channel) const;
00211     virtual unsigned short tpcMaskDSM(int channel) const;
00212     virtual unsigned short fpdLayer1DSMRaw(StBeamDirection eastwest, int channel, int prepost=0) const;
00213     virtual unsigned short fpdLayer1DSM(StBeamDirection eastwest, int module, int board, int prepsot=0) const;
00214     virtual unsigned short fpdLayer2DSMRaw(int channel) const;
00215     virtual unsigned short fpdLayer2DSM(StBeamDirection eastwest, int module) const;
00216 
00217     // CTB
00218     virtual unsigned short ctbRaw(int address, int prepost=0) const;
00219     virtual unsigned short ctb(int pmt, int prepost=0) const;
00220     virtual unsigned short ctbTraySlat(int tray, int slat, int prepost=0) const;
00221     virtual unsigned short ctbSum(int prepost=0) const;
00222 
00223     // MWC
00224     virtual unsigned short mwc(int sector, int prepost=0) const;
00225 
00226     // ZDC 
00227     virtual bool zdcPresent(int prepost=0) const;
00228     virtual unsigned short zdcAtChannel(int channel, int prepost=0) const;
00229     virtual unsigned short zdcAtAddress(int address, int prepost=0) const;
00230     virtual unsigned short zdcUnAttenuated(StBeamDirection eastwest, int prepost=0) const;
00231     virtual unsigned short zdcAttenuated(StBeamDirection eastwest, int prepost=0) const;
00232     virtual unsigned short zdcADC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00233     virtual unsigned short zdcTDC(StBeamDirection eastwest, int prepost=0) const;
00234     virtual unsigned short zdcPmtTDC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00235     virtual unsigned short zdcHardwareSum(int prepost=0) const;
00236     // ZDC DSM L1
00237     virtual unsigned short zdcEarliestTDC(StBeamDirection eastwest, int prepost=0) const;
00238     virtual bool zdcSumADCaboveThreshold(StBeamDirection eastwest, int prepost=0) const;
00239     virtual bool zdcFrontADCaboveThreshold(StBeamDirection eastwest, int prepost=0) const;
00240     virtual bool zdcBackADCaboveThreshold(StBeamDirection eastwest, int prepost=0) const;
00241     virtual unsigned short zdcTruncatedSum(StBeamDirection eastwest, int prepost=0) const;
00242     // ZDC DSM L2
00243     virtual bool zdcSumADCaboveThresholdL2(StBeamDirection eastwest) const;
00244     virtual bool zdcFrontADCaboveThresholdL2(StBeamDirection eastwest) const;
00245     virtual bool zdcBackADCaboveThresholdL2(StBeamDirection eastwest) const;
00246     virtual unsigned short zdcTimeDifference() const;
00247     // ZDC DSM L3
00248     virtual bool zdcSumADCaboveThresholdL3(StBeamDirection eastwest) const;
00249     virtual bool zdcFrontADCaboveThresholdL3(StBeamDirection eastwest) const;
00250     virtual bool zdcBackADCaboveThresholdL3(StBeamDirection eastwest) const;
00251     virtual bool zdcTimeDifferenceInWindow() const;
00252 
00253     //ZDCSMD
00254     virtual bool zdcSMDPresent(int prepost=0) const;
00255     virtual unsigned short zdcSMD(StBeamDirection eastwest, int verthori, int strip, int prepost=0) const;
00256     virtual unsigned short zdcSMDHighestStrip(StBeamDirection eastwest, int verthori, int prepost=0) const;
00257 
00258     // EMC
00259     virtual unsigned char bemcHighTower(int patch_id, int prepost=0) const;
00260     virtual unsigned char bemcJetPatch (int patch_id, int prepost=0) const;
00261     virtual unsigned char eemcHighTower(int patch_id, int prepost=0) const;
00262     virtual unsigned char eemcJetPatch (int patch_id, int prepost=0) const;
00263     virtual unsigned char bemcHighestTowerADC(int prepost=0) const;
00264     virtual unsigned char eemcHighestTowerADC(int prepost=0) const;
00265 
00266     // BBC bbcTDC
00267     virtual unsigned short bbcADC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00268     virtual unsigned short bbcTDC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00269     virtual unsigned short bbcADCSum(StBeamDirection eastwest, int prepost=0) const;
00270     virtual unsigned short bbcADCSumLargeTile(StBeamDirection eastwest, int prepost=0) const;
00271     virtual unsigned short bbcEarliestTDC(StBeamDirection eastwest, int prepost=0) const;
00272     virtual unsigned short bbcTimeDifference() const;
00273     virtual unsigned short bbcEarliestTDCLarge(StBeamDirection eastwest, int prepost=0) const;
00274     virtual unsigned short bbcTimeDifferenceLarge() const;
00275   
00276     // FPD  module #: north=0, south=1, top=2, bottom=3, north preshower=4, south preshower=5
00277     virtual unsigned short fpd(StBeamDirection eastwest, int module, int pmt, int prepost=0) const; 
00278     virtual unsigned short fpdSum(StBeamDirection eastwest, int module) const;
00279   
00280     // FMS 
00281     virtual unsigned short nQTdata(int prepost=0) const;
00282     virtual unsigned int*  QTdata(int prepost=0) const;
00283     virtual unsigned short fmsADC(int crt, int adr, int ch, int prepost=0) const;
00284     virtual unsigned short fmsTDC(int crt, int adr, int ch, int prepost=0) const;
00285 
00286     // VPD
00287     virtual unsigned short vpdADC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00288     virtual unsigned short vpdTDC(StBeamDirection eastwest, int pmt, int prepost=0) const;
00289     virtual unsigned short vpdADCHighThr(StBeamDirection eastwest, int pmt, int prepost=0) const;
00290     virtual unsigned short vpdTDCHighThr(StBeamDirection eastwest, int pmt, int prepost=0) const;
00291     virtual unsigned short vpdEarliestTDC(StBeamDirection eastwest, int prepost=0) const;
00292     virtual unsigned short vpdEarliestTDCHighThr(StBeamDirection eastwest, int prepost=0) const;
00293     virtual unsigned short vpdTimeDifference() const;
00294 
00295     //MTD
00296     virtual unsigned short mtdAtAddress(int address, int prepost=0) const;
00297     virtual unsigned short mtdgemAtAddress(int address, int prepost=0) const;
00298     virtual unsigned short mtdAdc(StBeamDirection eastwest, int pmt, int prepost=0) const;
00299     virtual unsigned short mtdTdc(StBeamDirection eastwest, int pmt, int prepost=0) const;
00300     virtual unsigned char  mtdDsmAtCh(int ch, int prepost=0) const;
00301     virtual bool           mtdDsmHit(int pmt, int prepost=0) const;
00302     virtual unsigned short mtdVpdTacDiff() const;
00303 
00304     //TOF
00305     virtual unsigned short tofAtAddress(int address, int prepost=0) const;
00306     virtual unsigned short tofTrayMultiplicity(int tray, int prepost=0) const;
00307     virtual unsigned short tofMultiplicity(int prepost=0) const;
00308 
00309     //PP2PP
00310     virtual unsigned short pp2ppADC(StBeamDirection eastwest, int vh, int udio, int ch, int prepost=0) const;
00311     virtual unsigned short pp2ppTAC(StBeamDirection eastwest, int vh, int udio, int ch, int prepost=0) const;
00312     virtual unsigned long  pp2ppDSM(int prepost=0) const;
00313 
00314     // auxiliary information
00315     float zdcVertexZ() const;
00316     void  setZdcVertexZ(float);
00317     
00318     // Experts only!
00319     virtual char* getTriggerStructure() = 0;
00320     virtual int getRawSize() const = 0;
00321     virtual unsigned char*  getDsm0_BEMCE(int prepost=0) const =0;
00322     virtual unsigned char*  getDsm0_BEMCW(int prepost=0) const =0;
00323     virtual unsigned short* getDsm1_BEMC(int prepost=0)  const =0;
00324     virtual unsigned char*  getDsm0_EEMC(int prepost=0)  const =0;
00325     virtual unsigned short* getDsm1_EEMC(int prepost=0)  const =0;
00326     virtual unsigned short* getDsm2_EMC()                const =0;
00327     virtual unsigned short* getDsm3()                    const =0;
00328     virtual unsigned char*  getDsm_FMS(int prepost=0)    const;
00329     virtual unsigned char*  getDsm01_FMS(int prepost=0)  const;
00330     virtual unsigned char*  getDsm02_FMS(int prepost=0)  const;
00331     virtual unsigned short* getDsm1_FMS(int prepost=0)   const;
00332     virtual unsigned short* getDsm2_FMS() const;
00333     virtual unsigned int    l2ResultLength() const = 0;  // Length of raw info
00334     virtual const unsigned int* l2Result() const = 0;  // Pointer to raw info
00335 
00336     // StFmsHitMaker only!!!
00337     virtual void killFMS();
00338 
00339 protected:
00340     int prepostAddress(int prepost) const; //get pre&post xsing addess, return negative if bad.
00341         
00342     // Service routine to decode EMC layer0 DSM info into 12bit input values
00343     unsigned short decodeEmc12bit(const int dsm, const int channel, const unsigned char *raw) const;
00344   
00345     // Byte swapping functions
00346     void swapI(unsigned int *);
00347     void swapSCC(unsigned int *);
00348     void swapSS(unsigned int *);
00349     void swapIn(unsigned int *, unsigned int);
00350     void swapSSn(unsigned int *, unsigned int);
00351     void swapSCCn(unsigned int *, unsigned int);
00352 
00353     // QT data decoding
00354     enum {MaxQTData = 529}; 
00355     void decodeQT(unsigned int ndata, unsigned int *data, unsigned short adc[16][32], unsigned char tac[16][32]);
00356 
00357 protected:
00358     int   mYear;
00359     float mZdcVertexZ;    
00360     int   mRun;
00361     unsigned int mErrorFlag;
00362 
00363     unsigned int mDebug; 
00364 
00365     ClassDef(StTriggerData,7) 
00366 };
00367 
00368 inline void StTriggerData::swapI(unsigned int *var){
00369     *var = 
00370         (*var & 0xff000000) >> 24 |
00371         (*var & 0x00ff0000) >> 8  |
00372         (*var & 0x0000ff00) << 8  |
00373         (*var & 0x000000ff) << 24 ;
00374 }
00375 
00376 inline void StTriggerData::swapSCC(unsigned int *var){
00377     *var =
00378         (*var & 0x0000ff00) >> 8 |
00379         (*var & 0x000000ff) << 8 |
00380         (*var & 0xffff0000);
00381 }
00382 
00383 inline void StTriggerData::swapSS(unsigned int *var){
00384     *var = 
00385         (*var & 0xff000000) >> 8 |
00386         (*var & 0x00ff0000) << 8 |
00387         (*var & 0x0000ff00) >> 8 |
00388         (*var & 0x000000ff) << 8;
00389 }
00390 
00391 inline void StTriggerData::swapIn(unsigned int *var, unsigned int n)  {for(unsigned int i=0; i<n; i++)   {swapI(var++);} }
00392 inline void StTriggerData::swapSSn(unsigned int *var, unsigned int n) {for(unsigned int i=0; i<n/2; i++) {swapSS(var++);} }
00393 inline void StTriggerData::swapSCCn(unsigned int *var, unsigned int n){for(unsigned int i=0; i<n; i++)   {swapSCC(var++);} }
00394 
00395 #endif
00396