Mods/interface/MuonIDMod.h

//--------------------------------------------------------------------------------------------------
// $Id: MuonIDMod.h,v 1.47 2012/05/05 08:51:09 ceballos Exp $
//
// MuonIDMod
//
// This module applies muon identification criteria and exports a pointer to a collection
// of "good muons" according to the specified ID scheme.
//
// See http://indico.cern.ch/contributionDisplay.py?contribId=1&confId=45945
// See http://indico.cern.ch/getFile.py/access?contribId=1&resId=0&materialId=slides&confId=42229
//
// Authors: S.Xie
//--------------------------------------------------------------------------------------------------

#ifndef MITPHYSICS_MODS_MUONIDMOD_H
#define MITPHYSICS_MODS_MUONIDMOD_H

#include "MitAna/TreeMod/interface/BaseMod.h" 
#include "MitAna/DataTree/interface/MuonFwd.h"
#include "MitAna/DataTree/interface/VertexFwd.h"
#include "MitAna/DataTree/interface/TrackFwd.h"
#include "MitAna/DataTree/interface/PFCandidateFwd.h"
#include "MitPhysics/Utils/interface/MuonTools.h"
#include "MitPhysics/Utils/interface/MuonIDMVA.h"
#include "MitPhysics/Utils/interface/IsolationTools.h"
#include "MitAna/DataTree/interface/PileupEnergyDensityCol.h"

#include "MitPhysics/Utils/interface/RhoUtilities.h"

namespace mithep 
{
  class MuonIDMod : public BaseMod
  {
    public:
      MuonIDMod(const char *name="MuonIDMod", 
                const char *title="Muon identification module");

      Double_t           GetCaloIsoCut()                const { return fCaloIsolationCut;   }
      const char        *GetClassType()                 const { return fMuonClassType;      }
      const char        *GetCleanName()                 const { return GetCleanMuonsName(); }   
      const char        *GetCleanMuonsName()            const { return fCleanMuonsName;     }   
      Double_t           GetCombIsoCut()                const { return fCombIsolationCut;   }
      const char        *GetIDType()                    const { return fMuonIDType;         }
      const char        *GetInputName()                 const { return fMuonBranchName;     }   
      const char        *GetIsoType()                   const { return fMuonIsoType;        }
      const char        *GetOutputName()                const { return GetCleanMuonsName(); }   
      Double_t           GetPtMin()                     const { return fMuonPtMin;          }
      Double_t           GetTrackIsoCut()               const { return fTrackIsolationCut;  }
      Bool_t             PassMuonMVA_BDTG_IdIso(const Muon *mu, const Vertex *vertex, 
                                                const PileupEnergyDensityCol *PileupEnergyDensity) const;
      Bool_t             PassMuonIsoRingsV0_BDTG_Iso(const Muon *mu, const Vertex *vertex, 
                                                     const PileupEnergyDensityCol *PileupEnergyDensity) const;
      Bool_t             PassMuonIsoDeltaR(const Muon *mu, const Vertex *vertex, 
                                           const PileupEnergyDensityCol *PileupEnergyDensity) const;
      void               SetPrintMVADebugInfo(Bool_t b)       { fPrintMVADebugInfo = b;     }
      void               SetApplyD0Cut(Bool_t b)              { fApplyD0Cut        = b;     }
      void               SetApplyDZCut(Bool_t b)              { fApplyDZCut        = b;     }
      void               SetCaloIsoCut(Double_t cut)          { fCaloIsolationCut  = cut;   }
      void               SetClassType(const char *type)       { fMuonClassType     = type;  }
      void               SetCleanMuonsName(const char *name)  { fCleanMuonsName    = name;  }   
      void               SetOldMuonsName(const char *n)       { fNonIsolatedMuonsName  = n; }  
      void               SetOldElectronsName(const char *n)   { fNonIsolatedElectronsName  = n; }  
      void               SetCleanName(const char *name)       { SetCleanMuonsName(name);    }   
      void               SetCombIsoCut(Double_t cut)          { fCombIsolationCut  = cut;   }
      void               SetCombRelativeIsoCut(Double_t cut)  { fCombRelativeIsolationCut  = cut; }
      void               SetPFIsoCut(Double_t cut)            { fPFIsolationCut  = cut;     }
      void               SetD0Cut(Double_t cut)               { fD0Cut             = cut;   }
      void               SetDZCut(Double_t cut)               { fDZCut             = cut;   }
      void               SetWhichVertex(Int_t d)              { fWhichVertex = d;           }
      void               SetEtaCut(Double_t cut)              { fEtaCut            = cut;   }
      void               SetIDType(const char *type)          { fMuonIDType        = type;  }
      void               SetInputName(const char *name)       { fMuonBranchName    = name;  }   
      void               SetIsoType(const char *type)         { fMuonIsoType       = type;  }
      void               SetOutputName(const char *name)      { SetCleanMuonsName(name);    }   
      void               SetPtMin(Double_t pt)                { fMuonPtMin         = pt;    }
      void               SetTrackIsoCut(Double_t cut)         { fTrackIsolationCut = cut;   }
      void               SetIntRadius(Double_t dr)            { fIntRadius = dr;            }

