test
CMS 3D CMS Logo
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Classes | Functions
helpers Namespace Reference

Classes

class  CloneSequenceVisitor
 
struct  CompositeCandidateMaker
 
struct  CompositePtrCandidateMaker
 
class  GatherAllModulesVisitor
 
class  MassSearchParamVisitor
 
class  MassSearchReplaceAnyInputTagVisitor
 
class  MassSearchReplaceParamVisitor
 
struct  MCTruthPairSelector
 
struct  NamedCompositeCandidateMaker
 
class  TestModuleCommand
 

Functions

def __labelsInSequence
 
def addESProducers
 Helpers to perform some technically boring tasks like looking for all modules with a given parameter and replacing that to a given value. More...
 
def applyPostfix
 
def cloneProcessingSnippet
 
def contains
 
def extendWithPostfix
 
def get_path
 
def get_vars
 
def jetCollectionString
 
def listModules
 
def listSequences
 
def loadWithPostfix
 
def massSearchReplaceAnyInputTag
 
def massSearchReplaceParam
 
def removeIfInSequence
 

Function Documentation

def helpers.__labelsInSequence (   process,
  sequenceLabel,
  postfix = "" 
)
private

Definition at line 85 of file helpers.py.

References listModules(), and listSequences().

Referenced by removeIfInSequence().

85 
86 def __labelsInSequence(process, sequenceLabel, postfix=""):
87  result = [ m.label()[:-len(postfix)] for m in listModules( getattr(process,sequenceLabel+postfix))]
88  result.extend([ m.label()[:-len(postfix)] for m in listSequences( getattr(process,sequenceLabel+postfix))] )
89  if postfix == "":
90  result = [ m.label() for m in listModules( getattr(process,sequenceLabel+postfix))]
91  result.extend([ m.label() for m in listSequences( getattr(process,sequenceLabel+postfix))] )
92  return result
helpers.listModules
def listModules
Definition: helpers.py:255
helpers.listSequences
def listSequences
Definition: helpers.py:260
helpers.__labelsInSequence
def __labelsInSequence
Definition: helpers.py:85
def helpers.addESProducers (   process,
  config 
)

Helpers to perform some technically boring tasks like looking for all modules with a given parameter and replacing that to a given value.

Definition at line 7 of file helpers.py.

References dir.

7 
8 def addESProducers(process,config):
9  config = config.replace("/",".")
10  #import RecoBTag.Configuration.RecoBTag_cff as btag
11  #print btag
12  module = __import__(config)
13  for name in dir(sys.modules[config]):
14  item = getattr(sys.modules[config],name)
15  if isinstance(item,cms._Labelable) and not isinstance(item,cms._ModuleSequenceType) and not name.startswith('_') and not (name == "source" or name == "looper" or name == "subProcess") and not type(item) is cms.PSet:
16  if 'ESProducer' in item.type_():
17  setattr(process,name,item)
helpers.addESProducers
def addESProducers
Helpers to perform some technically boring tasks like looking for all modules with a given parameter ...
Definition: helpers.py:7
dir
dbl *** dir
Definition: mlp_gen.cc:35
def helpers.applyPostfix (   process,
  label,
  postfix 
)

Definition at line 70 of file helpers.py.

Referenced by pfTools.adaptPFMuons(), pfTools.addPFCandidates(), pfTools.reconfigurePF2PATTaus(), pfTools.switchToPFJets(), pfTools.switchToPFMET(), pfTools.tauTypeInPF2PAT(), HiCoreTools.RemoveMCMatching.toolCode(), HiCoreTools.RemoveSpecificPATObjects.toolCode(), HiCoreTools.RemoveCleaning.toolCode(), and pfTools.usePF2PAT().

70 
71 def applyPostfix(process, label, postfix):
72  result = None
73  if hasattr(process, label+postfix):
74  result = getattr(process, label + postfix)
75  else:
76  raise ValueError("Error in <applyPostfix>: No module of name = %s attached to process !!" % (label + postfix))
77  return result
helpers.applyPostfix
def applyPostfix
Definition: helpers.py:70
def helpers.cloneProcessingSnippet (   process,
  sequence,
  postfix,
  removePostfix = "",
  noClones = [] 
) 
------------------------------------------------------------------
copy a sequence plus the modules and sequences therein
both are renamed by getting a postfix
input tags are automatically adjusted
------------------------------------------------------------------

