PAT Tools

Complete:

Introduction

The Physics Analysis Toolkit ( PAT) provides the user with a large pool of configuration tools to tailor the object and event content as well as the workflow to a corresponding analysis. You can find these tools in the python/tools directory of the CMS.PhysicsTools/PatAlgos package. A description of the most important configuration tools is given below.

The PAT tools are organised in the following categories represented by the files located in the python/tools directory of the PatAlgos package:

• coreTools.py: tools for the configuration of the common workflow of PAT.
• cmsswVersionTools.py: tools for CMSSW version dependent configurations.
• pfTools.py: tools for the configuration of particle flow for PAT.
• trigTools.py: tools for the configuration of the pat::Trigger objects and the pat::TriggerEvent.
• trackTools.py: tools for the configuration and production of a pat::TrackCandidate collection.
• jetTools.py: tools for the configuration of the pat::Jet collection(s).
• metTools.py: tools for the configuration of the pat::MET collection(s).
• metUncertaintyTools.py: tool for varying particle energies by energy scale uncertainties and propagating differences to missing Et.
• tauTools.py: tools for the configuration of the pat::Tau collection(s).
• muonTools.py: tools for the configuration of the pat::Muon content.
• electronTools.py: tools for the configuration of the pat::Electron content.
• photonTools.py: tools for the configuration of the pat::Photon content.

Core Tools

runOnData( process, names, postfix, outputModules)

Description:

Tool to configure the PAT to run on real data. This tool removes the MC matching (s. below) and adapts the jet energy corrections. You can apply the tool to a single collection (specifying its name), a vector of collections or all collections (when specifying ['All']). Capital letters must be obeyed.

Arguments:

supported names:

• Photons
• Electrons
• Muons
• Taus
• Jets
• METs
• All

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.coreTools import runOnData
runOnData(process)

Implementation Details:

You can find the implementation of this function at coreTools.py.

removeMCMatching( process, names, postfix, outputModules)

Description:

Tool to remove the MC matching from the pat::Candidates. Use this tool to produce pat::Candidates from data or from events without generator level information. You can apply the tool to a single collection (specifying its name), a vector of collections or all collections (when specifying ['All']). Capital letters must be obeyed.

Arguments:

supported names:

• Photons
• Electrons
• Muons
• Taus
• Jets
• METs
• All

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.coreTools import removeMCMatching
removeMCMatching(process, ['All'])

Implementation Details:

You can find the implementation of this function at coreTools.py.

CMSSW Version Tools

pickRelValInputFiles( process, cmsswVersion, relVal, dataTier, condition, globalTag, maxVersions, skipFiles, numberOfFiles, debug )

Description:

Tool to pick up CMS.RelVal input files automatically and return them in a vector of strings with the paths to be used in the fileNames parameter of a PoolSource module.

Note: Of course, one needs to wait for the according CMS.RelVal samples to be produced. They are announced in the RelVal Samples and Release Testing HN
This does not not work for patch releases, since no CMS.RelVal samples are produced for them.

Arguments:

Argument	Default Value	Meaning
cmsswVersion	the current release (determined automatically from environment)	CMSSW release to pick up the CMS.RelVal files from
formerVersion	False	set to True in order to use the last before the last valid CMSSW release to pick up the CMS.RelVal files from applies also, if cmsswVersion is set explicitly
relVal	'RelValTTbar'	RelVal sample to be used
dataTier	'GEN-SIM-RECO'	data tier to be used
condition	'startup'	identifier of GlobalTag as defined in Configurations/PyReleaseValidation/python/autoCond.py
globalTag	determined automatically as defined by condition in Configurations/PyReleaseValidation/python/autoCond.py	name of corresponding directory to find the CMS.RelVal files in; automatic determination done for the run release, not the production release of the files; convention of using the "pure" global tag's name is sometimes broken
maxVersions	9	max. versioning number of CMS.RelVal to check
skipFiles	0	number of files to skip for a found CMS.RelVal sample
numberOfFiles	1	number of files to pick up, setting it to 0, returns all found ( skipFiles remains active though)
debug	False	set to True in order to enable enhanced messages in stdout

