Inheritance diagram for objects.VertexAnalyzer.VertexAnalyzer:

Public Member Functions
def	__init__ (self, cfg_ana, cfg_comp, looperName)

def	beginLoop (self, setup)

def	declareHandles (self)

def	mindist (self, vertices)

def	process (self, event)

def	testGoodVertex (self, vertex)

def	write (self, setup)

Public Attributes
	allVertices

	count

	doHists

	pileup

Static Public Attributes
	class_object

	fixedWeight

	verbose

	vertexWeight

Detailed Description

selects a list of good primary vertices,
and optionally add a pile-up weight to MC events.

The list of good primary vertices is put in event.goodVertices.
if no good vertex is found, the process function returns False.

The weight is put in event.vertexWeight, and is multiplied to
the global event weight, event.eventWeight. 

Example:

vertexAna = cfg.Analyzer(
  'VertexAnalyzer',
  goodVertices = 'goodPVFilter',
  vertexWeight = 'vertexWeightFall112011AB',
  # uncomment the following line if you want a vertex weight = 1 (no weighting)
  # fixedWeight = 1, 
  verbose = False
  )

If fixedWeight is set to None, the vertex weight is read from the EDM collection with module name
'vertexWeightFall112011AB'.
Otherwise, the weight is set to fixedWeight.

The vertex weight collection was at some point produced in the PAT+CMG step,
and could directly be accessed from the PAT or CMG tuple. 
In the most recent versions of the PAT+CMG tuple, this collection is not present anymore,
and an additional full framework process must be ran to produce this collection,
so that this analyzer can read it. An example cfg to do that can be found here:
http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/UserCode/CMG/CMGTools/H2TauTau/prod/vertexWeight2011_cfg.py?view=markup

Definition at line 11 of file VertexAnalyzer.py.

Constructor & Destructor Documentation

◆ init()

def objects.VertexAnalyzer.VertexAnalyzer.__init__	(	self,
		cfg_ana,
		cfg_comp,
		looperName
	)

Definition at line 46 of file VertexAnalyzer.py.

     def __init__(self, cfg_ana, cfg_comp, looperName):
         super(VertexAnalyzer, self).__init__(cfg_ana, cfg_comp, looperName)
  
         self.doHists=True
         if (hasattr(self.cfg_ana,'makeHists')) and (not self.cfg_ana.makeHists):
             self.doHists=False
         if self.doHists:    
             self.pileup = VertexHistograms('/'.join([self.dirName,
                                                      'pileup.root']))
         
         self.allVertices = self.cfg_ana.allVertices if (hasattr(self.cfg_ana,'allVertices')) else "_AUTO_"
  

Member Function Documentation

◆ beginLoop()

def objects.VertexAnalyzer.VertexAnalyzer.beginLoop	(	self,
		setup
	)

Definition at line 92 of file VertexAnalyzer.py.

     def beginLoop(self, setup):
         super(VertexAnalyzer,self).beginLoop(setup)
         self.averages.add('vertexWeight', Average('vertexWeight') )
         self.counters.addCounter('GoodVertex')
         self.count = self.counters.counter('GoodVertex')
         self.count.register('All Events')
         self.count.register('Events With Good Vertex')
  
         

References PVValHelper.add(), Average, analyzer.Analyzer.averages, CSCSPEvent.counters(), cms::cuda::AtomicPairCounter::Atomic2.counters, NMaxPerLumi.counters, analyzer.Analyzer.counters, HistogramManager.counters, counter.Counters.counters, and cscdqm::ChamberCounterKeyType.counters.

◆ declareHandles()

def objects.VertexAnalyzer.VertexAnalyzer.declareHandles ( self )

Definition at line 58 of file VertexAnalyzer.py.

     def declareHandles(self):
         super(VertexAnalyzer, self).declareHandles()
         if self.allVertices == '_AUTO_':
           self.handles['vertices'] =  AutoHandle( "offlineSlimmedPrimaryVertices", 'std::vector<reco::Vertex>', fallbackLabel="offlinePrimaryVertices" )
         else:
           self.handles['vertices'] =  AutoHandle( self.allVertices, 'std::vector<reco::Vertex>' )
         self.fixedWeight = None
         if self.cfg_comp.isMC:
             if hasattr( self.cfg_ana, 'fixedWeight'):
                 self.fixedWeight = self.cfg_ana.fixedWeight
             else:
                 self.mchandles['vertexWeight'] = AutoHandle( self.cfg_ana.vertexWeight,
                                                              'double' )
  
         self.mchandles['pusi'] =  AutoHandle(
             'slimmedAddPileupInfo',
             'std::vector<PileupSummaryInfo>', 
             fallbackLabel='addPileupInfo',
             )        
  
         self.handles['rho'] =  AutoHandle(
             ('fixedGridRhoFastjetAll',''),
             'double' 
             )        
         self.handles['rhoCN'] =  AutoHandle(
             ('fixedGridRhoFastjetCentralNeutral',''),
             'double' 
             )        
         self.handles['sigma'] =  AutoHandle(
             ('fixedGridSigmaFastjetAll',''),
             'double',
             mayFail=True
             )
  

