CMS 3D CMS Logo
List of all members | Public Member Functions | Private Member Functions | Private Attributes
RandomServiceHelper.RandomNumberServiceHelper Class Reference
Inheritance diagram for RandomServiceHelper.RandomNumberServiceHelper:

Public Member Functions

def __init__ (self, randService)
 
def countSeeds (self)
 
def getNamedSeed (self, psetName)
 
def insertSeeds (self, seeds)
 
def populate (self, excludePSets)
 
def resetSeeds (self, value)
 
def setNamedSeed (self, psetName, seeds)
 

Private Member Functions

def __containsSeed (self, psetInstance)
 
def __psetsWithSeeds (self)
 

Private Attributes

 _lockedSeeds
 
 _randService
 

Detailed Description

_RandomNumberServiceHelper_

Helper class to hold and handle the Random number generator service.

Provide both user level and WM APIs.

Author:   Dave Evans
Modified: Eric Vaandering

Definition at line 9 of file RandomServiceHelper.py.

Constructor & Destructor Documentation

def RandomServiceHelper.RandomNumberServiceHelper.__init__ (   self,
  randService 
)

Definition at line 21 of file RandomServiceHelper.py.

21  def __init__(self,randService):
22  self._randService = randService
23  self._lockedSeeds = []
24 
25 

Member Function Documentation

def RandomServiceHelper.RandomNumberServiceHelper.__containsSeed (   self,
  psetInstance 
)
private 
_keeper_

True/False if the psetInstance has seeds in it

Definition at line 26 of file RandomServiceHelper.py.

Referenced by RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds().

26  def __containsSeed(self,psetInstance):
27  """
28  _keeper_
29 
30  True/False if the psetInstance has seeds in it
31 
32  """
33  if psetInstance is None:
34  return False
35  if not isinstance(psetInstance,CfgTypes.PSet):
36  return False
37  seedList = getattr(psetInstance, "initialSeedSet", None)
38  if seedList != None:
39  return True
40  seedVal = getattr(psetInstance, "initialSeed", None)
41  if seedVal != None:
42  return True
43  return False
44 
45 
def RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds (   self)
private 
_psetsWithSeeds_

*private method*

return the list of PSet instances with seeds in them

Definition at line 46 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper.__containsSeed(), RandomServiceHelper.RandomNumberServiceHelper._lockedSeeds, RandomServiceHelper.RandomNumberServiceHelper._randService, ALCARECOTkAlBeamHalo_cff.filter, and list().

Referenced by RandomServiceHelper.RandomNumberServiceHelper.countSeeds(), and RandomServiceHelper.RandomNumberServiceHelper.insertSeeds().