Definition at line 309 of file helpers.py.

Referenced by boostedHPSPFTaus_cfi.addBoostedTaus(), pfIsolation.setupPFIso(), and pfIsolation.setupPFIsoPhoton().

309 
310 def cloneProcessingSnippet(process, sequence, postfix, removePostfix="", noClones = []):
311  """
312  ------------------------------------------------------------------
313  copy a sequence plus the modules and sequences therein
314  both are renamed by getting a postfix
315  input tags are automatically adjusted
316  ------------------------------------------------------------------
317  """
318  result = sequence
319  if not postfix == "":
320  visitor = CloneSequenceVisitor(process, sequence.label(), postfix, removePostfix, noClones)
321  sequence.visit(visitor)
322  result = visitor.clonedSequence()
323  return result
helpers.cloneProcessingSnippet
def cloneProcessingSnippet
Definition: helpers.py:309
def helpers.contains (   sequence,
  moduleName 
) 
------------------------------------------------------------------
return True if a module with name 'module' is contained in the
sequence with name 'sequence' and False otherwise. This version
is not so nice as it also returns True for any substr of the name
of a contained module.

sequence : sequence [e.g. process.patDefaultSequence]
module   : module name as a string
------------------------------------------------------------------

Definition at line 293 of file helpers.py.

References spr.find().

Referenced by helpers.TestModuleCommand.testContains().

293 
294 def contains(sequence, moduleName):
295  """
296  ------------------------------------------------------------------
297  return True if a module with name 'module' is contained in the
298  sequence with name 'sequence' and False otherwise. This version
299  is not so nice as it also returns True for any substr of the name
300  of a contained module.
301 
302  sequence : sequence [e.g. process.patDefaultSequence]
303  module : module name as a string
304  ------------------------------------------------------------------
305  """
306  return not sequence.__str__().find(moduleName)==-1
307 
308 
spr::find
void find(edm::Handle< EcalRecHitCollection > &hits, DetId thisDet, std::vector< EcalRecHitCollection::const_iterator > &hit, bool debug=false)
Definition: FindCaloHit.cc:7
helpers.contains
def contains
Definition: helpers.py:293
def helpers.extendWithPostfix (   process,
  other,
  postfix,
  items = () 
) 
Look in other and find types which we can use

Definition at line 24 of file helpers.py.

References cmsPerfStripChart.dict, dir, and massSearchReplaceAnyInputTag().

Referenced by loadWithPostfix().

24 
25 def extendWithPostfix(process,other,postfix,items=()):
26  """Look in other and find types which we can use"""
27  # enable explicit check to avoid overwriting of existing objects
28  #__dict__['_Process__InExtendCall'] = True
29 
30  seqs = dict()
31  sequence = cms.Sequence()
32  sequence._moduleLabels = []
33  sequence.setLabel('tempSequence')
34  for name in dir(other):
35  #'from XX import *' ignores these, and so should we.
36  if name.startswith('_'):
37  continue
38  item = getattr(other,name)
39  if name == "source" or name == "looper" or name == "subProcess":
40  continue
41  elif isinstance(item,cms._ModuleSequenceType):
42  continue
43  elif isinstance(item,cms.Schedule):
44  continue
45  elif isinstance(item,cms.VPSet) or isinstance(item,cms.PSet):
46  continue
47  elif isinstance(item,cms._Labelable):
48  if not item.hasLabel_():
49  item.setLabel(name)
50  if postfix != '':
51  newModule = item.clone()
52  if isinstance(item,cms.ESProducer):
53  newLabel = item.label()
54  newName =name
55  else:
56  if 'TauDiscrimination' in name:
57  process.__setattr__(name,item)
58  newLabel = item.label()+postfix
59  newName = name+postfix
60  process.__setattr__(newName,newModule)
61  if isinstance(newModule, cms._Sequenceable) and not newName == name:
62  sequence +=getattr(process,newName)
63  sequence._moduleLabels.append(item.label())
64  else:
65  process.__setattr__(name,item)
66 
67  if postfix != '':
68  for label in sequence._moduleLabels:
69  massSearchReplaceAnyInputTag(sequence, label, label+postfix,verbose=False,moduleLabelOnly=True)
helpers.massSearchReplaceAnyInputTag
def massSearchReplaceAnyInputTag
Definition: helpers.py:265
helpers.extendWithPostfix
def extendWithPostfix
Definition: helpers.py:24
dir
dbl *** dir
Definition: mlp_gen.cc:35
def helpers.get_path (   file_in_path)

