StEmbeddingQAUtilities.h

//----------------------------------------------------------------------------------------------------
//  Class StEmbeddingQAUtilities
//    - Provide category id, such as 'MC' track in the minimc tree
//----------------------------------------------------------------------------------------------------
/****************************************************************************************************
 * $Id: StEmbeddingQAUtilities.h,v 1.13 2019/07/10 05:46:53 zhux Exp $
 * $Log: StEmbeddingQAUtilities.h,v $
 * Revision 1.13  2019/07/10 05:46:53  zhux
 * added option for btof pid for primary real tracks
 *
 * Revision 1.12  2012/03/05 10:32:50  cpowell
 * Functions added to cut on refMult
 *
 * Revision 1.11  2011/04/26 20:27:22  hmasui
 * Add isGamma function
 *
 * Revision 1.10  2011/04/05 23:12:35  hmasui
 * Added getGeantId() function
 *
 * Revision 1.9  2011/04/01 05:02:48  hmasui
 * Implement track selections (moved from StEmbeddingQATrack)
 *
 * Revision 1.8  2010/08/13 21:54:35  hmasui
 * Separate charge for pi/K/p
 *
 * Revision 1.7  2010/07/12 21:27:29  hmasui
 * Added StParticleTable & StParticleDefinition utilities
 *
 * Revision 1.6  2010/01/26 17:45:06  hmasui
 * Add runid functions
 *
 * Revision 1.5  2009/12/22 21:37:55  hmasui
 * Add comments for functions and members
 *
 ****************************************************************************************************/

#ifndef __StEmbeddingQAUtilities_h__
#define __StEmbeddingQAUtilities_h__

class StParticleDefinition ;
class TH1 ;
#include <map>
#include <vector>
#include "TString.h"
#include "StMiniMcEvent/StMiniMcEvent.h"

//____________________________________________________________________________________________________
namespace StEmbeddingQAConst 
{
  //----------------------------------------------------------------------------------------------------
  //  id       node           description
  //----------------------------------------------------------------------------------------------------
  //  0         MC             MC tracks (embedding)
  //  1         MATCHED        Matched pairs (embedding)
  //  2         GHOST          Ghost pairs (embedding)
  //  3         CONTAM         Contaminated pairs (embedding)
  //  4         MATGLOB        Matched global pairs (embedding)
  //----------------------------------------------------------------------------------------------------
  //  5         PRIMARY        Primary tracks (real)
  //  6         GLOBAL         Global tracks (real)
  //----------------------------------------------------------------------------------------------------
  enum {
    mNEmbedding = 5,
    mNReal      = 2,
    mNCategory  = mNEmbedding + mNReal
  };
}

//____________________________________________________________________________________________________
class StEmbeddingQAUtilities {
  public:
    static StEmbeddingQAUtilities* instance();

    virtual ~StEmbeddingQAUtilities();

    // Track category for minimc nodes
    Category getCategory(const UInt_t id) const ;      
    TString getCategoryName(const UInt_t id) const ;   
    TString getCategoryTitle(const UInt_t id) const ;  
    Int_t getCategoryId(const TString name) const ;    

    // Input string is case insensitive
    //  - For example, MC, mc, mC and Mc are ok for isMc()
    Bool_t isMc(const TString name) const ;            
    Bool_t isMatched(const TString name) const ;       
    Bool_t isGhost(const TString name) const ;         
    Bool_t isContaminated(const TString name) const ;  
    Bool_t isMatchedGlobal(const TString name) const ; 
    Bool_t isPrimary(const TString name) const ;       
    Bool_t isGlobal(const TString name) const ;        
    Bool_t isEmbedding(const TString name) const ;     
    Bool_t isReal(const TString name) const ;          

    // Check geantid
    Bool_t isElectron(const Int_t geantid) const ;     
    Bool_t isPositron(const Int_t geantid) const ;     
    Bool_t isPiPlus(const Int_t geantid) const ;       
    Bool_t isPiMinus(const Int_t geantid) const ;      
    Bool_t isKPlus(const Int_t geantid) const ;        
    Bool_t isKMinus(const Int_t geantid) const ;       
    Bool_t isProton(const Int_t geantid) const ;       
    Bool_t isPBar(const Int_t geantid) const ;         
    Bool_t isElectrons(const Int_t geantid) const ;    
    Bool_t isPions(const Int_t geantid) const ;        
    Bool_t isKaons(const Int_t geantid) const ;        
    Bool_t isProtons(const Int_t geantid) const ;      
    Bool_t isEPiKP(const Int_t geantid) const ;        
    Bool_t isGamma(const Int_t geantid) const ;       

    // Histogram style
    void setStyle() const ;       
    void setStyle(TH1* h) const ; 