46  def __psetsWithSeeds(self):
47  """
48  _psetsWithSeeds_
49 
50  *private method*
51 
52  return the list of PSet instances with seeds in them
53 
54  """
55  svcAttrs = [getattr(self._randService, item, None)
56  for item in self._randService.parameters_()
57  if item not in self._lockedSeeds]
58 
59  #print svcAttrs
60 
61  return list(filter(self.__containsSeed, svcAttrs))
62 
63 
ALCARECOTkAlBeamHalo_cff.filter
filter
Definition: ALCARECOTkAlBeamHalo_cff.py:27
list
How EventSelector::AcceptEvent() decides whether to accept an event for output otherwise it is excluding the probing of A single or multiple positive and the trigger will pass if any such matching triggers are PASS or EXCEPTION[A criterion thatmatches no triggers at all is detected and causes a throw.] A single negative with an expectation of appropriate bit checking in the decision and the trigger will pass if any such matching triggers are FAIL or EXCEPTION A wildcarded negative criterion that matches more than one trigger in the trigger list("!*","!HLTx*"if it matches 2 triggers or more) will accept the event if all the matching triggers are FAIL.It will reject the event if any of the triggers are PASS or EXCEPTION(this matches the behavior of"!*"before the partial wildcard feature was incorporated).Triggers which are in the READY state are completely ignored.(READY should never be returned since the trigger paths have been run
def RandomServiceHelper.RandomNumberServiceHelper.countSeeds (   self) 
_countSeeds_

Count the number of seeds required by this service by
summing up the initialSeed and initialSeedSet entries
in all PSets in the service that contain those parameters.

Definition at line 64 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds().

Referenced by RandomServiceHelper.RandomNumberServiceHelper.insertSeeds(), RandomServiceHelper.RandomNumberServiceHelper.populate(), and RandomServiceHelper.RandomNumberServiceHelper.resetSeeds().

64  def countSeeds(self):
65  """
66  _countSeeds_
67 
68  Count the number of seeds required by this service by
69  summing up the initialSeed and initialSeedSet entries
70  in all PSets in the service that contain those parameters.
71 
72  """
73  count = 0
74 
75  for itemRef in self.__psetsWithSeeds():
76  # //
77  # // PSet has list of seeds
78  #//
79  seedSet = getattr(itemRef, "initialSeedSet", None)
80  if seedSet != None:
81  count += len( seedSet.value())
82  continue
83  # //
84  # // PSet has single seed
85  #//
86  seedVal = getattr(itemRef, "initialSeed", None)
87  if seedVal != None:
88  count += 1
89 
90  # //
91  # // PSet has no recognisable seed, therfore do nothing
92  #// with it
93  return count
94 
95 
def RandomServiceHelper.RandomNumberServiceHelper.getNamedSeed (   self,
  psetName 
) 
_getNamedSeed_

This method returns the seeds in a PSet in this service. Returned

- *psetName* : Name of the pset containing the seeds

Definition at line 138 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper._randService.

138  def getNamedSeed(self, psetName):
139  """
140  _getNamedSeed_
141 
142  This method returns the seeds in a PSet in this service. Returned
143 
144  - *psetName* : Name of the pset containing the seeds
145 
146  """
147  pset = getattr(self._randService, psetName, None)
148  if pset == None:
149  msg = "No PSet named %s belongs to this instance of the" % (
150  psetName,)
151  msg += "Random Seed Service"
152  raise RuntimeError(msg)
153 
154  seedVal = getattr(pset, "initialSeed", None)
155  if seedVal != None:
156  return [pset.initialSeed.value()]
157 
158  seedSet = getattr(pset, "initialSeedSet", None)
159  if seedSet != None:
160  return pset.initialSeedSet
161 
162 
def RandomServiceHelper.RandomNumberServiceHelper.insertSeeds (   self,
  seeds 
) 
_insertSeeds_

Given some list of specific seeds, insert them into the
service.

Length of seed list is required to be same as the seed count for
the service.

Usage: WM Tools.

Definition at line 163 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds(), RandomServiceHelper.RandomNumberServiceHelper.countSeeds(), and list().

Referenced by RandomServiceHelper.RandomNumberServiceHelper.populate(), and RandomServiceHelper.RandomNumberServiceHelper.resetSeeds().

163  def insertSeeds(self, *seeds):
164  """
165  _insertSeeds_
166 
167  Given some list of specific seeds, insert them into the
168  service.
169 
170  Length of seed list is required to be same as the seed count for
171  the service.
172 
173  Usage: WM Tools.
174 
175  """
176  seeds = list(seeds)
177  if len(seeds) < self.countSeeds():
178  msg = "Not enough seeds provided\n"
179  msg += "Service requires %s seeds, only %s provided\n"
180  msg += "to RandomeService.insertSeeds method\n"
181  raise RuntimeError(msg)
182 
183  for item in self.__psetsWithSeeds():
184  seedSet = getattr(item, "initialSeedSet", None)
185  if seedSet != None:
186  numSeeds = len(seedSet.value())
187  useSeeds = seeds[:numSeeds]
188  seeds = seeds[numSeeds:]
189  item.initialSeedSet = CfgTypes.untracked(
190  CfgTypes.vuint32(*useSeeds))
191  continue
192  useSeed = seeds[0]
193  seeds = seeds[1:]
194  item.initialSeed = CfgTypes.untracked(
195  CfgTypes.uint32(useSeed)
196  )
197  continue
198  return
199 
200 
list
How EventSelector::AcceptEvent() decides whether to accept an event for output otherwise it is excluding the probing of A single or multiple positive and the trigger will pass if any such matching triggers are PASS or EXCEPTION[A criterion thatmatches no triggers at all is detected and causes a throw.] A single negative with an expectation of appropriate bit checking in the decision and the trigger will pass if any such matching triggers are FAIL or EXCEPTION A wildcarded negative criterion that matches more than one trigger in the trigger list("!*","!HLTx*"if it matches 2 triggers or more) will accept the event if all the matching triggers are FAIL.It will reject the event if any of the triggers are PASS or EXCEPTION(this matches the behavior of"!*"before the partial wildcard feature was incorporated).Triggers which are in the READY state are completely ignored.(READY should never be returned since the trigger paths have been run
def RandomServiceHelper.RandomNumberServiceHelper.populate (   self,
  excludePSets 
) 
_populate_

generate a bunch of seeds and stick them into this service
This is the lazy user method.

Optional args are names of PSets to *NOT* alter seeds.

Eg:
populate() will set all seeds
populate("pset1", "pset2") will set all seeds but not those in
psets named pset1 and pset2

Definition at line 201 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper._lockedSeeds, RandomServiceHelper.RandomNumberServiceHelper.countSeeds(), RandomServiceHelper.RandomNumberServiceHelper.insertSeeds(), and list().

201  def populate(self, *excludePSets):
202  """
203  _populate_
204 
205  generate a bunch of seeds and stick them into this service
206  This is the lazy user method.
207 
208  Optional args are names of PSets to *NOT* alter seeds.
209 
210  Eg:
211  populate() will set all seeds
212  populate("pset1", "pset2") will set all seeds but not those in
213  psets named pset1 and pset2
214 
215  """
216 
217  import random
218  from random import SystemRandom
219  _inst = SystemRandom()
220  _MAXINT = 900000000
221 
222  # //
223  # // count seeds and create the required number of seeds
224  #//
225  newSeeds = [ _inst.randint(1, _MAXINT)
226  for i in range(self.countSeeds())]
227 
228 
229  self._lockedSeeds = list(excludePSets)
230  self.insertSeeds(*newSeeds)
231  self._lockedSeeds = []
232  return
233 
234 
list
How EventSelector::AcceptEvent() decides whether to accept an event for output otherwise it is excluding the probing of A single or multiple positive and the trigger will pass if any such matching triggers are PASS or EXCEPTION[A criterion thatmatches no triggers at all is detected and causes a throw.] A single negative with an expectation of appropriate bit checking in the decision and the trigger will pass if any such matching triggers are FAIL or EXCEPTION A wildcarded negative criterion that matches more than one trigger in the trigger list("!*","!HLTx*"if it matches 2 triggers or more) will accept the event if all the matching triggers are FAIL.It will reject the event if any of the triggers are PASS or EXCEPTION(this matches the behavior of"!*"before the partial wildcard feature was incorporated).Triggers which are in the READY state are completely ignored.(READY should never be returned since the trigger paths have been run
def RandomServiceHelper.RandomNumberServiceHelper.resetSeeds (   self,
  value 
) 
_resetSeeds_

reset all seeds to given value

Definition at line 235 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper.countSeeds(), RandomServiceHelper.RandomNumberServiceHelper.insertSeeds(), and edm.print().

235  def resetSeeds(self, value):
236  """
237  _resetSeeds_
238 
239  reset all seeds to given value
240 
241  """
242  newSeeds = [ value for i in range(self.countSeeds())]
243  self.insertSeeds(*newSeeds)
244  return
245 
246 
247 
def RandomServiceHelper.RandomNumberServiceHelper.setNamedSeed (   self,
  psetName,
  seeds 
) 
_setNamedSeed_

If a specific set of seeds is needed for a PSet in this
service, they can be set by name using this method.

- *psetName* : Name of the pset containing the seeds

- *seeds*    : list of seeds to be added, should be a single seed
for initialSeed values.

Definition at line 96 of file RandomServiceHelper.py.

References RandomServiceHelper.RandomNumberServiceHelper._randService.

96  def setNamedSeed(self, psetName, *seeds):
97  """
98  _setNamedSeed_
99 
100  If a specific set of seeds is needed for a PSet in this
101  service, they can be set by name using this method.
102 
103  - *psetName* : Name of the pset containing the seeds
104 
105  - *seeds* : list of seeds to be added, should be a single seed
106  for initialSeed values.
107 
108  """
109  pset = getattr(self._randService, psetName, None)
110  if pset == None:
111  msg = "No PSet named %s belongs to this instance of the" % (
112  psetName,)
113  msg += "Random Seed Service"
114  raise RuntimeError(msg)
115 
116  seedVal = getattr(pset, "initialSeed", None)
117  if seedVal != None:
118  pset.initialSeed = CfgTypes.untracked(
119  CfgTypes.uint32(seeds[0])
120  )
121 
122  return
123  seedSet = getattr(pset, "initialSeedSet", None)
124  if seedSet != None:
125  # //
126  # // Do we want to check the number of seeds??
127  #//
128  #if len(seeds) != len( seedSet.value()): pass
129  pset.initialSeedSet = CfgTypes.untracked(
130  CfgTypes.vuint32(*seeds))
131  return
132  # //
133  # // No seeds for that PSet
134  #// Error throw?
135  return
136 
137 

Member Data Documentation

RandomServiceHelper.RandomNumberServiceHelper._lockedSeeds
private

Definition at line 23 of file RandomServiceHelper.py.

Referenced by RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds(), and RandomServiceHelper.RandomNumberServiceHelper.populate().

RandomServiceHelper.RandomNumberServiceHelper._randService
private

Definition at line 22 of file RandomServiceHelper.py.

Referenced by RandomServiceHelper.RandomNumberServiceHelper.__psetsWithSeeds(), RandomServiceHelper.RandomNumberServiceHelper.getNamedSeed(), and RandomServiceHelper.RandomNumberServiceHelper.setNamedSeed().

Generated for CMSSW Reference Manual by doxygen 1.8.11