Definition at line 6 of file helpers.py.

Referenced by get_vars().

6 
7 def get_path(file_in_path):
8  'mimics edm.FileInPath behavior'
9  search_env = os.environ.get('CMSSW_SEARCH_PATH', '')
10  if not search_env:
11  raise RuntimeError('The environmental variable CMSSW_SEARCH_PATH must be set')
12  search_paths = search_env.split(':')
13  for spath in search_paths:
14  full_path = os.path.join(spath, file_in_path)
15  if os.path.isfile(full_path):
16  return full_path
17  raise RuntimeError('No suitable path found for %s' % file_in_path)
helpers.get_path
def get_path
Definition: helpers.py:6
def helpers.get_vars (   xml_path,
  useFileInPath = True 
)

Definition at line 18 of file helpers.py.

References get_path(), and trainingvars.get_var_pset().

18 
19 def get_vars(xml_path, useFileInPath=True):
20  full_path = get_path(xml_path) if useFileInPath else xml_path
21  xml_tree = ET.parse(full_path)
22  root = xml_tree.getroot()
23  variables = None
24  for i in root:
25  if i.tag == 'Variables':
26  variables = i
27 
28  if i is None:
29  raise RuntimeError('Could not find Variables inside the xml weights')
30 
31  var_names = [i.attrib['Title'] for i in variables]
32  return [get_var_pset(i) for i in var_names]
33 
helpers.get_path
def get_path
Definition: helpers.py:6
helpers.get_vars
def get_vars
Definition: helpers.py:18
def helpers.jetCollectionString (   prefix = '',
  algo = '',
  type = '' 
) 
------------------------------------------------------------------
return the string of the jet collection module depending on the
input vaules. The default return value will be 'patAK5CaloJets'.

algo   : indicating the algorithm type of the jet [expected are
         'AK5', 'IC5', 'SC7', ...]
type   : indicating the type of constituents of the jet [expec-
         ted are 'Calo', 'PFlow', 'JPT', ...]
prefix : prefix indicating the type of pat collection module (ex-
         pected are '', 'selected', 'clean').
------------------------------------------------------------------

Definition at line 269 of file helpers.py.

References reco.if().

Referenced by helpers.TestModuleCommand.testJetCollectionString(), heavyIonTools.ProductionDefaults.toolCode(), HiCoreTools.RemoveMCMatching.toolCode(), coreTools.RemoveMCMatching.toolCode(), heavyIonTools.SelectionDefaults.toolCode(), and HiCoreTools.RemoveSpecificPATObjects.toolCode().

269 
270 def jetCollectionString(prefix='', algo='', type=''):
271  """
272  ------------------------------------------------------------------
273  return the string of the jet collection module depending on the
274  input vaules. The default return value will be 'patAK5CaloJets'.
275 
276  algo : indicating the algorithm type of the jet [expected are
277  'AK5', 'IC5', 'SC7', ...]
278  type : indicating the type of constituents of the jet [expec-
279  ted are 'Calo', 'PFlow', 'JPT', ...]
280  prefix : prefix indicating the type of pat collection module (ex-
281  pected are '', 'selected', 'clean').
282  ------------------------------------------------------------------
283  """
284  if(prefix==''):
285  jetCollectionString ='pat'
286  else:
287  jetCollectionString =prefix
288  jetCollectionString+='Pat'
289  jetCollectionString+='Jets'
290  jetCollectionString+=algo
291  jetCollectionString+=type
292  return jetCollectionString
helpers.jetCollectionString
def jetCollectionString
Definition: helpers.py:269
reco::if
if(dp >Float(M_PI)) dp-
def helpers.listModules (   sequence)

Definition at line 255 of file helpers.py.

Referenced by __labelsInSequence(), trigTools._modulesInPath(), helpers.TestModuleCommand.testListModules(), HiCoreTools.RemoveCleaning.toolCode(), and HiCoreTools.AddCleaning.toolCode().

255 
256 def listModules(sequence):
257  visitor = GatherAllModulesVisitor(gatheredInstance=cms._Module)
258  sequence.visit(visitor)
259  return visitor.modules()
helpers.listModules
def listModules
Definition: helpers.py:255
def helpers.listSequences (   sequence)