      void               SetRhoType(RhoUtilities::RhoType type)
        { fTheRhoType = type; };

      void               SetVertexName(const char* name) { fVertexName = name; }
      
      enum EMuIdType {
        kIdUndef = 0,       //not defined
        kWMuId,             //"WMuId"
        kZMuId,             //"ZMuId"
        kTight,             //"Tight"
        kLoose,             //"Loose"
        kWWMuIdV1,          //"WWMuIdV1"
        kWWMuIdV2,          //"WWMuIdV2"
        kWWMuIdV3,          //"WWMuIdV3"
        kWWMuIdV4,          //"WWMuIdV4"
        kNoId,              //"NoId"        
        kCustomId,          //"Custom"
        kMVAID_BDTG_IDIso   //"BDTG ID + Iso03, Iso04 Combined"
      };
      enum EMuIsoType {
        kIsoUndef = 0,                      //"not defined"
        kTrackCalo,                         //"TrackCalo"
        kTrackCaloCombined,                 //"TrackCaloCombined"
        kTrackCaloSliding,                  //"TrackCaloSliding"
        kTrackCaloSlidingNoCorrection,      //"TrackCaloSlidingNoCorrection"
        kCombinedRelativeConeAreaCorrected, //"CombinedRelativeConeAreaCorrected"
        kCombinedRelativeEffectiveAreaCorrected,
        kCustomIso,                         //"Custom"
        kPFIso,                             //"PFIso"
        kPFRadialIso,                       //"PFRadialIso"
        kPFIsoEffectiveAreaCorrected,       //"PFIso with EffectiveArea Pileup Correction"
        kPFIsoNoL,                          //"PFIsoNoL"
        kNoIso,                             //"NoIso"
        kMVAIso_BDTG_IDIso,                 //"BDTG ID + Iso03, Iso04 Combined"
        kIsoRingsV0_BDTG_Iso,               //"BDTG Iso Rings"
        kIsoDeltaR                          //"BGDT Iso dR"              
      };
      enum EMuClassType {
        kClassUndef = 0,    //not defined
        kAll,               //"All"
        kGlobal,            //"Global"
        kGlobalTracker,     //"GlobalTracker"
        kSta,               //"Standalone"
        kTrackerMuon,       //"TrackerMuon"
        kCaloMuon,          //"CaloMuon"
        kTrackerBased       //"TrackerMuon or CaloMuon"

      };

    protected:
      void               Process();
      void               SlaveBegin();
      void               Terminate();

