plottingOptions.BasePlottingOptions Class Reference

Inheritance diagram for plottingOptions.BasePlottingOptions:

Public Member Functions
def	__init__ (self, config, valType)
def	getRepMap (self)
Public Member Functions inherited from genericValidation.ValidationMetaClass
def	__new__ (cls, clsname, bases, dct)

Public Attributes
	cmssw
	cmsswreleasebase
	config
	general
	randomWorkdirPart
	scramarch
	type

Static Public Attributes
dictionary	defaults
	mandatories = set()
dictionary	needpackages = {"Alignment/OfflineValidation"}
Static Public Attributes inherited from genericValidation.ValidationMetaClass
list	dicts = ["defaults"]
list	sets = ["mandatories", "optionals", "needpackages"]

Detailed Description

Definition at line 20 of file plottingOptions.py.

Constructor & Destructor Documentation

__init__()

def plottingOptions.BasePlottingOptions.__init__	(		self,
			config,
			valType
	)

Definition at line 32 of file plottingOptions.py.

    def __init__(self, config, valType):
        import random
        self.type = valType
        self.general = config.getGeneral()
        self.randomWorkdirPart = "%0i"%random.randint(1,10e9)
        self.config = config
 
        theUpdate = config.getResultingSection("plots:"+self.type,
                                               defaultDict = self.defaults,
                                               demandPars = self.mandatories)
        self.general.update(theUpdate)
 
        self.cmssw = self.general["cmssw"]
        badcharacters = r"\'"
        for character in badcharacters:
            if character in self.cmssw:
                raise AllInOneError("The bad characters " + badcharacters + " are not allowed in the cmssw\n"
                                    "path name.  If you really have it in such a ridiculously named location,\n"
                                    "try making a symbolic link somewhere with a decent name.")
        try:
            os.listdir(self.cmssw)
        except OSError:
            raise AllInOneError("Your cmssw release " + self.cmssw + ' does not exist')
 
        if self.cmssw == os.environ["CMSSW_BASE"]:
            self.scramarch = os.environ["SCRAM_ARCH"]
            self.cmsswreleasebase = os.environ["CMSSW_RELEASE_BASE"]
        else:
            command = ("cd '" + self.cmssw + "' && eval `scramv1 ru -sh 2> /dev/null`"
                       ' && echo "$CMSSW_BASE\n$SCRAM_ARCH\n$CMSSW_RELEASE_BASE"')
            commandoutput = getCommandOutput2(command).split('\n')
            self.cmssw = commandoutput[0]
            self.scramarch = commandoutput[1]
            self.cmsswreleasebase = commandoutput[2]
 
        for package in self.needpackages:
            for placetolook in self.cmssw, self.cmsswreleasebase:
                pkgpath = os.path.join(placetolook, "src", package)
                if os.path.exists(pkgpath):
                    self.general[package] = pkgpath
                    break
            else:
                raise AllInOneError("Package {} does not exist in {} or {}!".format(package, self.cmssw, self.cmsswreleasebase))
 
        self.general["publicationstatus"] = self.general["publicationstatus"].upper()
        self.general["era"] = self.general["era"].upper()
 
        if not self.general["publicationstatus"] and not self.general["customtitle"]:
            self.general["publicationstatus"] = "INTERNAL"
        if self.general["customtitle"] and not self.general["publicationstatus"]:
            self.general["publicationstatus"] = "CUSTOM"
 
        if self.general["publicationstatus"] != "CUSTOM" and self.general["customtitle"]:
            raise AllInOneError("If you would like to use a custom title, please leave out the 'publicationstatus' parameter")
        if self.general["publicationstatus"] == "CUSTOM" and not self.general["customtitle"]:
            raise AllInOneError("If you want to use a custom title, you should provide it using 'customtitle' in the [plots:%s] section" % valType)
 
        if self.general["era"] != "NONE" and self.general["customrighttitle"]:
            raise AllInOneError("If you would like to use a custom right title, please leave out the 'era' parameter")
 
        publicationstatusenum = ["INTERNAL", "INTERNAL_SIMULATION", "PRELIMINARY", "PUBLIC", "SIMULATION", "UNPUBLISHED", "CUSTOM"]
        eraenum = ["NONE", "CRUZET15", "CRAFT15", "COLL0T15"]
        if self.general["publicationstatus"] not in publicationstatusenum:
            raise AllInOneError("Publication status must be one of " + ", ".join(publicationstatusenum) + "!")
        if self.general["era"] not in eraenum:
            raise AllInOneError("Era must be one of " + ", ".join(eraenum) + "!")
 
        knownOpts = set(self.defaults.keys())|self.mandatories|self.optionals
        ignoreOpts = []
        config.checkInput("plots:"+self.type,
                          knownSimpleOptions = knownOpts,
                          ignoreOptions = ignoreOpts)
 

Member Function Documentation

getRepMap()

def plottingOptions.BasePlottingOptions.getRepMap

(

self

)