Definition at line 260 of file helpers.py.

Referenced by __labelsInSequence().

260 
261 def listSequences(sequence):
262  visitor = GatherAllModulesVisitor(gatheredInstance=cms.Sequence)
263  sequence.visit(visitor)
264  return visitor.modules()
helpers.listSequences
def listSequences
Definition: helpers.py:260
def helpers.loadWithPostfix (   process,
  moduleName,
  postfix = '' 
)

Definition at line 18 of file helpers.py.

References extendWithPostfix().

Referenced by pfTools.usePF2PAT().

18 
19 def loadWithPostfix(process,moduleName,postfix=''):
20  moduleName = moduleName.replace("/",".")
21  module = __import__(moduleName)
22  #print module.PatAlgos.patSequences_cff.patDefaultSequence
23  extendWithPostfix(process,sys.modules[moduleName],postfix)
helpers.extendWithPostfix
def extendWithPostfix
Definition: helpers.py:24
helpers.loadWithPostfix
def loadWithPostfix
Definition: helpers.py:18
def helpers.massSearchReplaceAnyInputTag (   sequence,
  oldInputTag,
  newInputTag,
  verbose = False,
  moduleLabelOnly = False,
  skipLabelTest = False 
) 
Replace InputTag oldInputTag with newInputTag, at any level of nesting within PSets, VPSets, VInputTags...

Definition at line 265 of file helpers.py.

Referenced by boostedHPSPFTaus_cfi.addBoostedTaus(), patMuonsWithTrigger_cff.changeRecoMuonInput(), customiseForPremixingInput.customiseForPreMixingInput(), extendWithPostfix(), CustomConfigs.MassReplaceInputTag(), ConfigBuilder.MassReplaceInputTag(), ConfigBuilder.ConfigBuilder.renameInputTagsInSequence(), helpers.TestModuleCommand.testMassSearchReplaceAnyInputTag(), and patMuonsWithTrigger_cff.useExistingPATMuons().

265 
266 def massSearchReplaceAnyInputTag(sequence, oldInputTag, newInputTag,verbose=False,moduleLabelOnly=False,skipLabelTest=False) :
267  """Replace InputTag oldInputTag with newInputTag, at any level of nesting within PSets, VPSets, VInputTags..."""
268  sequence.visit(MassSearchReplaceAnyInputTagVisitor(oldInputTag,newInputTag,verbose=verbose,moduleLabelOnly=moduleLabelOnly,skipLabelTest=skipLabelTest))
helpers.massSearchReplaceAnyInputTag
def massSearchReplaceAnyInputTag
Definition: helpers.py:265
def helpers.massSearchReplaceParam (   sequence,
  paramName,
  paramOldValue,
  paramValue,
  verbose = False 
)

Definition at line 252 of file helpers.py.

Referenced by CustomConfigs.MassReplaceParameter(), pfTools.reconfigurePF2PATTaus(), switchMVAtoDB_cfi.switchMVAtoDB(), and helpers.TestModuleCommand.testMassSearchReplaceParam().

252 
253 def massSearchReplaceParam(sequence,paramName,paramOldValue,paramValue,verbose=False):
254  sequence.visit(MassSearchReplaceParamVisitor(paramName,paramOldValue,paramValue,verbose))
helpers.massSearchReplaceParam
def massSearchReplaceParam
Definition: helpers.py:252
def helpers.removeIfInSequence (   process,
  target,
  sequenceLabel,
  postfix = "" 
)

Definition at line 78 of file helpers.py.

References __labelsInSequence(), and MatrixUtil.remove().

Referenced by HiCoreTools.RemoveSpecificPATObjects.toolCode().

78 
79 def removeIfInSequence(process, target, sequenceLabel, postfix=""):
80  labels = __labelsInSequence(process, sequenceLabel, postfix)
81  if target+postfix in labels:
82  getattr(process, sequenceLabel+postfix).remove(
83  getattr(process, target+postfix)
84  )
helpers.removeIfInSequence
def removeIfInSequence
Definition: helpers.py:78
helpers.__labelsInSequence
def __labelsInSequence
Definition: helpers.py:85
Generated for CMSSW Reference Manual by doxygen 1.8.5