Utils/interface/MuonTools.h

//--------------------------------------------------------------------------------------------------
// $Id: MuonTools.h,v 1.5 2009/03/23 22:17:04 loizides Exp $
//
// MuonTools
//
// This class allows you to classify a given muon according to defined criteria. For this purpose
// is loads histograms from two ROOT files, specified in the constructor. The main function then
// is "IsGood(*muon, selection)" which returns true if the given muon fulfills the selection
// criteria. 
// 
// Logically, the code has been put together by Phil who took most of the ideas from
//  http://cmslxr.fnal.gov/lxr/source/RecoMuon/MuonIdentification/
//  http://cmslxr.fnal.gov/lxr/source/DataFormats/MuonReco/
//
// Authors: P.Harris, C.Loizides
//--------------------------------------------------------------------------------------------------

#ifndef MITPHYSICS_UTIL_MUONTOOLS_H
#define MITPHYSICS_UTIL_MUONTOOLS_H

#include "MitAna/DataTree/interface/Muon.h"
#include "MitAna/DataTree/interface/Collections.h"
#include "MitCommon/MathTools/interface/MathUtils.h"
#include "TH2D.h"

namespace mithep {
  class MuonTools {
    public:
      MuonTools(const char *mutemp="$CMSSW_BASE/src/MitPhysics/data/MuonCaloTemplate.root", 
                const char *pitemp="$CMSSW_BASE/src/MitPhysics/data/PionCaloTemplate.root");
      ~MuonTools();

      enum ESelType { 
        kAllArbitrated,          //All Arbitration(DT/CSC/RPC Hits) put on at least One Segements given a global Muon
        kPromptTight,            //Standard Global Muon Id
        kTMLastStationLoose,     //Loose matching requirements on lastmost muon station of reco 
        kTMLastStationTight,     //Tight matching requirements on lastmost muon station of reco 
        kTMOneStationLoose,      //Loose matching requirements on at least one muon station of reco 
        kTMOneStationTight,      //Tight matching requirements on at least one muon station of reco 
        kTM2DCompatibilityLoose, //Loose requirement on sum of compatabiliity variables ===> 1.2 Segment Compatability + 0.8 Calo Compatability > 0.8
        kTM2DCompatibilityTight  //Tight requirement on sum of compatabiliity variables ===> 1.2 Segment Compatability + 0.8 Calo Compatability > 1.2
      };

      Bool_t      Init(const char *mutemp, const char *pitemp);
      Bool_t      IsGood(const mithep::Muon *iMuon, ESelType iSel) const;               //Muon Id boolean which performs Id test above

      Double_t    GetCaloCompatability(const mithep::Muon *iMuon,                       //Compataibility varible of Muon to be muon based on Calorimeter Templates
                                       Bool_t iEMSpecial, Bool_t iCorrectedHCAL) const; //EM Special => different arrangement of ECAL for compat
      Double_t    GetSegmentCompatability(const mithep::Muon *iMuon)             const; //Compatability variable based on likelihood of well define track through chamnbers
    protected:
      void        DeleteHistos();
      Bool_t      Overflow(const TH2D *iHist, Double_t lVal0, Double_t lVal1)    const; 
      Double_t    SigWeight(Double_t iVal0, Double_t iVal1)                      const; 
   
    private:
      Bool_t      fIsInit;              //!=true if histograms are loaded
      TH2D       *fmuon_em_etaEmi;      //!=Minus Endcap EM       Calorimeter Deposit Template for Muons
      TH2D       *fmuon_had_etaEmi;     //!=Minus Endcap Hadronic Calorimeter Deposit Template for Muons
      TH2D       *fmuon_had_etaTmi;     //!=Minus Transition Hadronic Calorimeter Deposit Template for Muons
      TH2D       *fmuon_em_etaB;        //!=      Barrel EM       Calorimeter Deposit Template for Muons
      TH2D       *fmuon_had_etaB;       //!=      Barrel Hadronic Calorimeter Deposit Template for Muons
      TH2D       *fmuon_ho_etaB;        //!=      Barrel HO       Calorimeter Deposit Template for Muons
      TH2D       *fmuon_had_etaTpl;     //!=Plus  Transition Hadronic Calorimeter Deposit Template for Muons
      TH2D       *fmuon_em_etaEpl;      //!=Plus  Endcap EM       Calorimeter Deposit Template for Muons
      TH2D       *fmuon_had_etaEpl;     //!=Plus  Endcap Hadronic Calorimeter Deposit Template for Muons
      TH2D       *fpion_em_etaEmi;      //!=Minus Endcap EM       Calorimeter Deposit Template for Pions
      TH2D       *fpion_had_etaEmi;     //!=Minus Endcap Hadronic Calorimeter Deposit Template for Pions
      TH2D       *fpion_had_etaTmi;     //!=Minus Transition Hadronic Calorimeter Deposit Template for Pions
      TH2D       *fpion_em_etaB;        //!=      Barrel EM       Calorimeter Deposit Template for Pions
      TH2D       *fpion_had_etaB;       //!=      Barrel Hadronic Calorimeter Deposit Template for Pions
      TH2D       *fpion_ho_etaB;        //!=      Barrel HO       Calorimeter Deposit Template for Pions
      TH2D       *fpion_had_etaTpl;     //!=Plus  Transition Hadronic Calorimeter Deposit Template for Pions
      TH2D       *fpion_em_etaEpl;      //!=Plus  Endcap EM       Calorimeter Deposit Template for Pions
      TH2D       *fpion_had_etaEpl;     //!=Plus  Endcap Hadronic Calorimeter Deposit Template for Pions

