Inheritance diagram for analyzer.Analyzer:

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

def	__str__ (self)

def	beginLoop (self, setup)

def	endLoop (self, setup)

def	process (self, event)

def	write (self, setup)

Public Attributes
	averages

	beginLoopCalled

	cfg_ana

	cfg_comp

	class_object

	counters

	dirName

	instance_label

	looperName

	mainLogger

	name

	verbose

Detailed Description

Base Analyzer class. Used in Looper.

Your custom analyzers should inherit from this class

Definition at line 11 of file analyzer.py.

Constructor & Destructor Documentation

◆ init()

def analyzer.Analyzer.__init__	(	self,
		cfg_ana,
		cfg_comp,
		looperName
	)

Create an analyzer.

Parameters (also stored as attributes for later use):
cfg_ana: configuration parameters for this analyzer (e.g. a pt cut)
cfg_comp: configuration parameters for the data or MC component (e.g. DYJets)
looperName: name of the Looper which runs this analyzer.

Attributes:
dirName : analyzer directory, where you can write anything you want

Definition at line 17 of file analyzer.py.

     def __init__(self, cfg_ana, cfg_comp, looperName ):
         """Create an analyzer.
 
         Parameters (also stored as attributes for later use):
         cfg_ana: configuration parameters for this analyzer (e.g. a pt cut)
         cfg_comp: configuration parameters for the data or MC component (e.g. DYJets)
         looperName: name of the Looper which runs this analyzer.
 
         Attributes:
         dirName : analyzer directory, where you can write anything you want
         """
         self.class_object = cfg_ana.class_object
         self.instance_label = cfg_ana.instance_label
         self.name = cfg_ana.name
         self.verbose = cfg_ana.verbose
         self.cfg_ana = cfg_ana
         self.cfg_comp = cfg_comp
         self.looperName = looperName
         if hasattr(cfg_ana,"nosubdir") and cfg_ana.nosubdir:
             self.dirName = self.looperName
         else:
             self.dirName = '/'.join( [self.looperName, self.name] )
             os.mkdir( self.dirName )
 
 
         # this is the main logger corresponding to the looper.
         # each analyzer could also declare its own logger
         self.mainLogger = logging.getLogger( looperName )
         # print self.mainLogger.handlers
         self.beginLoopCalled = False
 

Member Function Documentation

◆ str()

def analyzer.Analyzer.__str__ ( self )

A multipurpose printout. Should do the job for most analyzers.

Definition at line 75 of file analyzer.py.

References analyzer.Analyzer.averages, analyzer.Analyzer.cfg_ana, cms::cuda::AtomicPairCounter::Atomic2.counters, NMaxPerLumi.counters, analyzer.Analyzer.counters, HistogramManager.counters, cscdqm::ChamberCounterKeyType.counters, join(), genParticles_cff.map, and str.

     def __str__(self):
         """A multipurpose printout. Should do the job for most analyzers."""
         ana = str( self.cfg_ana )
         count = ''
         ave = ''
         if hasattr(self, 'counters') and len( self.counters.counters ) > 0:
             count = '\n'.join(map(str, self.counters.counters))
         if hasattr(self, 'averages') and len( self.averages ) > 0:
             ave = '\n'.join(map(str, self.averages))
         return '\n'.join( [ana, count, ave] )

◆ beginLoop()

def analyzer.Analyzer.beginLoop	(	self,
		setup
	)

Automatically called by Looper, for all analyzers.

Definition at line 48 of file analyzer.py.

     def beginLoop(self, setup):
         """Automatically called by Looper, for all analyzers."""
         self.counters = Counters()
         self.averages = Averages()
         self.mainLogger.info( 'beginLoop ' + self.cfg_ana.name )
         self.beginLoopCalled = True
 

◆ endLoop()

def analyzer.Analyzer.endLoop	(	self,
		setup
	)

Automatically called by Looper, for all analyzers.

Definition at line 55 of file analyzer.py.

References info(), analyzer.Analyzer.mainLogger, and str.

     def endLoop(self, setup):
         """Automatically called by Looper, for all analyzers."""
         #print self.cfg_ana
         self.mainLogger.info( '' )
         self.mainLogger.info( str(self) )
         self.mainLogger.info( '' )
 

◆ process()

def analyzer.Analyzer.process	(	self,
		event
	)

Automatically called by Looper, for all analyzers.
each analyzer in the sequence will be passed the same event instance.
each analyzer can access, modify, and store event information, of any type.

Definition at line 62 of file analyzer.py.

References analyzer.Analyzer.cfg_ana, and print().

     def process(self, event ):
         """Automatically called by Looper, for all analyzers.
         each analyzer in the sequence will be passed the same event instance.
         each analyzer can access, modify, and store event information, of any type."""
         print(self.cfg_ana.name)
 
 

