Inheritance diagram for SpecificationBuilder_cfi.Specification:

Public Member Functions
def	__deepcopy__ (self, memo)

def	__init__ (self, conf=DefaultConf)

def	groupBy (self, cols, mode="SUM")

def	pythonTypeName (self)

def	reduce (self, sort)

def	save (self, nbins=-1, xmin=0, xmax=0)

def	saveAll (self)

Public Attributes
	conf

	spec

Private Attributes
	_activeColumns

	_lastColumns

	_lastMode

	_state

	_x

	_y

	_z

Detailed Description

Definition at line 60 of file SpecificationBuilder_cfi.py.

Constructor & Destructor Documentation

◆ init()

def SpecificationBuilder_cfi.Specification.__init__	(	self,
		conf = `DefaultConf`
	)

Definition at line 61 of file SpecificationBuilder_cfi.py.

   def __init__(self, conf = DefaultConf):
     super(Specification, self).__init__()
     # these are the steps passed down to C++. Will be filled later.
     self.spec = cms.VPSet()
     # this is currently only an additional enable flag. Might add topFolder or
     # range there in the future.
     self.conf = conf
  
     # these are onlly used during construction.
     self._activeColumns = set()
     self._state = FIRST
  

Member Function Documentation

◆ deepcopy()

def SpecificationBuilder_cfi.Specification.__deepcopy__	(	self,
		memo
	)

Definition at line 73 of file SpecificationBuilder_cfi.py.

   def __deepcopy__(self, memo):
     # override deepcopy to not copy .conf: it should remain a reference
     # w/o this it is not cleanly possible to build a per-module switch.
     t = Specification(self.conf)
     t.spec = deepcopy(self.spec, memo)
     return t 
  

References CondFormats_MFObjects::dictionary.conf, SpecificationBuilder_cfi.Specification.conf, cms::Filter.spec, and SpecificationBuilder_cfi.Specification.spec.

◆ groupBy()

def SpecificationBuilder_cfi.Specification.groupBy	(	self,
		cols,
		mode = `"SUM"`
	)

Definition at line 80 of file SpecificationBuilder_cfi.py.

   def groupBy(self, cols, mode = "SUM"):
     cnames = list(filter(len, val(cols).split("/"))) # omit empty items
     newstate = self._state
  
     # The behaviour of groupBy depends a lot on when it happens:
     # - The first (or second, if there is per-event counting) are very special
     # - others in STAGE1 have to be EXTEND, and they will be translated into a
     #   list of exactly 3 USE/EXTEND steps (one per dimension).
     # - in STAGE2 they are just passed down to C++.
  
     if self._state == FIRST:
       cname = cnames
       if mode != "SUM":
         raise Exception("First grouping must be SUM") 
       if "Event" in cnames:
         cnames.remove("Event"); # per-Event grouping is done automatically
         t = COUNT
         mode =  "COUNT"
         newstate = FIRST
       else:
         t = GROUPBY
         newstate = STAGE1
  
     if self._state == STAGE1:
       cname = self._activeColumns.difference(cnames)
       if len(cname) != 1:
         raise Exception("EXTEND must drop exactly one column.")
  
       if mode == "EXTEND_X":
         self._x.type = EXTEND_X
         self._x.columns = cms.vstring(cname)
       elif mode == "EXTEND_Y":
         self._y.type = EXTEND_Y
         self._y.columns = cms.vstring(cname)
       else:
         raise Exception("Only EXTEND_X or EXTEND_Y allowed here, not " + mode)
  
       # remove the column in the FIRST groupBy, we always re-extract in step1.
       c = list(cname)[0]
       for s in self.spec:
         if s.stage == FIRST and s.type == GROUPBY and c in s.columns:
           s.columns.remove(c)
       if c in self._activeColumns:
         self._activeColumns.remove(c)
       if c in self._lastColumns:
         self._lastColumns.remove(c)
  
       return self # done here, no new step to add
  
     if self._state == STAGE2:
       cname = cnames
       if self._activeColumns.issubset(cname):
         raise Exception("Harvesting GROUPBY must drop some columns")
       if mode == "EXTEND_X":
         t = EXTEND_X
       elif mode == "SUM":
         t = GROUPBY
       else:
         raise Exception("Currently only EXTEND_X and SUM supported in harvesting, not " + mode)
  
     self._activeColumns = set(cnames)
     self._lastColumns = cnames
     self._lastMode = mode
  
     self.spec.append(cms.PSet(
       type = t, 
       stage = self._state, 
       columns = cms.vstring(cname),
       arg = cms.string(mode),
       nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
     ))
  
     # In the very beginning emit standard column assignments, they will be 
     # changed later (above and in save()) to reflect the EXTENDS given above.
     if newstate == STAGE1 and self._state == FIRST:
       self._x = cms.PSet(
         type = USE_X, stage = STAGE1,
         columns = cms.vstring(),
         arg = cms.string(""),
         nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
       )
       self.spec.append(self._x)
       self._y = cms.PSet(
         type = USE_Y, stage = STAGE1,
         columns = cms.vstring(),
         arg = cms.string(""),
         nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
       )
       self.spec.append(self._y)
       self._z = cms.PSet(
         type = USE_Z, stage = STAGE1,
         columns = cms.vstring(),
         arg = cms.string(""),
         nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
       )
       self.spec.append(self._z)
  
     self._state = newstate
  
     return self
  

