Project CMSSW displayed by LXR CMSSW_15_1_X_2025-05-18-2300/​HLTriggerOffline/​Egamma/​test/​egammaHltValidate.py	Source navigation Diff markup Identifier search General search
	Version: CMSSW_15_1_X_2025-05-18-2300 CMSSW_15_1_X_2025-05-15-2300 CMSSW_15_1_X_2025-05-14-2300 CMSSW_15_1_X_2025-05-12-2300 CMSSW_15_0_4 CMSSW_15_0_3_patch1 CMSSW_14_0_21_patch1 Revert   Change

File indexing completed on 2024-11-26 02:34:21

 #!/usr/bin/env python
 # adapted to python and extended (by Andre Holzner) based on a
 # shell script by Michael Anderson
 #
 # To use, type for example:
 #  hltValidate 3_5_5
 #
 # This script runs validation on new relval samples.
 # Requires version of CMSSW given.
 #
 # Michael Anderson
 # Sept 15, 2009
 
 import sys, os, shutil
 #----------------------------------------------------------------------
 # parameters
 #----------------------------------------------------------------------
 # CMSSW Module to check out & compile
 module="HLTriggerOffline/Egamma"
 
 # Root file name outputted by running module
 outputRootFile="DQM_V0001_HLT_R000000001.root"
 
 
 # Datasets to run on
 # could actually get rid of the version string in the datasets
 # as we explicitly require the release in the DBS query ?
 knownDatasets = {
     "diGamma" : {
         "dataset": "/RelValH130GGgluonfusion*/CMSSW_%(version)s*/GEN-SIM-DIGI-RAW-HLTDEBUG",
         "output":  "DiGamma_%(version)s.root", 
         },
 
     "photonJet" : {
         "dataset": "/RelValPhotonJets_Pt_10*/CMSSW_%(version)s*/GEN-SIM-DIGI-RAW-HLTDEBUG",
         "output":  "GammaJet_%(version)s.root", 
         },
     
     "zee" : {
         "dataset": "/RelValZEE*/CMSSW_%(version)s*/GEN-SIM-DIGI-RAW-HLTDEBUG",
         "output":  "ZEE_%(version)s.root",
         },
 
     "wen" : {
         "dataset": "/RelValWE*/CMSSW_%(version)s*/GEN-SIM-DIGI-RAW-HLTDEBUG",
         "output":  "WEN_%(version)s.root",
         },
 } 
 
 #----------------------------------------------------------------------
 
 def execCmd(cmd):
     retval = os.system(cmd)
     if retval != 0:
         raise Exception("failed to execute command '" + cmd + "', exit status = " + str(retval))
 
 #----------------------------------------------------------------------
 
 # code based on PhysicsTools.PatAlgos.tools.helpers.MassSearchReplaceAnyInputTagVisitor
 # to replace the process names of all input tags found in sequences.
 #
 # necessary e.g. when one has to run the HLT and thus must later on
 # use a different process name
 
 class ReplaceProcessNameOfInputTags(object):
     """Visitor that travels within a cms.Sequence and replaces 
        It will climb down within PSets, VPSets and VInputTags to find its target.
 
        Useful e.g. for replacing the process names of all input tags where the 
        process name was specified explicitly.
     """
 
     #----------------------------------------
     def __init__(self,origProcessName,newProcessName,verbose=False):
         self._origProcessName = origProcessName
         self._newProcessName  = newProcessName
         # self._moduleName   = ''
         self._verbose=verbose
 
     #----------------------------------------
 
     def doIt(self,pset,base):
         if isinstance(pset, cms._Parameterizable):
             for name in pset.parameters_().keys():
                 # if I use pset.parameters_().items() I get copies of the parameter values
                 # so I can't modify the nested pset
                 value = getattr(pset,name) 
                 type = value.pythonTypeName()
                 if type == 'cms.PSet':  
                     self.doIt(value,base+"."+name)
                 elif type == 'cms.VPSet':
                     for (i,ps) in enumerate(value): self.doIt(ps, "%s.%s[%d]"%(base,name,i) )
                 elif type == 'cms.VInputTag':
                     for (i,n) in enumerate(value): 
                          # VInputTag can be declared as a list of strings, so ensure that n is formatted correctly
                          n = self.standardizeInputTagFmt(n)
                          if self._verbose:print("FOUND TAG:",value[i])
 
                          if value[i].processName == self._origProcessName:
                              if self._verbose: print("REPLACING")
                              value[i].processName = self._newProcessName
                          else:
                              if self._verbose: print("NOT REPLACING")
 
                 elif type == 'cms.InputTag':
                     if self._verbose:print("FOUND TAG:",value)                        
 
                     if value.processName == self._origProcessName:
                         if self._verbose:print("REPLACING")
                         value.processName = self._newProcessName
                     else:
                         if self._verbose:print("NOT REPLACING")
 
     #----------------------------------------
     @staticmethod 
     def standardizeInputTagFmt(inputTag):
        ''' helper function to ensure that the InputTag is defined as cms.InputTag(str) and not as a plain str '''
        if not isinstance(inputTag, cms.InputTag):
           return cms.InputTag(inputTag)
        return inputTag
 
     #----------------------------------------
     def enter(self,visitee):
         label = ''
         try:    label = visitee.label()
         except AttributeError: label = '<Module not in a Process>'
         self.doIt(visitee, label)
 
     #----------------------------------------
     def leave(self,visitee):
         pass
 
     #----------------------------------------
 
 #----------------------------------------------------------------------
 
 def findCMSSWreleaseDir(version):
     """ runs scramv1 list to find the directory of the given CMSSW release.
 
     Sometimes it happens that there is more than one line in the scram output
     for the same release (and even the same directory). In general, just
     the first matching line is returned.
     
     """
 
     import re
 
     if not version.startswith("CMSSW_"):
         version = "CMSSW_" + version
 
     for line in os.popen('scramv1 list -c CMSSW').readlines():
 
         line = line.split('\n')[0].strip()
 
         project, release, directory = re.split('\s+',line)
 
         if release == version:
             return directory
 
 #----------------------------------------------------------------------
 def findDataSetFromSampleName(sampleSpec, version, cdToReleaseDir):
     """ from the given sample specification (e.g. photonJet), tries to get
     the relval dataset from DBS for the given CMSSW version.
 
     If more than one sample is found, the user is prompted
     to select one.
     """
 
     # Find the dataset in DBS using command. This actually
     # could find more than one dataset.
 
     datasetToSearchFor= knownDatasets[sampleSpec]['dataset'] % { "version": version }
 
     dbs_cmd = 'das_client.py --query=dataset=' + datasetToSearchFor + ' | grep "HLTDEBUG"'
 
     cmssw_release_dir = findCMSSWreleaseDir(version)
 
     cmd_parts = []
 
     if cdToReleaseDir:
         cmd_parts.extend([
             'cd ' + cmssw_release_dir,
             "eval `scramv1 runtime -sh`",
             "cd - > /dev/null",   # this seems to print a line in some cases
             ])
 
     cmd_parts.append(dbs_cmd)
 
     allDatasetsToCheck=os.popen("  && ".join(cmd_parts)).readlines()
     allDatasetsToCheck = [ x.strip() for x in allDatasetsToCheck ]
 
     if len(allDatasetsToCheck) == 1:
         datasetToCheck = allDatasetsToCheck[0]
     elif len(allDatasetsToCheck) == 0:
         print("failed to find dataset in dbs")
         print()
         print("dbs command was:")
         print(dbs_cmd)
         sys.exit(1)
     else:
         # more than one dataset found
         print("found the following matching datasets, please select one:")
 
         for i in range(len(allDatasetsToCheck)):
             print("  %2d: %s" % (i, allDatasetsToCheck[i]))
 
         print("your choice:", end=' ')
         choice = sys.stdin.readline()
         choice = int(choice)
 
         datasetToCheck = allDatasetsToCheck[choice]
 
         print("selected",datasetToCheck)
 
     ###################################
 
 
     ###################################
     # Make sure dataset was found
     print("Looked for dataset matching " + datasetToSearchFor)
 
     print("found")
     print("  ",datasetToCheck)
     print()
 
     return datasetToCheck
 
 #----------------------------------------------------------------------
 def createProjectArea(version):
     """creates a new scram project area for the given release
     and chdirs to it """
 
     print("Setting up CMSSW_" + version + " environment")
     execCmd("scramv1 project CMSSW CMSSW_" + version)
     os.chdir("CMSSW_" + version + "/src")
 
 
 #----------------------------------------------------------------------
 
 def ensureProjectAreaNotExisting(version):
     # refuse to run if the release area exists already
     # (can mix tags and samples etc.)
 
     project_dir = "CMSSW_" + version
 
     if os.path.exists(project_dir):
         print("the project directory " + project_dir + " already exists.", file=sys.stderr)
         print("Refusing to continue as this might cause unexpected results.", file=sys.stderr)
         sys.exit(1)
 
 #----------------------------------------------------------------------
 
 def cleanVersion(version):
     """ removes CMSSW_ from the version string if it starts with it """
 
     prefix = "CMSSW_"
 
     if version.startswith(prefix):
         return version[len(prefix):]
     else:
         return version
 
 #----------------------------------------------------------------------
 
 def getCMSSWVersionFromEnvironment():
     """ determines the CMSSW version from environment variables """
 
     varname = "CMSSW_VERSION"
 
     if varname not in os.environ:
         print("The environment variable " + varname + " is not set.", file=sys.stderr)
         print("It looks like you have not initialized a runtime", file=sys.stderr)
         print("environment for CMSSW but want to use the 'current one'.", file=sys.stderr)
         print(file=sys.stderr)
         print("Try running cmsenv and then run this script again.", file=sys.stderr)
         sys.exit(1)
 
     return cleanVersion(os.environ[varname])
 
 #----------------------------------------------------------------------
 # main
 #----------------------------------------------------------------------
 from optparse import OptionParser
 
 parser = OptionParser("""
 
   usage: %prog [options] [sample] [cmssw-version]
 
     e.g. %prog photonJet 3_5_6
          %prog --this-project-area photonJet
          %prog --file=rfio://castor/cern.ch/cms/store/... 3_5_6
          %prog --file=rfio://castor/cern.ch/cms/store/... --this-project-area
          
   Produces the histogram files for E/gamma path validation.
 
   sample is required unless input files are specified directly using the --file=... option.
 
   cmssw-version is required unless the option --this-project-area is given
 
 """
 )
 
 parser.add_option("--file",
                   dest="direct_input_files",
                   default = [],
                   type="str",
                   action="append", # append to list
                   help="run directly from the ROOT file given. Option can be specified multiple times.",
                   metavar="FILE")
 
 
 parser.add_option("--hlt-process",
                   dest="hlt_process_name",
                   default = None,
                   type="str",
                   help="Specify the name of the HLT process. Useful e.g. when running on a file produced by yourself with a different process name.",
                   metavar="PROC")
 
 parser.add_option("--cvstag",
                   dest="cvstag",
                   default = "HEAD",
                   type="str",
                   help="CVS tag to be used for module " + module + ". Default is to use the HEAD revision.",
                   metavar="TAG")
 
 
 parser.add_option("--cfg",
                   dest="configFile",
                   default = None,
                   type="str",
                   help="Base config file (relative to HLTriggerOffline/Egamma if using files from CVS or relative to the current path if the option --this-project-area is given) to run with cmsRun. Change this e.g. when you want to run on data instead of MC.",
                   metavar="CFG_FILE.py")
 
 parser.add_option("--cfg-add",
                   dest="cfg_add",
                   default = [],
                   type="str",
                   action="append", # append to list
                   help="line to add to the generated cmsRun configuration file. Can be specified several times",
                   metavar="CFG_LINE")
 
 parser.add_option("--num-events",
                   dest="num_events",
                   default = None,
                   type="int",
                   help="set maxEvents to run over a limited number of events",
                   metavar="NUM")
 
 
 parser.add_option("--this-project-area",
                   dest="useThisProjectArea",
                   default = False,
                   action = "store_true",
                   help="instead of creating a new project area and checking out files from CVS, use the current CMSSW project area in use",
                   )
 
 parser.add_option("--follow",
                   dest="followCmsRunoutput",
                   default = False,
                   action = "store_true",
                   help="show output of cmsRun task (in addition to writing it to a log file)",
                   )
 
 parser.add_option("--data",
                   dest="isData",
                   default = False,
                   action = "store_true",
                   help="run on real data file",
                   )
 
 (options, ARGV) = parser.parse_args()
 
 sampleSpec = None
 
 #----------------------------------------
 # sanity checks
 #----------------------------------------
 
 
 if options.useThisProjectArea:
     version = getCMSSWVersionFromEnvironment()
 
 # default (input) config file
 
 if options.configFile == None:
 
     if options.useThisProjectArea:
         options.configFile = os.path.join(os.environ['CMSSW_BASE'],"src/HLTriggerOffline/Egamma/test/test_cfg.py")
     else:
         options.configFile = "test/test_cfg.py"
 
 #----------------------------------------
 # TODO: we should do things which take more than
 #       a second only AFTER checking the consistency
 #       of the command line arguments...
 
 if len(options.direct_input_files) == 0:
     if len(ARGV) < 1:
         print("No data sample specified. Try the -h option to get more detailed usage help.", file=sys.stderr)
         print(file=sys.stderr)
         print("known samples are: " + " ".join(knownDatasets.keys()), file=sys.stderr)
         print(file=sys.stderr)
         sys.exit(1)
 
     sampleSpec = ARGV.pop(0)
 
     # check whether we know the specified sample
     if sampleSpec not in knownDatasets:
         print("unknown sample " + sampleSpec + ", known samples are: " + " ".join(knownDatasets.keys()), file=sys.stderr)
         sys.exit(1)
 
     if not options.useThisProjectArea:
 
         if len(ARGV) < 1:
             print("No CMSSW version specified. Try the -h option to get more detailed usage help.", file=sys.stderr)
             print(file=sys.stderr)
             sys.exit(1)
 
         version= cleanVersion(ARGV.pop())
 
         ensureProjectAreaNotExisting(version)
         createProjectArea(version)
     else:
         # get cmssw version from the environment
         # this was actually done already before
         pass
     
 
     datasetToCheck = findDataSetFromSampleName(sampleSpec, version, not options.useThisProjectArea)
 
     # Get the file names in the dataset path, and format it for python files
     print("\n\nGetting file names for")
     print("  ",datasetToCheck)
 
     cmssw_release_dir = findCMSSWreleaseDir(version)
     cmd_parts = []
 
     if not options.useThisProjectArea:
         cmd_parts.extend([
         'cd ' + cmssw_release_dir,
         "eval `scramv1 runtime -sh`",
         "cd -",
             ])
 
     cmd_parts.append("das_client.py --query='file dataset=" + datasetToCheck + "'")
 
 
     FILES=os.popen(" && ".join(cmd_parts)).readlines()
     FILES=[ x.strip() for x in FILES ]
     FILES=[ x for x in FILES if x.endswith('.root') ]
 
 else:
     # input files were specified explicitly (instead of a dataset)
     FILES = options.direct_input_files[:]
 
     datasetToCheck = "(undefined dataset)"
 
     if not options.useThisProjectArea:
         if len(ARGV) < 1:
             print("No CMSSW version specified. Try the -h option to get more detailed usage help.", file=sys.stderr)
             print(file=sys.stderr)
             sys.exit(1)
 
         version=cleanVersion(ARGV.pop(0))
         ensureProjectAreaNotExisting(version)
         createProjectArea(version)
     else:
         # get cmssw version from the environment
         # this was actually done already before
         pass
 
 #----------------------------------------
 
 if len(ARGV) != 0:
     print("too many positional (non-option) arguments specified. Try the -h option to get more detailed usage help.", file=sys.stderr)
     print(file=sys.stderr)
     sys.exit(1)
 
 #----------------------------------------
 # determine the absolute path of the input configuration
 # file 
 #----------------------------------------
 
 if options.useThisProjectArea:
     absoluteInputConfigFile = options.configFile
 
     import tempfile
     absoluteOutputConfigFile = tempfile.NamedTemporaryFile(suffix = ".py").name
 
 else:
     # we have already chdird into the project area and into src/
     
     absoluteInputConfigFile = os.path.join(
         os.path.join(os.getcwd(),module),
         options.configFile)
 
 
     absoluteOutputConfigFile = os.path.join(
         os.path.join(os.getcwd(),module),
         "test_cfg_new.py")
 
 #----------------------------------------
 
 
 ###################################
 # Check out module and build it
 
 if not options.useThisProjectArea:
     print("Checking out tag '" + options.cvstag + "' of " + module)
     execCmd(" cvs -Q co -r " + options.cvstag + " " + module)
 
     execCmd("scramv1 b")
     os.chdir(module)
 
 #--------------------
 # check if the (possibly user specified) config file does exist
 # or not. Note that we can do this only AFTER the CVS checkout
 if not os.path.exists(absoluteInputConfigFile):
     print("config file " + absoluteInputConfigFile + " does not exist", file=sys.stderr)
     print(os.getcwd())
     sys.exit(1)
 #--------------------
 
 # Place file names in python config file
 print("taking config file " + absoluteInputConfigFile + " and copying to " + absoluteOutputConfigFile) 
 
 #----------------------------------------
 # append things to the config file
 #----------------------------------------
 fout = open(absoluteOutputConfigFile,"w")
 
 # first copy all the lines of the original config file
 fout.write(open(absoluteInputConfigFile).read())
 
 print("process.source.fileNames = " + str(FILES), file=fout)
 print("process.post.dataSet = cms.untracked.string('" + datasetToCheck +"')", file=fout)
 
 # replace all HLT process names by something
 # else if specified by the user
 
 if options.hlt_process_name != None:
     # ugly code ahead, may disturb some viewers...
     #
     # dump the source code of the replacing code into
     # the CMSSW python configuration file
     import inspect
 
     print("#----------------------------------------", file=fout)
     print("# replace explicit specifications of HLT process name by " + options.hlt_process_name, file=fout)
     print("#----------------------------------------", file=fout)
     print(inspect.getsource(ReplaceProcessNameOfInputTags), file=fout)
     print(file=fout)
     print("for seq in process.sequences.values():", file=fout)
     print("""    seq.visit(ReplaceProcessNameOfInputTags("HLT","%s"))""" % options.hlt_process_name, file=fout)
 
 # check for additional configuration text specified
 
 if len(options.cfg_add) > 0:
     print(file=fout)
     print("#----------------------------------------", file=fout)
 
     for line in options.cfg_add:
         print("# additional string specified on the command line", file=fout)
         print(line, file=fout)
         
     print(file=fout)
     print("#----------------------------------------", file=fout)
 
 #----------------------------------------
 # max. events to run on
 if options.num_events != None:
     print(file=fout)
     print("#----------------------------------------", file=fout)
     print("# maximum number of events specified", file=fout)
     print("#----------------------------------------", file=fout)
     print("process.maxEvents = cms.untracked.PSet( input = cms.untracked.int32(%d) )" % options.num_events, file=fout)
     print("#----------------------------------------", file=fout)
 
 #----------------------------------------
 # run on real data
 if options.isData and absoluteInputConfigFile.find("testEmDQM_cfg.py") != -1:
     print(file=fout)
     print("#----------------------------------------", file=fout)
     print("# Running on real data sample", file=fout)
     print("#----------------------------------------", file=fout)
     print("process.emdqm.isData = cms.bool(True)", file=fout) 
     print("#----------------------------------------", file=fout)
 
 #----------------------------------------
 # close config file
 fout.close()
 
 #----------------------------------------
 logfile = os.path.join(os.getcwd(),"log")
 
 if os.path.exists(logfile):
     print("the log file (" + logfile + ") exists already, this might causing problems", file=sys.stderr)
     print("with your shell. Stopping here.", file=sys.stderr)
     sys.exit(1)
 
 
 print("Starting cmsRun " + absoluteOutputConfigFile + " >& " + logfile)
 
 cmd = "eval `scramv1 runtime -sh` && cmsRun " + absoluteOutputConfigFile
 
 if options.followCmsRunoutput:
     cmd += " 2>&1 | tee " + logfile
 else:
     cmd += " >& " + logfile
 execCmd(cmd )
 
 # check whether the expected output file was created
 # and rename it 
 
 if os.path.exists(outputRootFile):
 
     if sampleSpec != None:
         # a sample (e.g. wen or zee etc.) was specified
 
         renameOutputTo=knownDatasets[sampleSpec]['output'] % { "version" : version }
 
         shutil.move(outputRootFile, renameOutputTo)
         print("Created")
         print("  ",os.getcwd() + "/" + renameOutputTo)
     else:
         print("Created")
         print("  ",os.getcwd() + "/" + outputRootFile)
 
 else: 
 
     print("cmsRun failed to create " + outputRootFile)
     print("See log file:")
     print("   ",os.getcwd() + "/log")
     

This page was automatically generated by the 2.2.1 LXR engine. The LXR team