◆ write()

def analyzer.Analyzer.write	(	self,
		setup
	)

Called by Looper.write, for all analyzers.
Just overload it if you have histograms to write.

Definition at line 69 of file analyzer.py.

References analyzer.Analyzer.averages, cms::cuda::AtomicPairCounter::Atomic2.counters, NMaxPerLumi.counters, analyzer.Analyzer.counters, HistogramManager.counters, cscdqm::ChamberCounterKeyType.counters, analyzer.Analyzer.dirName, and MuonIsolationDQM.dirName.

     def write(self, setup):
         """Called by Looper.write, for all analyzers.
         Just overload it if you have histograms to write."""
         self.counters.write( self.dirName )
         self.averages.write( self.dirName )
 

Member Data Documentation

◆ averages

analyzer.Analyzer.averages

Definition at line 51 of file analyzer.py.

Referenced by analyzer.Analyzer.__str__(), objects.VertexAnalyzer.VertexAnalyzer.beginLoop(), core.PileUpAnalyzer.PileUpAnalyzer.beginLoop(), objects.VertexAnalyzer.VertexAnalyzer.process(), core.PileUpAnalyzer.PileUpAnalyzer.process(), and analyzer.Analyzer.write().

◆ beginLoopCalled

analyzer.Analyzer.beginLoopCalled

Definition at line 46 of file analyzer.py.

◆ cfg_ana

analyzer.Analyzer.cfg_ana

Definition at line 32 of file analyzer.py.

◆ cfg_comp

analyzer.Analyzer.cfg_comp

Definition at line 33 of file analyzer.py.

◆ class_object

analyzer.Analyzer.class_object

Definition at line 28 of file analyzer.py.

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

◆ counters

analyzer.Analyzer.counters

Definition at line 50 of file analyzer.py.

◆ dirName

analyzer.Analyzer.dirName

Definition at line 36 of file analyzer.py.

Referenced by addOnTests.testit.run(), analyzer.Analyzer.write(), and core.JSONAnalyzer.JSONAnalyzer.write().

◆ instance_label

analyzer.Analyzer.instance_label

Definition at line 29 of file analyzer.py.

Referenced by config.Analyzer.build_name(), config.Service.build_name(), Filter.Filter.process(), SimpleJetAnalyzer.SimpleJetAnalyzer.process(), and ResonanceBuilder.ResonanceBuilder.process().

◆ looperName

analyzer.Analyzer.looperName

Definition at line 34 of file analyzer.py.

◆ mainLogger

analyzer.Analyzer.mainLogger

Definition at line 44 of file analyzer.py.

Referenced by analyzer.Analyzer.endLoop().

◆ name

analyzer.Analyzer.name

Definition at line 30 of file analyzer.py.

Referenced by FWLite.ElectronMVAID.__call__(), dirstructure.Directory.__create_pie_image(), DisplayManager.DisplayManager.__del__(), dqm_interfaces.DirID.__eq__(), dirstructure.Directory.__get_full_path(), dirstructure.Comparison.__get_img_name(), dataset.Dataset.__getDataType(), dataset.Dataset.__getFileInfoList(), dirstructure.Comparison.__make_image(), dirstructure.Directory.__repr__(), dqm_interfaces.DirID.__repr__(), dirstructure.Comparison.__repr__(), config.Service.__setattr__(), config.CFG.__str__(), counter.Counter.__str__(), average.Average.__str__(), FWLite.WorkingPoints._reformat_cut_definitions(), dataset.CMSDataset.buildListOfFiles(), dataset.LocalDataset.buildListOfFiles(), dataset.CMSDataset.buildListOfFilesDBS(), dirstructure.Directory.calcStats(), validation.Sample.digest(), python.rootplot.utilities.Hist.divide(), python.rootplot.utilities.Hist.divide_wilson(), DisplayManager.DisplayManager.Draw(), utils.StatisticalTest.get_status(), production_tasks.Task.getname(), dataset.CMSDataset.getPrimaryDatasetEntries(), dataset.PrivateDataset.getPrimaryDatasetEntries(), VIDSelectorBase.VIDSelectorBase.initialize(), dirstructure.Directory.print_report(), dataset.BaseDataset.printInfo(), dataset.Dataset.printInfo(), production_tasks.MonitorJobs.run(), python.rootplot.utilities.Hist.TGraph(), python.rootplot.utilities.Hist.TH1F(), counter.Counter.write(), and average.Average.write().

◆ verbose

analyzer.Analyzer.verbose

Definition at line 31 of file analyzer.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(), and python.diffProv.difference.onefilemodules().

Public Member Functions

Public Attributes