References SpecificationBuilder_cfi.Specification._activeColumns, SpecificationBuilder_cfi.Specification._lastColumns, hcaldqm::flag::Flag._state, SpecificationBuilder_cfi.Specification._state, PGeometricDet::Item._x, SpecificationBuilder_cfi.Specification._x, PGeometricDet::Item._y, SpecificationBuilder_cfi.Specification._y, ALCARECOTkAlBeamHalo_cff.filter, list(), MatrixUtil.remove(), cms::Filter.spec, SpecificationBuilder_cfi.Specification.spec, cms::dd.split(), and SpecificationBuilder_cfi.val().

Referenced by SpecificationBuilder_cfi.Specification.saveAll().

◆ pythonTypeName()

def SpecificationBuilder_cfi.Specification.pythonTypeName ( self )

Definition at line 265 of file SpecificationBuilder_cfi.py.

265 def pythonTypeName(self):

266 return 'cms.PSet';

Referenced by Mixins._ParameterTypeBase.dumpPython(), Mixins._ValidatingParameterListBase.dumpPython(), and Types.PSet.dumpPython().

◆ reduce()

def SpecificationBuilder_cfi.Specification.reduce	(	self,
		sort
	)

Definition at line 181 of file SpecificationBuilder_cfi.py.

   def reduce(self, sort):
     # reduce can be MEAN or COUNT. in STAGE2, just pass through.
     # in STAGE1, MEAN (anywhere) means make a PROFILE
     # COUNT can mean per-event counting or a occupancy plot, which is acheived
     # by ignoring the values passed to fill() (like dimensions=0, TODO).
     if self._state == FIRST:
       if sort != "COUNT":
         raise Exception("First statement must be groupBy.")
       self.spec[0].type = COUNT # this is actually a noop
       # groupBy already saw the "Event" column and set up counting.
  
       return self
  
     if self._state == STAGE1:
       if sort == "MEAN":
         self.spec.append(cms.PSet(
           type = PROFILE, stage = STAGE1,
           columns = cms.vstring(), arg = cms.string(""),
           nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
         ))
       return self
  
     if sort != "MEAN":
       raise Exception("Harvesting allows only reduce(MEAN) at the moment, not " + sort)
  
     self.spec.append(cms.PSet(
       type = REDUCE, 
       stage = self._state, 
       columns = cms.vstring(),
       arg = cms.string(sort),
       nbins = cms.int32(-1), xmin = cms.int32(0), xmax = cms.int32(0)
     ))
     return self
  

References hcaldqm::flag::Flag._state, SpecificationBuilder_cfi.Specification._state, mps_setup.append, cms::Filter.spec, and SpecificationBuilder_cfi.Specification.spec.

◆ save()

def SpecificationBuilder_cfi.Specification.save	(	self,
		nbins = `-1`,
		xmin = `0`,
		xmax = `0`
	)

Definition at line 215 of file SpecificationBuilder_cfi.py.

   def save(self, nbins=-1, xmin=0, xmax=0):
     if self._state == FIRST:
       raise Exception("First statement must be groupBy.")
  
     if self._state == STAGE1:
       # end of STAGE1, fix the parameter assignments
       n = 1
       if self._x.type == USE_X: 
         self._x.arg = cms.string(str(n))
         n = n+1
         self._x.nbins = cms.int32(nbins)
         self._x.xmin = cms.int32(xmin)
         self._x.xmax = cms.int32(xmax)
       if self._y.type == USE_Y: 
         self._y.arg = cms.string(str(n)) 
         n = n+1
         self._y.nbins = cms.int32(nbins)
         self._y.xmin = cms.int32(xmin)
         self._y.xmax = cms.int32(xmax)  
       if self._z.type == USE_Z: 
         self._z.arg = cms.string(str(n)) 
         n = n+1
         self._z.nbins = cms.int32(nbins)
         self._z.xmin = cms.int32(xmin)
         self._z.xmax = cms.int32(xmax)
       # we don't know how many parameters the user wants to pass here, but the 
       # HistogramManager knows. So we just add 3.
  
     # SAVE is implicit in step1 and ignored in harvesting, so not really needed.
     # self.spec.append(cms.PSet(
     # type = SAVE, 
     # stage = self._state, 
     # columns = cms.vstring(),
     # arg = cms.string(""),
     # ))
     self._state = STAGE2
  
     return self
  

References hcaldqm::flag::Flag._state, SpecificationBuilder_cfi.Specification._state, PGeometricDet::Item._x, SpecificationBuilder_cfi.Specification._x, PGeometricDet::Item._y, SpecificationBuilder_cfi.Specification._y, PGeometricDet::Item._z, SpecificationBuilder_cfi.Specification._z, and str.

Referenced by SpecificationBuilder_cfi.Specification.saveAll().

◆ saveAll()

def SpecificationBuilder_cfi.Specification.saveAll ( self )

Definition at line 254 of file SpecificationBuilder_cfi.py.

   def saveAll(self):
     # call groupBy() and save() until all colums are consumed.
     self.save()
     columns = self._lastColumns
     for i in range(len(columns)-1, 0, -1):
       cols = columns[0:i]
       self.groupBy("/".join(cols), self._lastMode)
       self.save()
     return self
  