      TH2D       *LoadHisto(const char *fname, TFile *file)                      const;
  };
}

//--------------------------------------------------------------------------------------------------
inline Double_t mithep::MuonTools::SigWeight(Double_t iVal0, Double_t iVal1) const
{
  //Returns Weighted uncertainty given segment matching uncertainty=iVal0,segment matching Pull=iVal1

  if (iVal1 < 1.)  ///if Pull defined and within range
    return 1.;
  if (iVal0 < 3. && iVal1 > 3.) {      //If Pull not well defined and uncertainty defined
    Double_t lVal = TMath::Max(iVal0,1.);
    return 1./TMath::Power(lVal,0.25);
  }

  Double_t lVal = TMath::Max(iVal1,1.); //If Pull > 1 and Pull < 3 return 1/Pull^4
  return 1./TMath::Power(lVal,0.25);
}
//--------------------------------------------------------------------------------------------------
inline Bool_t mithep::MuonTools::Overflow(const TH2D *iHist, Double_t lVal0, Double_t lVal1) const
{
  // Check if values are in overflow bins of given histogram.

  if(iHist == 0)
    return kTRUE;

  if (iHist ->GetXaxis()->FindBin(lVal0) == 0                  || 
      iHist ->GetXaxis()->FindBin(lVal0) >  iHist->GetNbinsX() || 
      iHist ->GetYaxis()->FindBin(lVal0) == 0                  || 
      iHist ->GetYaxis()->FindBin(lVal0) >  iHist->GetNbinsY()) {
    return kTRUE;
  }
  return kFALSE;
}
#endif
Revision:	1.6
Committed:	Mon Apr 6 13:35:35 2009 UTC (16 years, 1 month ago) by pharris
Content type:	text/plain
Branch:	MAIN
Changes since 1.5:	+39 -39 lines
Log Message:	Unprotected Compatability Methods and added comments
#	User	Rev	Content
1	loizides	1.3	//--------------------------------------------------------------------------------------------------
2	pharris	1.6	// $Id: MuonTools.h,v 1.5 2009/03/23 22:17:04 loizides Exp $
3	loizides	1.3	//
4			// MuonTools
5			//
6	loizides	1.4	// This class allows you to classify a given muon according to defined criteria. For this purpose
7			// is loads histograms from two ROOT files, specified in the constructor. The main function then
8			// is "IsGood(*muon, selection)" which returns true if the given muon fulfills the selection
9			// criteria.
10			//
11			// Logically, the code has been put together by Phil who took most of the ideas from
12			// http://cmslxr.fnal.gov/lxr/source/RecoMuon/MuonIdentification/
13			// http://cmslxr.fnal.gov/lxr/source/DataFormats/MuonReco/
14			//
15	loizides	1.3	// Authors: P.Harris, C.Loizides
16			//--------------------------------------------------------------------------------------------------
17
18	pharris	1.1	#ifndef MITPHYSICS_UTIL_MUONTOOLS_H
19			#define MITPHYSICS_UTIL_MUONTOOLS_H
20
21	loizides	1.3	#include "MitAna/DataTree/interface/Muon.h"
22	pharris	1.6	#include "MitAna/DataTree/interface/Collections.h"
23	loizides	1.3	#include "MitCommon/MathTools/interface/MathUtils.h"
24	pharris	1.1	#include "TH2D.h"
25
26			namespace mithep {
27			class MuonTools {
28	loizides	1.3	public:
29			MuonTools(const char *mutemp="$CMSSW_BASE/src/MitPhysics/data/MuonCaloTemplate.root",
30			const char *pitemp="$CMSSW_BASE/src/MitPhysics/data/PionCaloTemplate.root");
31			~MuonTools();
32
33			enum ESelType {
34	pharris	1.6	kAllArbitrated, //All Arbitration(DT/CSC/RPC Hits) put on at least One Segements given a global Muon
35			kPromptTight, //Standard Global Muon Id
36			kTMLastStationLoose, //Loose matching requirements on lastmost muon station of reco
37			kTMLastStationTight, //Tight matching requirements on lastmost muon station of reco
38			kTMOneStationLoose, //Loose matching requirements on at least one muon station of reco
39			kTMOneStationTight, //Tight matching requirements on at least one muon station of reco
40			kTM2DCompatibilityLoose, //Loose requirement on sum of compatabiliity variables ===> 1.2 Segment Compatability + 0.8 Calo Compatability > 0.8
41			kTM2DCompatibilityTight //Tight requirement on sum of compatabiliity variables ===> 1.2 Segment Compatability + 0.8 Calo Compatability > 1.2
42	loizides	1.3	};
43
44			Bool_t Init(const char mutemp, const char pitemp);
45	pharris	1.6	Bool_t IsGood(const mithep::Muon *iMuon, ESelType iSel) const; //Muon Id boolean which performs Id test above
46	loizides	1.3
47	pharris	1.6	Double_t GetCaloCompatability(const mithep::Muon *iMuon, //Compataibility varible of Muon to be muon based on Calorimeter Templates
48			Bool_t iEMSpecial, Bool_t iCorrectedHCAL) const; //EM Special => different arrangement of ECAL for compat
49			Double_t GetSegmentCompatability(const mithep::Muon *iMuon) const; //Compatability variable based on likelihood of well define track through chamnbers
50	loizides	1.3	protected:
51			void DeleteHistos();
52	pharris	1.6	Bool_t Overflow(const TH2D *iHist, Double_t lVal0, Double_t lVal1) const;
53			Double_t SigWeight(Double_t iVal0, Double_t iVal1) const;
54
55	loizides	1.3	private:
56	loizides	1.4	Bool_t fIsInit; //!=true if histograms are loaded
57	pharris	1.6	TH2D *fmuon_em_etaEmi; //!=Minus Endcap EM Calorimeter Deposit Template for Muons
58			TH2D *fmuon_had_etaEmi; //!=Minus Endcap Hadronic Calorimeter Deposit Template for Muons
59			TH2D *fmuon_had_etaTmi; //!=Minus Transition Hadronic Calorimeter Deposit Template for Muons
60			TH2D *fmuon_em_etaB; //!= Barrel EM Calorimeter Deposit Template for Muons
61			TH2D *fmuon_had_etaB; //!= Barrel Hadronic Calorimeter Deposit Template for Muons
62			TH2D *fmuon_ho_etaB; //!= Barrel HO Calorimeter Deposit Template for Muons
63			TH2D *fmuon_had_etaTpl; //!=Plus Transition Hadronic Calorimeter Deposit Template for Muons
64			TH2D *fmuon_em_etaEpl; //!=Plus Endcap EM Calorimeter Deposit Template for Muons
65			TH2D *fmuon_had_etaEpl; //!=Plus Endcap Hadronic Calorimeter Deposit Template for Muons
66			TH2D *fpion_em_etaEmi; //!=Minus Endcap EM Calorimeter Deposit Template for Pions
67			TH2D *fpion_had_etaEmi; //!=Minus Endcap Hadronic Calorimeter Deposit Template for Pions
68			TH2D *fpion_had_etaTmi; //!=Minus Transition Hadronic Calorimeter Deposit Template for Pions
69			TH2D *fpion_em_etaB; //!= Barrel EM Calorimeter Deposit Template for Pions
70			TH2D *fpion_had_etaB; //!= Barrel Hadronic Calorimeter Deposit Template for Pions
71			TH2D *fpion_ho_etaB; //!= Barrel HO Calorimeter Deposit Template for Pions
72			TH2D *fpion_had_etaTpl; //!=Plus Transition Hadronic Calorimeter Deposit Template for Pions
73			TH2D *fpion_em_etaEpl; //!=Plus Endcap EM Calorimeter Deposit Template for Pions
74			TH2D *fpion_had_etaEpl; //!=Plus Endcap Hadronic Calorimeter Deposit Template for Pions
75	loizides	1.3
76			TH2D LoadHisto(const char fname, TFile *file) const;
77			};
78			}
79
80			//--------------------------------------------------------------------------------------------------
81			inline Double_t mithep::MuonTools::SigWeight(Double_t iVal0, Double_t iVal1) const
82			{
83	pharris	1.6	//Returns Weighted uncertainty given segment matching uncertainty=iVal0,segment matching Pull=iVal1
84	loizides	1.3
85	pharris	1.6	if (iVal1 < 1.) ///if Pull defined and within range
86	loizides	1.3	return 1.;
87	pharris	1.6	if (iVal0 < 3. && iVal1 > 3.) { //If Pull not well defined and uncertainty defined
88	loizides	1.3	Double_t lVal = TMath::Max(iVal0,1.);
89			return 1./TMath::Power(lVal,0.25);
90			}
91
92	pharris	1.6	Double_t lVal = TMath::Max(iVal1,1.); //If Pull > 1 and Pull < 3 return 1/Pull^4
93	loizides	1.3	return 1./TMath::Power(lVal,0.25);
94			}
95			//--------------------------------------------------------------------------------------------------
96			inline Bool_t mithep::MuonTools::Overflow(const TH2D *iHist, Double_t lVal0, Double_t lVal1) const
97			{
98			// Check if values are in overflow bins of given histogram.
99
100			if(iHist == 0)
101			return kTRUE;
102
103			if (iHist ->GetXaxis()->FindBin(lVal0) == 0 \|\|
104			iHist ->GetXaxis()->FindBin(lVal0) > iHist->GetNbinsX() \|\|
105			iHist ->GetYaxis()->FindBin(lVal0) == 0 \|\|
106			iHist ->GetYaxis()->FindBin(lVal0) > iHist->GetNbinsY()) {
107			return kTRUE;
108			}
109			return kFALSE;
110			}
111			#endif