References core.PileUpAnalyzer.PileUpAnalyzer.allVertices, objects.VertexAnalyzer.VertexAnalyzer.allVertices, analyzer.Analyzer.cfg_ana, analyzer.Analyzer.cfg_comp, looper.Looper.cfg_comp, objects.VertexAnalyzer.VertexAnalyzer.fixedWeight, core.AutoHandle.AutoHandle.handles, core.Analyzer.Analyzer.handles, HTTP.RequestManager.handles, and core.Analyzer.Analyzer.mchandles.

◆ mindist()

def objects.VertexAnalyzer.VertexAnalyzer.mindist	(	self,
		vertices
	)

Definition at line 160 of file VertexAnalyzer.py.

     def mindist(self, vertices):
         mindist = 999999
         for comb in itertools.combinations(vertices, 2):
             dist = abs(comb[0].z() - comb[1].z())
             if dist<mindist:
                 mindist = dist
         return mindist
                                                                  

References funct.abs().

◆ process()

def objects.VertexAnalyzer.VertexAnalyzer.process	(	self,
		event
	)

Definition at line 101 of file VertexAnalyzer.py.

     def process(self,  event):
         self.readCollections(event.input )
         event.rho = self.handles['rho'].product()[0]
         event.rhoCN = self.handles['rhoCN'].product()[0]
         event.sigma = self.handles['sigma'].product()[0] if self.handles['sigma'].isValid() else -999
         event.vertices = self.handles['vertices'].product()
         event.goodVertices = list(filter(self.testGoodVertex,event.vertices))
  
  
         self.count.inc('All Events')
  
         
         event.vertexWeight = 1
         if self.cfg_comp.isMC:
             event.pileUpInfo = map( PileUpSummaryInfo,
                                     self.mchandles['pusi'].product() )
             if self.fixedWeight is None:
                 event.vertexWeight = self.mchandles['vertexWeight'].product()[0]
             else:
                 event.vertexWeight = self.fixedWeight
         event.eventWeight *= event.vertexWeight
             
         self.averages['vertexWeight'].add( event.vertexWeight )
         if self.verbose:
             print('VertexAnalyzer: #vert = ', len(event.vertices), \
                   ', weight = ', event.vertexWeight)
  
         # Check if events needs to be skipped if no good vertex is found (useful for generator level studies)
         keepFailingEvents = False
         if hasattr( self.cfg_ana, 'keepFailingEvents'):
             keepFailingEvents = self.cfg_ana.keepFailingEvents
         if len(event.goodVertices)==0:
             event.passedVertexAnalyzer=False
             if not keepFailingEvents:
                 return False
         else:
             event.passedVertexAnalyzer=True
  
         if self.doHists:
             self.pileup.hist.Fill( len(event.goodVertices) )
 #A.R. mindist is one of the slowest functions, default commented
 #           self.pileup.mindist.Fill( self.mindist(event.goodVertices) )
  
         self.count.inc('Events With Good Vertex')
         return True
  
  

References PVValHelper.add(), analyzer.Analyzer.averages, analyzer.Analyzer.cfg_ana, analyzer.Analyzer.cfg_comp, looper.Looper.cfg_comp, TmCcu.count, TmModule.count, TmApvPair.count, AbstractHistogram.count, core.SkimAnalyzerCount.SkimAnalyzerCount.count, core.TriggerBitFilter.TriggerBitFilter.count, edm::BranchToCount.count, edm::ErrorSummaryEntry.count, edm::messagelogger::ErrorSummaryEntry.count, TmPsu.count, MatrixInjector.MatrixInjector.count, core.JSONAnalyzer.JSONAnalyzer.count, ValidationMisalignedTracker.count, SiStripDetSummary::Values.count, SiPixelDataQuality.count, SiPixelInformationExtractor.count, objects.VertexAnalyzer.VertexAnalyzer.count, edm::service::SimpleMemoryCheck::SignificantEvent.count, TriggerDiff.count, core.PileUpAnalyzer.PileUpAnalyzer.doHists, objects.VertexAnalyzer.VertexAnalyzer.doHists, ALCARECOTkAlBeamHalo_cff.filter, objects.VertexAnalyzer.VertexAnalyzer.fixedWeight, core.AutoHandle.AutoHandle.handles, core.Analyzer.Analyzer.handles, HTTP.RequestManager.handles, sistrip::SpyUtilities.isValid(), genParticles_cff.map, core.Analyzer.Analyzer.mchandles, objects.VertexAnalyzer.VertexAnalyzer.pileup, print(), core.Analyzer.Analyzer.readCollections(), objects.VertexAnalyzer.VertexAnalyzer.testGoodVertex(), core.SkimAnalyzerCount.SkimAnalyzerCount.verbose, VisualizationOptions.verbose, CSCTFanalyzer.verbose, L1TdeStage2EMTF.verbose, L1TStage2uGMTMuon.verbose, L1TStage2EMTF.verbose, heppy::Davismt2.verbose, L1TStage2uGMT.verbose, TritonService::FallbackOpts.verbose, DQMGenericTnPClient.verbose, dqmTnP::AbstractFitter.verbose, L1TStage2OMTF.verbose, confdbOfflineConverter.OfflineConverter.verbose, MuonMillepedeAlgorithm.verbose, DeviationsFromFileSensor2D.verbose, L1TStage2BMTF.verbose, L1TStage2MuonComp.verbose, core.TriggerMatchAnalyzer.TriggerMatchAnalyzer.verbose, L1TStage2RegionalMuonCandComp.verbose, L1TCaloLayer1.verbose, HIPAlignmentAlgorithm.verbose, L1TCaloLayer1RawToDigi.verbose, L1TCaloLayer1Validator.verbose, FFTJetLookupTableESProducer< CT >.verbose, FFTJetCorrectionESProducer< CT >.verbose, o2olib.O2OJobMgr.verbose, objects.VertexAnalyzer.VertexAnalyzer.verbose, L1TStage2uGTCaloLayer2Comp.verbose, OpticalObject.verbose, L1TdeStage2CaloLayer2.verbose, objects.LeptonAnalyzer.LeptonAnalyzer.verbose, and HltDiff.verbose.

