StEmbeddingQADraw.h

//----------------------------------------------------------------------------------------------------
//   Draw QA histograms
//     - Comparison of the results between embedding and real data
//     - Print only one PDF file by default. 
//
//----------------------------------------------------------------------------------------------------
//  NOTE: These functions are not used for the latest QA codes.
//       file           function
//       png            setPNGOn()
//       gif            setGIFOn()
//       jpg            setJPGOn()
//       eps            setEPSOn()
//       ps             setPSOn()
//----------------------------------------------------------------------------------------------------
//
//  You can make the QA plots by drawEmbeddingQA.C under StRoot/macros/embedding
//  Suppose you have output ROOT files: qa_embedding_2007_P08ic.root,
//  and qa_real_2007_P08ic.root (the output file format is automatically 
//  determined if you leave the output filename blank in StEmbeddingQAMaker)
//  Suppose you have embedded single pion+ (geantid=8) in the output files.
//
//    > root4star -b -q drawEmbeddingQA.C'("./", "qa_embedding_2007_P08ic.root", "qa_real_2007_P08ic.root", 8)'
//
//  First argument is the directory where the output figures are printed.
//  The default output directory is the current directory.
//  The 6th argument is the input geantid
//
//  If you name the output ROOT files by hand, you need to put the year,
//  production and particle name by yourself since those are used 
//  for the output figure name and to print those informations in 
//  the legend for each QA plot.
//  Suppose you have output ROOT files: qa_embedding.root and qa_real.root
//
//    > root4star -b -q drawEmbeddingQA.C'("./", "qa_embedding.root", "qa_real.root", 2005, "P08ic", 8)'
//
//
//  If you just want ot check the embedding output only, you can do 
//
//    > root4star -b -q drawEmbeddingQA.C'("./", "qa_embedding_2007_P08ic.root", "qa_real_2007_P08ic.root", 8, kTRUE)'
//
//  where the last argument is the switch to skip drawing the real data if it's true (default is false)
//
//----------------------------------------------------------------------------------------------------
/****************************************************************************************************
 * $Id: StEmbeddingQADraw.h,v 1.16 2011/04/12 03:01:07 hmasui Exp $
 * $Log: StEmbeddingQADraw.h,v $
 * Revision 1.16  2011/04/12 03:01:07  hmasui
 * Fix isMatchedPairOk() to properly process particles with decay daughters
 *
 * Revision 1.15  2011/02/11 03:44:57  hmasui
 * Draw error messages in pdf if histogram is missing. Add error check for Ncommon histogram
 *
 * Revision 1.14  2011/01/31 21:33:51  hmasui
 * Add setParentGeantId() function to allow the multiple decays
 *
 * Revision 1.13  2010/06/22 16:31:17  hmasui
 * Separate 2D and 1D QA for MC tracks. Add pol0 fit for MC eta, y and phi distributions.
 *
 * Revision 1.12  2010/06/10 14:51:01  hmasui
 * Added particle name functions
 *
 * Revision 1.11  2010/04/07 19:45:11  hmasui
 * Use box option for dE/dx vs p to reduce the pdf file size
 *
 * Revision 1.10  2010/03/15 21:05:23  hmasui
 * Separate MC vertices QA into 2 pages. Added constraint on z-vertex cut for vx(vy) vs vz histograms.
 *
 * Revision 1.9  2010/02/24 18:11:47  hmasui
 * Added isMC flag in drawProjection2D() to switch real or MC tracks
 *
 * Revision 1.8  2010/02/23 16:56:37  hmasui
 * Add phi distributions QA (MC vs reconstructed)
 *
 * Revision 1.7  2010/02/16 02:14:03  hmasui
 * Print PDF file only for all QA plots
 *
 * Revision 1.6  2009/12/22 21:40:11  hmasui
 * Add comments for functions and members
 *
 ****************************************************************************************************/


#ifndef __StEmbeddingQADraw_h__
#define __StEmbeddingQADraw_h__

#include <vector>

class TCanvas ;
class TH1 ;
class TFile ;
class TObject ;
class TPad ;
class TPaveText ;
class TPDF ;
#include "TString.h"

class StEmbeddingQADraw {
  public:
    StEmbeddingQADraw(const TString embeddingFile, const TString realDataFile, const Int_t geantid,
        const Bool_t isEmbeddingOnly = kFALSE);

    StEmbeddingQADraw(const TString embeddingFile, const TString realDataFile,
        const Int_t year, const TString production, const Int_t geantid, const Bool_t isEmbeddingOnly = kFALSE);
    virtual ~StEmbeddingQADraw();

    void init() ;

    void setParentGeantId(const Int_t parentgeantid) ;

    void setOutputDirectory(const TString name = "./") ;

    Bool_t draw() const ;       

    // Event-wise
    Bool_t drawEvent() const;     

    // Track-wise
    Bool_t drawMcTrack() const;    
    Bool_t drawTrack() const ;     

    Bool_t drawGeantId() const;    
    Bool_t drawPhi() const ;       
    Bool_t drawRapidity() const;   
    Bool_t drawPt() const;         
    Bool_t drawMomentum() const;   
    Bool_t drawdEdx() const;       
    Bool_t drawDca() const;        
    Bool_t drawNHit() const;       