In general, the tool's arguments should reflect the directories on CASTOR, where the RelVal files ar found in the following way:
castor/cern.ch/cms/store/relval/[cmsswVersion]/[relVal]/[dataTier]/[globalTag]-v[≤maxVersions]/*/

Example:

Show Hide

import FWCore.ParameterSet.Config as cms

process = cms.Process( "HLTPROV" )

# Conditions condition = 'startup' process.load("Configuration.StandardSequences.FrontierConditions_CMS.GlobalTag_cff") from Configuration.PyReleaseValidation.autoCond import autoCond process.GlobalTag.globaltag = cms.string( autoCond[ condition ] )

# Source from PhysicsTools.PatAlgos.tools.cmsswVersionTools import pickRelValInputFiles process.source = cms.Source("PoolSource", fileNames = cms.untracked.vstring( pickRelValInputFiles() ) ) process.maxEvents = cms.untracked.PSet( input = cms.untracked.int32( 1 ) )

# HLT analyzers process.load( "HLTrigger.HLTcore.hltEventAnalyzerAOD_cfi" ) process.hltEventAnalyzerAOD.triggerName = cms.string( '@' ) process.load( "HLTrigger.HLTcore.triggerSummaryAnalyzerAOD_cfi" )

process.p = cms.Path( process.hltEventAnalyzerAOD + process.triggerSummaryAnalyzerAOD )

Implementation Details:

You can find the implementation of this function at cmsswVersionTools.py.

PF Tools

addPFCandidates( process, src, patLabel, cut)

Description:

Tool to add particle flow candidates to the event content. A patPFCandidate collection, a selectedPatPFCandidate collection, a cleanPatPFCandidate collection and a corresponding count filter will be added to the patDefaultSequence and event content.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.pfTools import *
addPFCandidates(process, allHadronicPfCandidates)

Implementation Details:

You can find the implementation of this function at pfTools.py.

switchToPFMET( process, input)

Description:

Tool to switch the input of the pat::MET collection from calo MET to particle flow MET. Type1MET and MuonMET corrections are removed from the patDefaultSequence.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("CMS.PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.pfTools import *
switchToPFMET(process, input=cms.InputTag('pfMet'))

Implementation Details:

You can find the implementation of this function at pfTools.py.

def usePF2PAT(process, runPF2PAT=True, jetAlgo='AK5', runOnMC=True, postfix="", jetCorrections=('AK5PFchs', ['L1FastJet','L2Relative','L3Absolute']), pvCollection=cms.InputTag('offlinePrimaryVertices'), typeIMetCorrections=False, outputModules=['out']):

usePF2PAT( process, runPF2PAT, jetAlgo, runOnMC, postfix, jetCorrections, pvCollection, typeIMetCorrections, outputModules)

Description:

Tool to switch the input of the all pat::Candidate collections from normal reco objects to particle flow objects. If 'runPF2PAT' is true, PF2PAT will be added in front of the patDefaultSequence.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.pfTools import *
usePF2PAT(process)

Implementation Details:

You can find the implementation of this function at pfTools.py.

Trigger Tools

This documentation refers to the !"PAT versions V08-10-34-05 (61X) and V08-11-07 (62X) (and later). Older tags are documented in this version of this TWiki!

These tools are also explained in more detail in the PAT Trigger SWGuide.

switchOnTrigger( process, ...)

Description:

Tool to switch on PAT trigger information and to add the needed modules to the CMSSW job.

Arguments:

Argument	Default Value	Meaning
process	mandatory	the current cms.Process
triggerProducer	'patTrigger'	label of the PATTriggerProducer module
triggerEventProducer	'patTriggerEvent'	label of the PATTriggerEventProducer module
path	''	name of the cms.Path to append the modules to should only be used, if really needed
hltProcess	'HLT'	name of the cms.Process, where the HLT was run wild-card '*' will automaticall pick the most recent one.
outputModule	'out'	label of the PoolOutputModule, '' (emty string) indicates no output

Example:

Show Hide

# load the PAT trigger Python tools from PhysicsTools.PatAlgos.tools.trigTools import * # switch on the trigger information switchOnTrigger( process )

Implementation Details:

You can find the implementation of these functions at trigTools.py. ---

switchOnTriggerStandAlone( process, ...)

Description:

Tool to switch on PAT trigger information in stand-alone mode (without pat::TriggerEvent) and to add the needed modules to the CMSSW job.

Arguments:

Argument	Default Value	Meaning
process	mandatory	the current cms.Process
triggerProducer	'patTrigger'	label of the PATTriggerProducer module
path	''	name of the cms.Path to append the modules to should only be used, if really needed
hltProcess	'HLT'	name of the cms.Process, where the HLT was run wild-card '*' will automaticall pick the most recent one.
outputModule	'out'	label of the PoolOutputModule, '' (emty string) indicates no output

Example:

Show Hide

# load the PAT trigger Python tools from PhysicsTools.PatAlgos.tools.trigTools import * # switch on the stand-alone trigger information without saving the output switchOnTriggerStandAlone( process, None, '', None, '' )

Implementation Details:

You can find the implementation of these functions at trigTools.py. ---

switchOnTriggerMatching( process, ...)

Description:

Tool to switch on PAT trigger matching information and to add the needed modules to the CMSSW job.
switchOnTrigger(...) is called automatically, if needed.

Arguments:

Argument	Default Value	Meaning
process	mandatory	the current cms.Process
triggerMatchers	default list of pre-defined trigger matches in this file	list of lables of PATTriggerMatcher modules
triggerProducer	'patTrigger'	label of the PATTriggerProducer module
triggerEventProducer	'patTriggerEvent'	label of the PATTriggerEventProducer module
path	''	name of the cms.Path to append the modules to should only be used, if really needed
hltProcess	'HLT'	name of the cms.Process, where the HLT was run wild-card '*' will automaticall pick the most recent one.
outputModule	'out'	label of the PoolOutputModule, '' (emty string) indicates no output

Example:

Show Hide

# define a trigger matcher from PhysicsTools.PatAlgos.triggerLayer1.triggerMatcherExamples_cfi import somePatMuonTriggerMatchHLTMu17 process.myMatcher = somePatMuonTriggerMatchHLTMu17.clone() # load the PAT trigger Python tools from PhysicsTools.PatAlgos.tools.trigTools import * # switch on the trigger matching switchOnTriggerMatching( process, [ myMatcher ] )

Implementation Details:

You can find the implementation of these functions at trigTools.py. ---

switchOnTriggerMatchingStandAlone( process, ...)

Description:

Tool to switch on PAT trigger matching information in stand-alone mode (with a pat::TriggerEvent) and to add the needed modules to the CMSSW job.
switchOnTriggerStandAlone(...) is called automatically, if needed.

Arguments:

Argument	Default Value	Meaning
process	mandatory	the current cms.Process
triggerMatchers	default list of pre-defined trigger matches in this file	list of lables of PATTriggerMatcher modules
triggerProducer	'patTrigger'	label of the PATTriggerProducer module
path	''	name of the cms.Path to append the modules to should only be used, if really needed
hltProcess	'HLT'	name of the cms.Process, where the HLT was run wild-card '*' will automaticall pick the most recent one.
outputModule	'out'	label of the PoolOutputModule, '' (emty string) indicates no output

Example:

Show Hide

# define a trigger matcher from PhysicsTools.PatAlgos.triggerLayer1.triggerMatcherExamples_cfi import somePatMuonTriggerMatchHLTMu17 process.myMatcher = somePatMuonTriggerMatchHLTMu17.clone() # load the PAT trigger Python tools from PhysicsTools.PatAlgos.tools.trigTools import * # switch on the stand-alone trigger matching without saving the output switchOnTriggerMatching( process, [ myMatcher ], None, None, '' )

Implementation Details:

You can find the implementation of these functions at trigTools.py. ---

switchOnTriggerMatchEmbedding( process, ...)

Description:

Tool to switch on PAT trigger match embedding and to add the needed modules to the CMSSW job.
switchOnTriggerMatchingStandAlone(...) is called automatically, if needed.

Note: This tool currently works only, if the producer for the input PAT objects is run in the same CMSSW job.
Former naming restrictions for these producers are resolved.

Arguments:

Argument	Default Value	Meaning
process	mandatory	the current cms.Process
triggerMatchers	default list of pre-defined trigger matches in this file	list of lables of PATTriggerMatcher modules
triggerProducer	'patTrigger'	label of the PATTriggerProducer module
path	''	name of the cms.Path to append the modules to should only be used, if really needed
hltProcess	'HLT'	name of the cms.Process, where the HLT was run wild-card '*' will automaticall pick the most recent one.
outputModule	'out'	label of the PoolOutputModule, '' (emty string) indicates no output

Example:

Show Hide

# define a trigger matcher from PhysicsTools.PatAlgos.triggerLayer1.triggerMatcherExamples_cfi import somePatMuonTriggerMatchHLTMu17 process.myMatcher = somePatMuonTriggerMatchHLTMu17.clone() # load the PAT trigger Python tools from PhysicsTools.PatAlgos.tools.trigTools import * # switch on the trigger match embedding switchOnTriggerMatchEmbedding( process, [ myMatcher ] )

Implementation Details:

You can find the implementation of these functions at trigTools.py. ---

Track Tools

makeTrackCandidates( process, label, tracks, particleType, preselection, selection, isolation, isoDeposits, mcAs)

Description:

Tool add a pat::TrackCandidate collection to the event content of PAT (including isolation information, isoDeposits and generatorMatch information) to the patDefaultSequence. It also includes a refernce to the original reco::Track collection. This is not one of the PAT default collections, therefore it is left to the user to add it to the event content or not.

Arguments:

default values (and supported types) of isolation:

• 'tracker':03
• 'ecalTowers':03
• 'hcalTowers':03

• 'tracker'
• 'ecalTowers'
• 'hcalTowers'

• tau
• jet
• met
• None

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.trackTools import *
makeTrackCandidates(process,
    label        = 'TrackCands',                  
    tracks       = 'generalTracks', 
    particleType = 'pi+',                         
    preselection = 'pt > 10',                     
    selection    = 'pt > 10',                     
    isolation    = {'tracker':0.3, 'ecalTowers':0.4, 'hcalTowers':0.4},                            
    isoDeposits  = [],                            
    mcAs         = 'muon'           
)      

Implementation Details:

You can find the implementation of these functions at trackTools.py.

Jet Tools

switchJetCollection( process, jetCollection, doJTA, doBTagging, jetCorrLabel, doType1MET, genJetCollection, doJetId, jetIdLabel, outputModules)

Description:

Tool to switch the default jet collection to any other jet collection which is available in the RECO (AOD) event content. Note NOT to use the addJetCollection tool after having used this tool, as this will lead to undefined states for the added jet collection tool. If you intend to add a jet collection and to switch the default jet collection in the same cfg file make sure to use the addJetCollection tool before using the switchJetCollection tool.

Note: to assign jet corrections (argument jetCorrLabel) of the switched jet collections we follow the conventions used for the jet energy corrections as described on the WorkBookJetAnalysis#JetCorApplication. For your convenience they are listed below. In order NOT to apply any jet energy scale correction just issue the corresponding 'None' for this parameter. When there is no jetCorrLabel specified the doType1MET switch will have no effect.

Arguments:

Note:
For the parameter jetCorrLabel the first argument corresponds to the payload for the given jet collection. It should be composed of the jet algorithm in capital letter acronyms and a postfix according to the constituents (e.g. AK5Calo). The second argument should be a vector of strings indicating the JEC levels the should be saved in the jet (e.g. ['L2Relative', 'L3Absolute',]). The following JEC levels may be used in the second argument:

For CMSSW_7_1_0:

Note:
For the parameter jetCorections the first argument corresponds to the payload in the CMS Conditions database for the given jet collection; the second argument corresponds to the jet energy correction level that you want to be embedded into your new patJet collection. This should be given as a list of strings. Available values are L1Offset, L1FastJet, L1JPTOffset, L2Relative, L3Absolute, L5Falvour, L7Parton; the third argument indicates whether MET(Type1) corrections should be applied corresponding to the new patJetCollection. If so a new patMet collection will be added to your PAT Tuple in addition to the raw patMet with the MET(Type1) corrections applied. The argument corresponds to the patMet collection to which the MET(Type1) corrections should be applied. If you are not interested in MET(Type1) corrections to this new patJet collection pass None as third argument of the python tuple.

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.jetTools import *
switchJetCollection(process, 
                    cms.InputTag('ak5PFJets'),   
                    doJTA            = True,            
                    doBTagging       = True,            
                    jetCorrLabel     = ('AK5PF', ['L2Relative', 'L3Absolute']),  
                    doType1MET       = False,            
                    genJetCollection = cms.InputTag("ak5GenJets"),
                    doJetID      = False,
                    jetIdLabel   = "ak5"
                    btagInfo = ['impactParameterTagInfos','secondaryVertexTagInfos']
                    btagdiscriminators=['simpleSecondaryVertexHighEffBJetTags','simpleSecondaryVertexHighPurBJetTags']
                    ) 

Implementation Details:

You can find the implementation of this function at jetTools.py.

addJetCollection( process, jetCollection, algoLabel, typeLabel, doJTA, doBTagging, jetCorrLabel, doType1MET, doL1Cleaning, doL1Counters, genJetCollection, doJetId, jetIdLabel, standardAlgo, standardType, outputModules)

Description:

Tool to add any other jet collection which is available in the RECO (AOD) event content. Note NOT to use this tool after having the switchJetCollection tool already applied, as this will lead to undefined states for the added jet collection. If you intend to add a jet collection and to switch the default jet collection in the same cfg file make sure to use the addJetCollection tool before using the switchJetCollection tool.

Note: both to assign jet corrections (argument jetCorrLabel) as well as for the postfix label (arguments algoLabel and typeLabel) of the added jet collection we follow the conventions used for the jet energy corrections as described on the WorkBookJetAnalysis#JetCorApplication. For your convenience they are listed below. For your convenience they are listed below. In order NOT to apply any jet energy scale correction just issue the corresponding 'None' for this parameter. When there is no jetCorrLabel specified the doType1MET switch will have no effect.

Arguments:

Note:
For the parameter jetCorrLabel the first argument corresponds to the payload for the given jet collection. It should be composed of the jet algorithm in capital letter acronyms and a postfix according to the constituents (e.g. AK5Calo). The second argument should be a vector of strings indicating the JEC levels the should be saved in the jet (e.g. ['L2Relative', 'L3Absolute',]). The following JEC levels may be used in the second argument:

For CMSSW_7_1_0:

Note:
For the parameter jetCorections the first argument corresponds to the payload in the CMS Conditions database for the given jet collection; the second argument corresponds to the jet energy correction levels that you want to be embedded into your new patJet collection. This should be given as a list of strings. Available values are L1Offset, L1FastJet, L1JPTOffset, L2Relative, L3Absolute, L5Falvour, L7Parton; the third argument indicates whether MET(Type1/2) corrections should be applied corresponding to the new patJetCollection. If so a new patMet collection will be added to your PAT Tuple in addition to the raw patMet. This new patMet collection will have the MET(Type1/2) corrections applied. The argument can have the following types: \'type-1\' for type-1 corrected MET; \'type-2\' for type-1 plus type-2 corrected MET; \'\' or \'none\' if no further MET corrections should be applied to your MET. The arguments \'type-1\' and \'type-2\' are not case sensitive.

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.jetTools import *
addJetCollection(process,cms.InputTag('sisCone5CMS.CaloJets'),
                 'SC5', 'Calo',
                 doJTA        = True,
                 doBTagging   = True,
                 jetCorrLabel = ('SC5Calo', ['L2Relative', 'L3Absolute']),
                 doType1MET   = True,
                 doL1Cleaning = True,                 
                 doL1Counters = False,
                 genJetCollection=cms.InputTag("sisCone5GenJets"),
                 doJetID      = True,
                 jetIdLabel   = "ak5"
                 btagInfo = ['impactParameterTagInfos','secondaryVertexTagInfos']
                 btagdiscriminators=['simpleSecondaryVertexHighEffBJetTags','simpleSecondaryVertexHighPurBJetTags']
                 )

Implementation Details:

You can find the implementation of this function at jetTools.py.

switchJetCorrLevels( process, jetCorrLabel, postfix)

Description:

Tool to switch the jet energy correction levels of a given jet collection. The tool detects whether L1Offset of L1FastJet corrections are to be applied and adapts the event content accordingly. This tool is also called within the tools switchJetCollection and addJetCollection as descripbed above.

Note: as the tool is already called in switchJetCollection_ and addJetCollection there is no need to apply the tool to jet collections created by these tools. You only need to run it yourself if you only want to change the JEC levels for the default jet correction not using the switchJetCollection tool.

Note: to assign jet corrections (argument jetCorrLabel) we follow the conventions used for the jet energy corrections as described on the WorkBookJetAnalysis#JetCorApplication. For your convenience they are listed below. In order NOT to apply any jet energy scale correction just issue the corresponding 'None' for this parameter.

Arguments:

Note:
For the parameter jetCorrLabel the first argument corresponds to the payload for the given jet collection. It should be composed of the jet algorithm in capital letter acronyms and a postfix according to the constituents (e.g. AK5Calo). The second argument should be a vector of strings indicating the JEC levels the should be saved in the jet (e.g. ['L2Relative', 'L3Absolute',]). The following JEC levels may be used in the second argument:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.jetTools import *
switchJetCorrLabel(process, 
                    jetCorrLabel     = ('AK5PF', ['L2Relative', 'L3Absolute']),  
                    ) 

Implementation Details:

You can find the implementation of this function at jetTools.py.

MET Tools

addTcMET( process, postfixLabel)

Description:

Tool to add track-corrected MET (tcMET) to the PAT event content and the patDefaultSequence.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.metTools import *
addTcMET(process, 'TC')

Implementation Details:

You can find the implementation of these functions at metTools.py.

addPfMET( process, postfixLabel)

Description:

Tool to add particle flow MET to the PAT event content and the patDefaultSequence.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.metTools import *
addPfMET(process, 'PF')

Implementation Details:

You can find the implementation of these functions at metTools.py.

MET Systematics Tools

runMETCorrectionsAndUncertainties(process, metType, correctionLevel, computeUncertainties, produceIntermediateCorrections, addToPatDefaultSequence, jetCollection, electronCollection, muonCollection, tauCollection, reclusterJets, pfCandCollection, autoJetCleaning, onMiniAOD, runOnData, postfix)

Description:

New version of the tool! can be retrieved from the cms-met private recipe for 74X, included per default for the most recent releases (75X+). Some of the options are currently under PR review for 75X+.

Show Hide

runMEtUncertainties( process, electronCollection, photonCollection, muonCollection, tauCollection, jetCollection, jetCorrLabel, dRjetCleaning, doSmearJets, jetSmearFileName, jetSmearHistogram, pfCandCollection, jetCorrPayloadName, varyByNsigmas)

Description:

Valid from 53X to 74X default release!
Tool to produce collections of electrons, photons, muons, tau-jets and jets shifted up and down by their respective energy uncertainties. Energy scale uncertainties are assummed to be uncorrelated for particles of different types. The uncertainties are propagated to the missing Et. "Unclustered energy" (jets of Pt < 10 GeV plus PFCandidates not within jets) are varied by +/- 10% and the uncertainty is propagated to the missing Et too.

Show Hide

process.type0PFMEtCorrection process.patPFMETtype0Corr 

Output collections:

Show Hide

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# switch pat::Jets to use ak5PFJets as input
from PhysicsTools.PatAlgos.tools.jetTools import *
switchJetCollection(
    process,
    cms.InputTag('ak5PFJets'),
    doJTA = True,
    doBTagging = False,
    jetCorrLabel = ( 'AK5PF', cms.vstring([ 'L1FastJet', 'L2Relative', 'L3Absolute' ]) ),
    doType1MET = False,
    doJetID = True,
    jetIdLabel = "ak5",
    outputModule = ''
)

# apply type I/type I + II PFMEt corrections to pat::MET object 
# and estimate systematic uncertainties on MET
from PhysicsTools.PatUtils.tools.metUncertaintyTools import runMEtUncertainties
runMEtUncertainties(process)

Implementation Details:

You can find the implementation of these functions at metUncertaintyTools.py.

Tau Tools

switchToCaloTau( process, pfTauLabel, caloTauLabel)

Description:

Tool to switch from particle flow taus to calo taus as input to the production of the pat::Tau collection.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.tauTools import *
switchToCaloTau(process)

Implementation Details:

You can find the implementation of these functions at tauTools.py.

switchToPFTauFixedCone( process, pfTauLabelOld, pfTauLabelNew)

Description:

Tool to switch from the standard particle flow taus to the fixed cone particle flow taus as input to the production of the pat::Tau collection.

Note: equivalent tools exist for switchToPFTauFixedConeHighEff and switchToPFTauShrinkingCone.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.tauTools import *
switchToPFTauFixedCone(process)

Implementation Details:

You can find the implementation of these functions at tauTools.py.

addTauCollection( process, tauCollection, algoLabel, typeLabel, doPFIsoDeposits)

Description:

Tool to add any other collection of taus which is available in the RECO (AOD) event content. Note NOT to use this tool after having the switchTauCollection tool already applied, as this will lead to undefined states for the added tau collection. If you intend to add a tau collection and to switch the default tau collection in the same cfg file make sure to use the addTauCollection tool before using the switchTauCollection tool.

Arguments:

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.tauTools import *
addTauCollection(process, tauCollection = cms.InputTag('caloRecoTauProducer'), algoLabel = "caloReco", typeLabel = "Tau")
addTauCollection(process, tauCollection = cms.InputTag('fixedConePFTauProducer'), algoLabel = "fixedCone", typeLabel = "PFTau")

Implementation Details:

You can find the implementation of these functions at tauTools.py.

Muon Tools

addMuonUserIsolation( process, isolationTypes)

Description:

Tool to add predefined types of userIsolation to the pat::Muon candidate. Have a look to WorkBookPATDataFormats#pat_Lepton to find out how to read out this user-defined isolation from the pat::Muon.

Arguments:

supported values of isolationTypes:

• Tracker
• Ecal
• Hcal
• All

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.muonTools import *
addMuonUserIsolation(process)

Implementation Details:

You can find the implementation of these functions at muonTools.py.

Electron Tools

addElectronUserIsolation( process, isolationTypes)

Description:

Tool to add predefined types of userIsolation to the pat::Electron candidate. Have a look to WorkBookPATDataFormats#pat_Lepton to find out how to read out this user-defined isolation from the pat::Electron.

Arguments:

supported values of isolationTypes:

• Tracker
• Ecal
• Hcal
• All

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.electronTools import *
addElectronUserIsolation(process)

Implementation Details:

You can find the implementation of these functions at electronTools.py.

Photon Tools

addPhotonUserIsolation( process, isolationTypes)

Description:

Tool to add predefined types of userIsolation to the pat::Photon candidate. Have a look to WorkBookPATDataFormats#pat_Photon to find out how to read out this user-defined isolation from the pat::Photon.

Arguments:

supported values of isolationTypes:

• Tracker
• Ecal
• Hcal
• All

Example:

Show Hide

# load the standard PAT config
process.load("PhysicsTools.PatAlgos.patSequences_cff")

# load the coreTools of PAT
from PhysicsTools.PatAlgos.tools.photonTools import *
addPhotonUserIsolation(process)

Implementation Details:

You can find the implementation of these functions at photonTools.py.

Review status

Responsible: RogerWolf
Last reviewed by: RogerWolf - 02 Mar 2010