    // Run id
    Int_t getRunId(const Int_t runnumber, const Int_t year) const ; 
    Int_t getRunNumber(const Int_t runid, const Int_t year) const ; 

    StParticleDefinition* getParticleDefinition(const UInt_t geantid) const ;

    Bool_t isGeantIdOk(const UInt_t geantid) const ;

    Int_t getGeantId(const UInt_t geantid) const ;

    Float_t getPtMinCut() const ;
    Float_t getPtMaxCut() const ;
    Float_t getEtaCut() const ;
    Short_t getNHitCut() const ;
    Float_t getNHitToNPossCut() const ;
    Float_t getDcaCut() const ;
    Double_t getNSigmaCut() const ;
    Bool_t getBTofPid() const ;
    Float_t getRapidityCut() const ;
    Float_t getZVertexCut() const ;
    Int_t       getRefMultMinCut() const ;
    Int_t       getRefMultMaxCut() const ;
    std::vector<UInt_t> getTriggerIdCut() const ;

    Float_t setPtMinCut(const Float_t val) ;
    Float_t setPtMaxCut(const Float_t val) ;
    Float_t setEtaCut(const Float_t val) ;
    Short_t setNHitCut(const Short_t val) ;
    Float_t setNHitToNPossCut(const Float_t val) ;
    Float_t setDcaCut(const Float_t val) ;
    Double_t setNSigmaCut(const Double_t val) ;
    Bool_t setBTofPid(const Bool_t val) ;
    Float_t setRapidityCut(const Float_t val) ;
    Float_t setZVertexCut(const Float_t val) ;
    Int_t       setRefMultMinCut(const Int_t val) ;
    Int_t       setRefMultMaxCut(const Int_t val) ;
    void addTriggerIdCut(const UInt_t val) ;

    Bool_t isPtOk(const Float_t pt) const ;
    Bool_t isEtaOk(const Float_t eta) const ;
    Bool_t isNHitsFitOk(const Float_t nHitsFit) const ;
    Bool_t isNHitToNPossOk(const Float_t ratio) const ;
    Bool_t isDcaOk(const Float_t dca) const ;
    Bool_t isNSigmaOk(const Float_t nsigma) const ;
    Bool_t isRapidityOk(const Float_t y) const ;
    Bool_t isZVertexOk(const Float_t vz) const ;
    Bool_t isRefMultOk(const Int_t refMult) const ;
    Bool_t isTriggerOk(const UInt_t trigger) const ;

    void PrintCuts() const ;

  private:
    StEmbeddingQAUtilities();

    static StEmbeddingQAUtilities* mInstance ;

    Bool_t CompareString(const TString s0, const TString s1, const Bool_t isExact=kFALSE) const ;

    // Data members
    Category mCategory[StEmbeddingQAConst::mNEmbedding] ;    
    TString mCategoryName[StEmbeddingQAConst::mNCategory] ;  
    TString mCategoryTitle[StEmbeddingQAConst::mNCategory] ; 
    std::map<const TString, const UInt_t> mCategoryId ;      

    // Moved track selections from StEmbeddingQATrack
    // To change the track selections, use Set...() function, for example
    //   StEmbeddingQAUtilities::Instance()->SetPtMinCut(0.2);
    // The cut values will be displayed in the pdf file
    Float_t mPtMinCut                 ;  
    Float_t mPtMaxCut                 ;  
    Float_t mEtaCut                   ;  
    Short_t mNHitCut                  ;  
    Float_t mNHitToNPossCut           ;  
    Float_t mDcaCut                   ;  
    Double_t mNSigmaCut               ;  
    Bool_t mBTofPid                   ;  
    Float_t mRapidityCut              ;  
    Float_t mZVertexCut               ;  
    Int_t       mRefMultMinCut            ;  
    Int_t       mRefMultMaxCut            ;  
    std::vector<UInt_t> mTriggerIdCut ;  


    // Run id
    Int_t getYearNumber(const Int_t year) const ; // (year - 2000 + 1) * 10^6

    // See details in the source code
    UInt_t convertGeantId(const UInt_t geantid) const ;

    ClassDef(StEmbeddingQAUtilities, 1)
};

//____________________________________________________________________________________________________
inline Int_t StEmbeddingQAUtilities::getYearNumber(const Int_t year) const { return (year - 1999) * 1000000 ; }

//____________________________________________________________________________________________________
inline Int_t StEmbeddingQAUtilities::getRunId(const Int_t runnumber, const Int_t year) const
{
  return runnumber + getYearNumber(year) ;
}

//____________________________________________________________________________________________________
inline Int_t StEmbeddingQAUtilities::getRunNumber(const Int_t runid, const Int_t year) const
{
  return runid - getYearNumber(year) ;
}

#endif