primaryVertexValidation.py

Go to the documentation of this file.

from __future__ import absolute_import
import os
from . import configTemplates
from . import globalDictionaries
from .genericValidation import GenericValidationData_CTSR, ParallelValidation, ValidationWithPlots, pythonboolstring
from .helperFunctions import replaceByMap
from .TkAlExceptions import AllInOneError

class PrimaryVertexValidation(GenericValidationData_CTSR, ParallelValidation, ValidationWithPlots):
    configBaseName  = "TkAlPrimaryVertexValidation"
    scriptBaseName  = "TkAlPrimaryVertexValidation"
    crabCfgBaseName = "TkAlPrimaryVertexValidation"
    resultBaseName  = "PrimaryVertexValidation"
    outputBaseName  = "PrimaryVertexValidation"
    defaults = {
        # N.B.: the reference needs to be updated each time the format of the output is changed
        "pvvalidationreference": ("/store/group/alca_trackeralign/validation/PVValidation/Reference/PrimaryVertexValidation_phaseIMC92X_upgrade2017_Ideal.root"),
        "doBPix":"True",
        "doFPix":"True",
        "forceBeamSpot":"False",
        "multiIOV":"False",
        }
    mandatories = {"isda","ismc","runboundary","trackcollection","vertexcollection","lumilist","ptCut","etaCut","runControl","numberOfBins"}
    valType = "primaryvertex"
    def __init__(self, valName, alignment, config):
        super(PrimaryVertexValidation, self).__init__(valName, alignment, config)

        for name in "doBPix", "doFPix", "forceBeamSpot":
            self.general[name] = pythonboolstring(self.general[name], name)

        if self.general["pvvalidationreference"].startswith("/store"):
            self.general["pvvalidationreference"] = "root://eoscms//eos/cms" + self.general["pvvalidationreference"]
            
    @property
    def ValidationTemplate(self):
        return configTemplates.PrimaryVertexValidationTemplate

    @property
    def DefinePath(self):
        return configTemplates.PVValidationPath

    @property
    def ValidationSequence(self):
        #never enters anywhere, since we use the custom DefinePath which includes the goodVertexSkim
        return ""

    @property
    def use_d0cut(self):
        return False

    @property
    def isPVValidation(self):
        return True

    @property
    def ProcessName(self):
        return "PrimaryVertexValidation"

    def createScript(self, path):
        return super(PrimaryVertexValidation, self).createScript(path, template = configTemplates.PVValidationScriptTemplate)

    def createCrabCfg(self, path):
        return super(PrimaryVertexValidation, self).createCrabCfg(path, self.crabCfgBaseName)

    def getRepMap(self, alignment = None):
        if alignment == None:
            alignment = self.alignmentToValidate
        repMap = super(PrimaryVertexValidation, self).getRepMap(alignment)
        repMap.update({
            "nEvents": self.general["maxevents"],
            "TrackCollection": self.general["trackcollection"],
            "VertexCollection": self.general["vertexcollection"],
            "eosdir": os.path.join(self.general["eosdir"]),
            #"eosdir": os.path.join(self.general["eosdir"], "%s/%s/%s" % (self.outputBaseName, self.name, alignment.name)),
            "workingdir": ".oO[datadir]Oo./%s/%s/%s" % (self.outputBaseName, self.name, alignment.name),
            "plotsdir": ".oO[datadir]Oo./%s/%s/%s/plots" % (self.outputBaseName, self.name, alignment.name),
            "filetoplot": "root://eoscms//eos/cms.oO[finalResultFile]Oo.",
            })

        return repMap

    def appendToMerge(self):
        """
        if no argument or "" is passed a string with an instantiation is returned,
        else the validation is appended to the list
        """
        repMap = self.getRepMap()

        parameters = " ".join(os.path.join("root://eoscms//eos/cms", file.lstrip("/")) for file in repMap["resultFiles"])

        mergedoutputfile = os.path.join("root://eoscms//eos/cms", repMap["finalResultFile"].lstrip("/"))
        return "hadd -f %s %s\n" % (mergedoutputfile, parameters)

    def appendToPlots(self):
        repMap = self.getRepMap()
        return (' loadFileList("%(filetoplot)s",'
                '"PVValidation", "%(title)s", %(color)s, %(style)s);\n')%repMap

    @classmethod
    def runPlots(cls, validations):
        return configTemplates.PrimaryVertexPlotExecution

    @classmethod
    def plottingscriptname(cls):
        return "TkAlPrimaryVertexValidationPlot.C"

    @classmethod
    def plottingscripttemplate(cls):
        return configTemplates.PrimaryVertexPlotTemplate

    @classmethod
    def plotsdirname(cls):
        return "PrimaryVertexValidation"