Definition at line 105 of file plottingOptions.py.

    def getRepMap(self):
        result = self.general
        result.update({
                "workdir": os.path.join(self.general["workdir"],
                                        self.randomWorkdirPart),
                "datadir": self.general["datadir"],
                "logdir": self.general["logdir"],
                "CMSSW_BASE": self.cmssw,
                "SCRAM_ARCH": self.scramarch,
                "CMSSW_RELEASE_BASE": self.cmsswreleasebase,
                "validationId": self.validationclass.__name__,
                })
        if issubclass(self.validationclass, ValidationWithPlots):
            result["plottingscriptname"] = self.validationclass.plottingscriptname()
            result["plottingscriptpath"] = ".oO[scriptsdir]Oo./.oO[plottingscriptname]Oo."
            result["PlotsDirName"] = self.validationclass.plotsdirname()
        if issubclass(self.validationclass, ValidationWithComparison):
            result["compareAlignmentsPath"] = self.validationclass.comparealignmentspath()
            result["compareAlignmentsName"] = self.validationclass.comparealignmentsname()
        return result
 

References plottingOptions.BasePlottingOptions.cmssw, genericValidation.GenericValidation.cmssw, plottingOptions.BasePlottingOptions.cmsswreleasebase, genericValidation.GenericValidation.cmsswreleasebase, plottingOptions.BasePlottingOptions.general, genericValidation.GenericValidation.general, plottingOptions.BasePlottingOptions.randomWorkdirPart, genericValidation.GenericValidation.randomWorkdirPart, plottingOptions.BasePlottingOptions.scramarch, genericValidation.GenericValidation.scramarch, presentation.ValidationPlots.validationclass(), plottingOptions.PlottingOptionsTrackSplitting.validationclass, plottingOptions.PlottingOptionsZMuMu.validationclass, plottingOptions.PlottingOptionsOffline.validationclass, plottingOptions.PlottingOptionsPrimaryVertex.validationclass, plottingOptions.PlottingOptionsOverlap.validationclass, and plottingOptions.PlottingOptionsPVResolution.validationclass.

Referenced by plottingOptions.PlottingOptionsTrackSplitting.validsubdets().

Member Data Documentation

cmssw

plottingOptions.BasePlottingOptions.cmssw

Definition at line 44 of file plottingOptions.py.

Referenced by plottingOptions.BasePlottingOptions.getRepMap().

cmsswreleasebase

plottingOptions.BasePlottingOptions.cmsswreleasebase

Definition at line 58 of file plottingOptions.py.

Referenced by plottingOptions.BasePlottingOptions.getRepMap().

config

plottingOptions.BasePlottingOptions.config

Definition at line 37 of file plottingOptions.py.

Referenced by confdb.HLTProcess.addEras(), confdb.HLTProcess.addGlobalOptions(), confdb.HLTProcess.build_source(), confdb.HLTProcess.buildOptions(), confdb.HLTProcess.customize(), confdb.HLTProcess.dump(), confdb.HLTProcess.fixPrescales(), pkg.AbstractPkg.generate(), pkg.AbstractPkg.get_kwds(), confdb.HLTProcess.getPathList(), confdb.HLTProcess.getRawConfigurationFromDB(), confdb.HLTProcess.getSetupConfigurationFromDB(), confdb.HLTProcess.instrumentDQM(), confdb.HLTProcess.instrumentErrorEventType(), confdb.HLTProcess.instrumentOpenMode(), confdb.HLTProcess.instrumentTiming(), confdb.HLTProcess.loadCffCommand(), confdb.HLTProcess.loadSetupCff(), confdb.HLTProcess.overrideGlobalTag(), confdb.HLTProcess.overrideL1MenuXml(), confdb.HLTProcess.overrideOutput(), confdb.HLTProcess.overrideProcessName(), pkg.AbstractPkg.parse_etags(), validateAlignments.ValidationJob.runJob(), confdb.HLTProcess.runL1Emulator(), and confdb.HLTProcess.specificCustomize().

defaults

dictionary plottingOptions.BasePlottingOptions.defaults

static

Initial value:

=  {
                "cmssw" : os.environ["CMSSW_BASE"],
                "publicationstatus" : "",
                "customtitle" : "",
                "customrighttitle" : "",
                "era" : "NONE",
                "legendheader" : "",
                "legendoptions":"all",
               }

Definition at line 21 of file plottingOptions.py.

Referenced by tree.Tree.reset(), and tree.Tree.var().

general

plottingOptions.BasePlottingOptions.general

Definition at line 35 of file plottingOptions.py.

Referenced by plottingOptions.PlottingOptionsTrackSplitting.__init__(), plottingOptions.PlottingOptionsZMuMu.__init__(), plottingOptions.PlottingOptionsOffline.__init__(), plottingOptions.PlottingOptionsPrimaryVertex.__init__(), and plottingOptions.BasePlottingOptions.getRepMap().

mandatories

plottingOptions.BasePlottingOptions.mandatories = set()

static

Definition at line 30 of file plottingOptions.py.

needpackages

dictionary plottingOptions.BasePlottingOptions.needpackages = {"Alignment/OfflineValidation"}

static

Definition at line 31 of file plottingOptions.py.

randomWorkdirPart

plottingOptions.BasePlottingOptions.randomWorkdirPart

Definition at line 36 of file plottingOptions.py.

Referenced by plottingOptions.BasePlottingOptions.getRepMap().

scramarch

plottingOptions.BasePlottingOptions.scramarch

Definition at line 57 of file plottingOptions.py.

Referenced by plottingOptions.BasePlottingOptions.getRepMap().

type

plottingOptions.BasePlottingOptions.type

Definition at line 34 of file plottingOptions.py.

Referenced by core.autovars.NTupleVariable.makeBranch(), DQM.DQMReader.read_objects(), and core.AutoHandle.AutoHandle.ReallyLoad().