      Bool_t             fPrintMVADebugInfo;   //print MVA debug information
      TString            fMuonBranchName;      //name of muon collection (input)
      TString            fCleanMuonsName;      //name of exported "good muon" collection
      TString            fNonIsolatedMuonsName;    //name of imported "old muon" collection
      TString            fNonIsolatedElectronsName;//name of imported "old electron" collection
      TString            fVertexName;          //name of vertex collection
      TString            fBeamSpotName;        //name of beamspot collection
      TString            fTrackName;           //name of track collection
      TString            fPFCandidatesName;    //name of pfcandidates collection
      TString            fMuonIDType;          //type of muon id scheme we impose
      TString            fMuonIsoType;         //type of muon isolations scheme we impose
      TString            fMuonClassType;       //type of muon class we impose
      Double_t           fTrackIsolationCut;   //cut value for track isolation
      Double_t           fCaloIsolationCut;    //cut value for calo isolation
      Double_t           fCombIsolationCut;    //cut value for combined isolation
      Double_t           fCombRelativeIsolationCut; //cut value for combined relative isolation
      Double_t           fPFIsolationCut;      //cut value for combined isolation
      Double_t           fMuonPtMin;           //min muon pt
      Bool_t             fApplyD0Cut;          //=true then apply d0 cut (def=1)
      Bool_t             fApplyDZCut;          //=true then apply dz cut (def=1)
      Double_t           fD0Cut;               //max d0
      Double_t           fDZCut;               //max dz
      Int_t              fWhichVertex;         //vertex to use (-2: beamspot, -1: closest in Z)
      Double_t           fEtaCut;              //max eta, absolute value
      EMuIdType          fMuIDType;            //!muon id type (imposed)
      EMuIsoType         fMuIsoType;           //!muon iso type (imposed)
      EMuClassType       fMuClassType;         //!muon class type (imposed)
      const MuonCol     *fMuons;               //!muon collection
      const VertexCol   *fVertices;            //!vertices branch
      const BeamSpotCol *fBeamSpot;            //!beamspot branch
      const TrackCol    *fTracks;              //!track branch     
      const PFCandidateCol *fPFCandidates;     //!pfcandidate branch
      const PFCandidateCol *fPFNoPileUpCands;  //!pfnpu collection
      Double_t           fIntRadius;           //!min IntRadius cut in pf isolation
      MuonCol            *fNonIsolatedMuons;    //!pointer to old muon collection 
      ElectronCol        *fNonIsolatedElectrons;//!pointer to old electron collection
      TString             fPileupEnergyDensityName;
      const PileupEnergyDensityCol *fPileupEnergyDensity;
      MuonTools          *fMuonTools;           // interface to tools for muon ID
      MuonIDMVA          *fMuonIDMVA;           // helper class for MuonMVA

      RhoUtilities::RhoType fTheRhoType;
      