◆ testGoodVertex()

def objects.VertexAnalyzer.VertexAnalyzer.testGoodVertex	(	self,
		vertex
	)

Definition at line 148 of file VertexAnalyzer.py.

     def testGoodVertex(self,vertex):
         if vertex.isFake():
             return False
         if vertex.ndof()<=4:
             return False
         if abs(vertex.z())>24:
             return False
         if vertex.position().Rho()>2:
             return False
      
         return True
  

References funct.abs().

Referenced by objects.VertexAnalyzer.VertexAnalyzer.process().

◆ write()

def objects.VertexAnalyzer.VertexAnalyzer.write	(	self,
		setup
	)

Definition at line 168 of file VertexAnalyzer.py.

     def write(self, setup):
         super(VertexAnalyzer, self).write(setup)
         if self.doHists:
             self.pileup.write()
  
 setattr(VertexAnalyzer,"defaultConfig",cfg.Analyzer(

References core.PileUpAnalyzer.PileUpAnalyzer.doHists, objects.VertexAnalyzer.VertexAnalyzer.doHists, and objects.VertexAnalyzer.VertexAnalyzer.pileup.

Member Data Documentation

◆ allVertices

objects.VertexAnalyzer.VertexAnalyzer.allVertices

Definition at line 56 of file VertexAnalyzer.py.

Referenced by objects.VertexAnalyzer.VertexAnalyzer.declareHandles().

◆ class_object

objects.VertexAnalyzer.VertexAnalyzer.class_object

static

Definition at line 174 of file VertexAnalyzer.py.

Referenced by config.Analyzer.build_name(), and config.Service.build_name().

◆ count

objects.VertexAnalyzer.VertexAnalyzer.count

Definition at line 96 of file VertexAnalyzer.py.

Referenced by objects.VertexAnalyzer.VertexAnalyzer.process().

◆ doHists

objects.VertexAnalyzer.VertexAnalyzer.doHists

Definition at line 49 of file VertexAnalyzer.py.

Referenced by objects.VertexAnalyzer.VertexAnalyzer.process(), and objects.VertexAnalyzer.VertexAnalyzer.write().

◆ fixedWeight

objects.VertexAnalyzer.VertexAnalyzer.fixedWeight

static

Definition at line 176 of file VertexAnalyzer.py.

Referenced by objects.VertexAnalyzer.VertexAnalyzer.declareHandles(), and objects.VertexAnalyzer.VertexAnalyzer.process().

◆ pileup

objects.VertexAnalyzer.VertexAnalyzer.pileup

Definition at line 53 of file VertexAnalyzer.py.

Referenced by objects.VertexAnalyzer.VertexAnalyzer.process(), and objects.VertexAnalyzer.VertexAnalyzer.write().

◆ verbose

objects.VertexAnalyzer.VertexAnalyzer.verbose

static

Definition at line 177 of file VertexAnalyzer.py.

Referenced by python.diff_provenance.difference.list_diff(), python.diffProv.difference.list_diff(), python.diff_provenance.difference.module_diff(), python.diffProv.difference.module_diff(), python.diff_provenance.difference.onefilemodules(), python.diffProv.difference.onefilemodules(), and objects.VertexAnalyzer.VertexAnalyzer.process().

◆ vertexWeight

objects.VertexAnalyzer.VertexAnalyzer.vertexWeight

static

Definition at line 175 of file VertexAnalyzer.py.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ beginLoop()

◆ declareHandles()

◆ mindist()

◆ process()

◆ testGoodVertex()

◆ write()

Member Data Documentation

◆ allVertices

◆ class_object

◆ count

◆ doHists

◆ fixedWeight

◆ pileup

◆ verbose

◆ vertexWeight

◆ init()