config.Analyzer Class Reference

Inheritance diagram for config.Analyzer:

Public Member Functions
def	__init__ (self, class_object, instance_label=None, verbose=False, **kwargs)
def	__setattr__ (self, name, value)
def	build_name (self)
def	clone (self, **kwargs)
Public Member Functions inherited from config.CFG
def	__init__ (self, **kwargs)
def	__str__ (self)

Public Attributes
	class_object
	instance_label
	name
	verbose

Static Public Attributes
	num_instance

Detailed Description

Base analyzer configuration, see constructor

Definition at line 79 of file config.py.

Constructor & Destructor Documentation

__init__()

def config.Analyzer.__init__	(		self,
			class_object,
			instance_label = None,
			verbose = False,
		**	kwargs
	)

One could for example define the analyzer configuration for a
di-muon framework.Analyzer.Analyzer in the following way:

ZMuMuAna = cfg.Analyzer(
"ZMuMuAnalyzer",
pt1 = 20,
pt2 = 20,
iso1 = 0.1,
iso2 = 0.1,
eta1 = 2,
eta2 = 2,
m_min = 0,
m_max = 200
)

Any kinds of keyword arguments can be added.
The name must be present, and must be well chosen, as it will be used
by the Looper to find the module containing the Analyzer class.
This module should be in your PYTHONPATH. If not, modify your python path
accordingly in your script.

Definition at line 84 of file config.py.

    def __init__(self, class_object, instance_label=None, 
                 verbose=False, **kwargs):
        '''
        One could for example define the analyzer configuration for a
        di-muon framework.Analyzer.Analyzer in the following way:
 
        ZMuMuAna = cfg.Analyzer(
        "ZMuMuAnalyzer",
        pt1 = 20,
        pt2 = 20,
        iso1 = 0.1,
        iso2 = 0.1,
        eta1 = 2,
        eta2 = 2,
        m_min = 0,
        m_max = 200
        )
 
        Any kinds of keyword arguments can be added.
        The name must be present, and must be well chosen, as it will be used
        by the Looper to find the module containing the Analyzer class.
        This module should be in your PYTHONPATH. If not, modify your python path
        accordingly in your script.
        '''
 
        self.class_object = class_object
        self.__class__.num_instance += 1 
        if instance_label is None:
            instance_label = str(self.__class__.num_instance)
        self.instance_label = instance_label
        self.verbose = verbose
        super(Analyzer, self).__init__(**kwargs)
 

Member Function Documentation

__setattr__()

def config.Analyzer.__setattr__	(		self,
			name,
			value
	)

You may decide to copy an existing analyzer and change
its instance_label. In that case, one must stay consistent.

Definition at line 117 of file config.py.

    def __setattr__(self, name, value):
        '''You may decide to copy an existing analyzer and change
        its instance_label. In that case, one must stay consistent.'''
        self.__dict__[name] = value
        if name == 'instance_label':
            self.name = self.build_name()   
 

Referenced by GenObject.GenObject.setValue().

build_name()

def config.Analyzer.build_name

(

self

)

Definition at line 124 of file config.py.

    def build_name(self):
        class_name = '.'.join([self.class_object.__module__, 
                               self.class_object.__name__])
        name = '_'.join([class_name, self.instance_label])
        return name 
 

References analyzer.Analyzer.class_object, config.Analyzer.class_object, objects.TauAnalyzer.TauAnalyzer.class_object, core.PileUpAnalyzer.PileUpAnalyzer.class_object, objects.VertexAnalyzer.VertexAnalyzer.class_object, objects.PhotonAnalyzer.PhotonAnalyzer.class_object, objects.JetAnalyzer.JetAnalyzer.class_object, objects.LeptonAnalyzer.LeptonAnalyzer.class_object, analyzer.Analyzer.instance_label, config.Analyzer.instance_label, and join().

Referenced by config.Service.__setattr__().

clone()

def config.Analyzer.clone	(		self,
		**	kwargs
	)

Make a copy of this object, redefining (or adding) some parameters, just
   like in the CMSSW python configuration files. 

   For example, you can do
      module1 = cfg.Analyzer(SomeClass, 
          param1 = value1, 
          param2 = value2, 
          param3 = value3, 
          ...)
      module2 = module1.clone(
         param2 = othervalue,
         newparam = newvalue)
   and module2 will inherit the configuration of module2 except for
   the value of param2, and for having an extra newparam of value newvalue
   (the latter may be useful if e.g. newparam were optional, and needed
   only when param2 == othervalue)

   Note that, just like in CMSSW, this is a shallow copy and not a deep copy,
   i.e. if in the example above value1 were to be an object, them module1 and
   module2 will share the same instance of value1, and not have two copies.

Reimplemented from config.CFG.

Definition at line 130 of file config.py.

    def clone(self, **kwargs):
        other = super(Analyzer, self).clone(**kwargs)
        if 'class_object' in kwargs and 'name' not in kwargs:
            other.name = other.build_name()
        return other
 

Member Data Documentation

class_object

config.Analyzer.class_object

Definition at line 108 of file config.py.

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

instance_label

config.Analyzer.instance_label

Definition at line 112 of file config.py.

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

name

config.Analyzer.name

Definition at line 122 of file config.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().

num_instance

config.Analyzer.num_instance

static

Definition at line 82 of file config.py.

verbose

config.Analyzer.verbose

Definition at line 113 of file config.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().