    ClassDef(MuonIDMod, 1) // Muon identification module
  };
}
#endif
Revision:	1.48
Committed:	Sun May 6 10:30:40 2012 UTC (13 years ago) by ceballos
Content type:	text/plain
Branch:	MAIN
Changes since 1.47:	+2 -1 lines
Log Message:	adding WWMuIdV4
#	User	Rev	Content
1	loizides	1.1	//--------------------------------------------------------------------------------------------------
2	ceballos	1.48	// $Id: MuonIDMod.h,v 1.47 2012/05/05 08:51:09 ceballos Exp $
3	loizides	1.1	//
4			// MuonIDMod
5			//
6	loizides	1.6	// This module applies muon identification criteria and exports a pointer to a collection
7	loizides	1.7	// of "good muons" according to the specified ID scheme.
8	loizides	1.1	//
9	loizides	1.16	// See http://indico.cern.ch/contributionDisplay.py?contribId=1&confId=45945
10			// See http://indico.cern.ch/getFile.py/access?contribId=1&resId=0&materialId=slides&confId=42229
11			//
12	ceballos	1.15	// Authors: S.Xie
13	loizides	1.1	//--------------------------------------------------------------------------------------------------
14
15	loizides	1.6	#ifndef MITPHYSICS_MODS_MUONIDMOD_H
16			#define MITPHYSICS_MODS_MUONIDMOD_H
17	loizides	1.1
18			#include "MitAna/TreeMod/interface/BaseMod.h"
19	loizides	1.22	#include "MitAna/DataTree/interface/MuonFwd.h"
20			#include "MitAna/DataTree/interface/VertexFwd.h"
21	ceballos	1.28	#include "MitAna/DataTree/interface/TrackFwd.h"
22			#include "MitAna/DataTree/interface/PFCandidateFwd.h"
23	ceballos	1.5	#include "MitPhysics/Utils/interface/MuonTools.h"
24	sixie	1.38	#include "MitPhysics/Utils/interface/MuonIDMVA.h"
25	ceballos	1.28	#include "MitPhysics/Utils/interface/IsolationTools.h"
26	ceballos	1.31	#include "MitAna/DataTree/interface/PileupEnergyDensityCol.h"
27	loizides	1.1
28	fabstoec	1.43	#include "MitPhysics/Utils/interface/RhoUtilities.h"
29
30	loizides	1.1	namespace mithep
31			{
32			class MuonIDMod : public BaseMod
33			{
34			public:
35			MuonIDMod(const char *name="MuonIDMod",
36	loizides	1.6	const char *title="Muon identification module");
37
38	loizides	1.11	Double_t GetCaloIsoCut() const { return fCaloIsolationCut; }
39			const char *GetClassType() const { return fMuonClassType; }
40			const char *GetCleanName() const { return GetCleanMuonsName(); }
41			const char *GetCleanMuonsName() const { return fCleanMuonsName; }
42			Double_t GetCombIsoCut() const { return fCombIsolationCut; }
43			const char *GetIDType() const { return fMuonIDType; }
44			const char *GetInputName() const { return fMuonBranchName; }
45			const char *GetIsoType() const { return fMuonIsoType; }
46			const char *GetOutputName() const { return GetCleanMuonsName(); }
47	ceballos	1.24	Double_t GetPtMin() const { return fMuonPtMin; }
48	loizides	1.11	Double_t GetTrackIsoCut() const { return fTrackIsolationCut; }
49	sixie	1.38	Bool_t PassMuonMVA_BDTG_IdIso(const Muon mu, const Vertex vertex,
50	sixie	1.39	const PileupEnergyDensityCol *PileupEnergyDensity) const;
51	ceballos	1.45	Bool_t PassMuonIsoRingsV0_BDTG_Iso(const Muon mu, const Vertex vertex,
52			const PileupEnergyDensityCol *PileupEnergyDensity) const;
53	ceballos	1.46	Bool_t PassMuonIsoDeltaR(const Muon mu, const Vertex vertex,
54			const PileupEnergyDensityCol *PileupEnergyDensity) const;
55	sixie	1.41	void SetPrintMVADebugInfo(Bool_t b) { fPrintMVADebugInfo = b; }
56	loizides	1.20	void SetApplyD0Cut(Bool_t b) { fApplyD0Cut = b; }
57	ceballos	1.32	void SetApplyDZCut(Bool_t b) { fApplyDZCut = b; }
58	loizides	1.11	void SetCaloIsoCut(Double_t cut) { fCaloIsolationCut = cut; }
59			void SetClassType(const char *type) { fMuonClassType = type; }
60	loizides	1.18	void SetCleanMuonsName(const char *name) { fCleanMuonsName = name; }
61	sixie	1.35	void SetOldMuonsName(const char *n) { fNonIsolatedMuonsName = n; }
62			void SetOldElectronsName(const char *n) { fNonIsolatedElectronsName = n; }
63	loizides	1.11	void SetCleanName(const char *name) { SetCleanMuonsName(name); }
64	loizides	1.18	void SetCombIsoCut(Double_t cut) { fCombIsolationCut = cut; }
65	sixie	1.35	void SetCombRelativeIsoCut(Double_t cut) { fCombRelativeIsolationCut = cut; }
66			void SetPFIsoCut(Double_t cut) { fPFIsolationCut = cut; }
67	loizides	1.20	void SetD0Cut(Double_t cut) { fD0Cut = cut; }
68	ceballos	1.32	void SetDZCut(Double_t cut) { fDZCut = cut; }
69			void SetWhichVertex(Int_t d) { fWhichVertex = d; }
70	ceballos	1.25	void SetEtaCut(Double_t cut) { fEtaCut = cut; }
71	loizides	1.11	void SetIDType(const char *type) { fMuonIDType = type; }
72			void SetInputName(const char *name) { fMuonBranchName = name; }
73			void SetIsoType(const char *type) { fMuonIsoType = type; }
74			void SetOutputName(const char *name) { SetCleanMuonsName(name); }
75			void SetPtMin(Double_t pt) { fMuonPtMin = pt; }
76			void SetTrackIsoCut(Double_t cut) { fTrackIsolationCut = cut; }
77	ceballos	1.36	void SetIntRadius(Double_t dr) { fIntRadius = dr; }
78	loizides	1.6
79	fabstoec	1.43	void SetRhoType(RhoUtilities::RhoType type)
80			{ fTheRhoType = type; };
81
82	fabstoec	1.44	void SetVertexName(const char* name) { fVertexName = name; }
83
84	loizides	1.6	enum EMuIdType {
85			kIdUndef = 0, //not defined
86	ceballos	1.26	kWMuId, //"WMuId"
87			kZMuId, //"ZMuId"
88	loizides	1.6	kTight, //"Tight"
89			kLoose, //"Loose"
90	ceballos	1.34	kWWMuIdV1, //"WWMuIdV1"
91			kWWMuIdV2, //"WWMuIdV2"
92	ceballos	1.37	kWWMuIdV3, //"WWMuIdV3"
93	ceballos	1.48	kWWMuIdV4, //"WWMuIdV4"
94	sixie	1.38	kNoId, //"NoId"
95			kCustomId, //"Custom"
96			kMVAID_BDTG_IDIso //"BDTG ID + Iso03, Iso04 Combined"
97	loizides	1.6	};
98			enum EMuIsoType {
99	sixie	1.35	kIsoUndef = 0, //"not defined"
100			kTrackCalo, //"TrackCalo"
101			kTrackCaloCombined, //"TrackCaloCombined"
102			kTrackCaloSliding, //"TrackCaloSliding"
103			kTrackCaloSlidingNoCorrection, //"TrackCaloSlidingNoCorrection"
104			kCombinedRelativeConeAreaCorrected, //"CombinedRelativeConeAreaCorrected"
105	sixie	1.40	kCombinedRelativeEffectiveAreaCorrected,
106	sixie	1.35	kCustomIso, //"Custom"
107			kPFIso, //"PFIso"
108	ceballos	1.42	kPFRadialIso, //"PFRadialIso"
109	sixie	1.38	kPFIsoEffectiveAreaCorrected, //"PFIso with EffectiveArea Pileup Correction"
110	sixie	1.35	kPFIsoNoL, //"PFIsoNoL"
111	sixie	1.38	kNoIso, //"NoIso"
112	ceballos	1.45	kMVAIso_BDTG_IDIso, //"BDTG ID + Iso03, Iso04 Combined"
113	ceballos	1.46	kIsoRingsV0_BDTG_Iso, //"BDTG Iso Rings"
114			kIsoDeltaR //"BGDT Iso dR"
115	loizides	1.6	};
116			enum EMuClassType {
117			kClassUndef = 0, //not defined
118			kAll, //"All"
119			kGlobal, //"Global"
120	ceballos	1.34	kGlobalTracker, //"GlobalTracker"
121	loizides	1.6	kSta, //"Standalone"
122	loizides	1.23	kTrackerMuon, //"TrackerMuon"
123			kCaloMuon, //"CaloMuon"
124			kTrackerBased //"TrackerMuon or CaloMuon"
125	sixie	1.38
126	loizides	1.6	};
127
128	loizides	1.1	protected:
129	loizides	1.11	void Process();
130			void SlaveBegin();
131	ceballos	1.46	void Terminate();
132	loizides	1.10
133	sixie	1.41	Bool_t fPrintMVADebugInfo; //print MVA debug information
134	loizides	1.11	TString fMuonBranchName; //name of muon collection (input)
135			TString fCleanMuonsName; //name of exported "good muon" collection
136	ceballos	1.29	TString fNonIsolatedMuonsName; //name of imported "old muon" collection
137			TString fNonIsolatedElectronsName;//name of imported "old electron" collection
138	ceballos	1.15	TString fVertexName; //name of vertex collection
139	ceballos	1.32	TString fBeamSpotName; //name of beamspot collection
140	ceballos	1.28	TString fTrackName; //name of track collection
141			TString fPFCandidatesName; //name of pfcandidates collection
142	loizides	1.11	TString fMuonIDType; //type of muon id scheme we impose
143			TString fMuonIsoType; //type of muon isolations scheme we impose
144			TString fMuonClassType; //type of muon class we impose
145			Double_t fTrackIsolationCut; //cut value for track isolation
146			Double_t fCaloIsolationCut; //cut value for calo isolation
147			Double_t fCombIsolationCut; //cut value for combined isolation
148	sixie	1.35	Double_t fCombRelativeIsolationCut; //cut value for combined relative isolation
149			Double_t fPFIsolationCut; //cut value for combined isolation
150	loizides	1.11	Double_t fMuonPtMin; //min muon pt
151	loizides	1.20	Bool_t fApplyD0Cut; //=true then apply d0 cut (def=1)
152	ceballos	1.32	Bool_t fApplyDZCut; //=true then apply dz cut (def=1)
153	loizides	1.16	Double_t fD0Cut; //max d0
154	ceballos	1.32	Double_t fDZCut; //max dz
155			Int_t fWhichVertex; //vertex to use (-2: beamspot, -1: closest in Z)
156	ceballos	1.25	Double_t fEtaCut; //max eta, absolute value
157	loizides	1.11	EMuIdType fMuIDType; //!muon id type (imposed)
158			EMuIsoType fMuIsoType; //!muon iso type (imposed)
159			EMuClassType fMuClassType; //!muon class type (imposed)
160	loizides	1.16	const MuonCol *fMuons; //!muon collection
161			const VertexCol *fVertices; //!vertices branch
162	ceballos	1.32	const BeamSpotCol *fBeamSpot; //!beamspot branch
163	ceballos	1.28	const TrackCol *fTracks; //!track branch
164			const PFCandidateCol *fPFCandidates; //!pfcandidate branch
165	ceballos	1.42	const PFCandidateCol *fPFNoPileUpCands; //!pfnpu collection
166	ceballos	1.36	Double_t fIntRadius; //!min IntRadius cut in pf isolation
167	ceballos	1.29	MuonCol *fNonIsolatedMuons; //!pointer to old muon collection
168			ElectronCol *fNonIsolatedElectrons;//!pointer to old electron collection
169	ceballos	1.31	TString fPileupEnergyDensityName;
170			const PileupEnergyDensityCol *fPileupEnergyDensity;
171	sixie	1.38	MuonTools *fMuonTools; // interface to tools for muon ID
172			MuonIDMVA *fMuonIDMVA; // helper class for MuonMVA
173	ceballos	1.28
174	fabstoec	1.43	RhoUtilities::RhoType fTheRhoType;
175
176	loizides	1.11	ClassDef(MuonIDMod, 1) // Muon identification module
177	loizides	1.1	};
178			}
179			#endif