    Bool_t finish() ;               

    void setPNGOn() ;        
    void setGIFOn() ;        
    void setJPGOn() ;        
    void setEPSOn() ;        
    void setPSOn() ;         

    Int_t getYear() const ;               
    const Char_t* getProduction() const ; 
    Int_t getGeantId() const ;            

    //   Default id = -1, returns particle name from mGeantId
    const Char_t* getParticleName(const Int_t geantid = -1) const ;

    void setPtMax(const Double_t ptmax) ; 

  private:
    //  return true only if both embedding and real data files are opened properly
    Bool_t open(const TString embeddingFile, const TString realDataFile) ;

    void print(const TCanvas& canvas, const TString name) const;

    //   if we don't find geantid in the MC histogram, replace mGeantId to that found in the MC histogram
    void checkInputGeantId() ;

    Bool_t isOpen() const ;

    Bool_t isMatchedPairOk() const ;

    void setDaughterGeantId() ;

    Int_t getEntries() const ;

    Bool_t isDecay() const ;

    // if input geantid (or daughter geantid) is not e/pi/K/p, use pi+(=8)
    Int_t getGeantIdReal(const Int_t daughter) const ;

    //    For embedding
    //      stable particles (# of daughters = 0) --> matched pairs
    //      unstable particles (# of daughters > 0) --> contaminated pairs
    //    For real data  --> primary tracks
    Int_t  getCategoryId(const Bool_t isEmbedding = kTRUE) const ;

    TObject* getHistogram(const TString name, const Bool_t isEmbedding = kTRUE) const ;

    TObject* getHistogram(const TString name, const UInt_t daughter, const Bool_t isEmbedding,
        const UInt_t parentparentid = 0) const ;

    const Char_t* getHistogramName(const TString name, const UInt_t daughter, const Bool_t isEmbedding,
        const UInt_t parentparentid = 0) const ;


    Double_t getNormalization(const TH1& h) const ;

    const Char_t* getBaseName() const ;

    Bool_t drawStatistics(const Double_t x1=0.1, const Double_t y1=0.2, const Double_t x2=0.9, const Double_t y2=0.8,
        const Double_t textSize = 0.05) const;

    TPaveText* drawHeader(const TString description,
        const Double_t x1=0.0, const Double_t y1=0.9, const Double_t x2=1.0, const Double_t y2=0.95, 
        const Double_t textSize = 0.032) const;

    void drawLegend(const UInt_t id, TH1* hembed, TH1* hreal, const Option_t* option="L",
        const Bool_t doSplit=kFALSE) const ;

    void drawErrorMessages(const TString histogramName) const ;

    Bool_t drawVertices() const;          
    Bool_t drawRunEventId() const;        
    Bool_t drawNumberOfParticles() const; 

    Bool_t drawdEdxVsMomentum(const Bool_t isMcMomentum=kTRUE) const ;

    // Added isMC flag
    //  isMC = kTRUE            --> Compare reconstructed embedding tracks with MC tracks
    //  isMC = kFALSE (default) --> Compare reconstructed embedding tracks with real data
    Bool_t drawProjection2D(const TString name, const Bool_t isMC = kFALSE) const; 
    Bool_t drawProjection3D(const TString name) const; 

    // Header for current QA, division of (x,y), default is (0,0), no division
    TPaveText* initCanvas(const TString header, const Int_t nx=0, const Int_t ny=0) const;

    Double_t getVzAcceptedMinimum() const ; 
    Double_t getVzAcceptedMaximum() const ; 

    const Char_t* getMcParticleName() const ; 

    const Char_t* getEmbeddingParticleName(const UInt_t id, const Bool_t doSplit=kFALSE) const ; 

    const Char_t* getRealParticleName(const UInt_t id, const Bool_t doSplit=kFALSE) const ; 

    // Data members
    static UInt_t mCanvasId ; 

    TCanvas* mCanvas ;        
    TPad* mMainPad ;          
    TPDF* mPDF ;              

    const Bool_t mIsEmbeddingOnly ;  

    Bool_t mIsOpen ;          

    Bool_t mIsPNGOn ;         
    Bool_t mIsGIFOn ;         
    Bool_t mIsJPGOn ;         
    Bool_t mIsEPSOn ;         
    Bool_t mIsPSOn ;          

    Int_t mYear ;             
    TString mProduction ;     
    Int_t mGeantId ;          
    Double_t mPtMax ;         

    TFile* mInputEmbedding ; 
    TFile* mInputRealData ;  

    TString mOutputFigureDirectory ; 

    std::vector<Int_t> mDaughterGeantId ; 
    std::vector<Int_t> mParentGeantId ;   
    std::vector<Int_t> mParentParentGeantId ; 
    std::vector<Int_t> mMcGeantId ;       
    Int_t mInputParentGeantId ; 

    ClassDef(StEmbeddingQADraw, 1)
};

inline Int_t StEmbeddingQADraw::getYear()               const { return mYear ; }
inline const Char_t* StEmbeddingQADraw::getProduction() const { return mProduction.Data() ; }
inline Int_t StEmbeddingQADraw::getGeantId()            const { return mGeantId ; }

#endif