CorrelationMatrixHelpers Namespace Reference

Classes
class	CorrMat4D

Functions
def	DrawLabels (hist, jetDefString, scenarioString, drawATLASLabel, labelName)
def	DrawLabelsGuessScenario (histo)
def	saveHists4D (canvas, plotFileName, hist, oneSidedAxis, fixedX, fixedY, fixedStr, scenarioLabel="", drawATLASLabel=True, additionalString="")
def	getFixedValuesFromName (histName)
def	getFixedValuesFromFile (inFile, jetDef)
def	getFixedValuesFromFiles (inFiles, jetDef)
def	relativeMetric (numerator, denominator)
def	buildAndFillHists4DFromFiles (inFiles, jetDef, varString, fixedString, fixedX, fixedY, filterStartString="", granularityFactor=1, relativeMetric=False)
def	buildAndFillHists4DFromFile (inFile, jetDef, varString, fixedString, fixedX, fixedY, excludeStartString="", granularityFactor=1, relativeMetric=False)
def	buildAndFillHists4DFromDifferenceHists (hists, relativeMetric=False)
def	buildAndFillHist4DFromMinOfSet (hists, relativeMetric=False)
def	buildAndFillHist4DFromMaxOfSet (hists, relativeMetric=False)
def	buildAndFillHists4DFromEnvelopeOfSet (hists, relativeMetric=False)
def	buildAndFillHist4DFromCoverageOfSet (minDiffFromNominal, maxDiffBetweenScenarios, plotStyle, nominalHist=None, relativeMetric=False)

Function Documentation

buildAndFillHist4DFromCoverageOfSet()

def CorrelationMatrixHelpers.buildAndFillHist4DFromCoverageOfSet	(		minDiffFromNominal,
			maxDiffBetweenScenarios,
			plotStyle,
			nominalHist = None,
			relativeMetric = False
	)

Definition at line 781 of file CorrelationMatrixHelpers.py.

def buildAndFillHist4DFromCoverageOfSet(minDiffFromNominal,maxDiffBetweenScenarios,plotStyle,nominalHist=None,relativeMetric=False):
    coverageHist = CorrMat4D(relativeMetric)
    coverageHist.setInfoCopy(minDiffFromNominal,"coverage_type%d"%(plotStyle))
    
    if not coverageHist.fillHist4DFromCoverageOfSet(minDiffFromNominal,maxDiffBetweenScenarios,plotStyle,nominalHist):
        return None
    return coverageHist
 
 

buildAndFillHist4DFromMaxOfSet()

def CorrelationMatrixHelpers.buildAndFillHist4DFromMaxOfSet	(		hists,
			relativeMetric = False
	)

Definition at line 757 of file CorrelationMatrixHelpers.py.

def buildAndFillHist4DFromMaxOfSet(hists,relativeMetric=False):
    # Ensure the histogram(s) exist
    if not hists or len(hists) == 0:
        print "Argument is None or empty list: ",hists
        return None
    
    maxHist = CorrMat4D(relativeMetric)
    maxHist.setInfoCopy(hists[0],"maxDiff_%dinputs"%(len(hists)))
    if not maxHist.fillHist4DFromMaxOfSet(hists):
        return None
    return maxHist
 

buildAndFillHist4DFromMinOfSet()

def CorrelationMatrixHelpers.buildAndFillHist4DFromMinOfSet	(		hists,
			relativeMetric = False
	)

Definition at line 745 of file CorrelationMatrixHelpers.py.

def buildAndFillHist4DFromMinOfSet(hists,relativeMetric=False):
    # Ensure the histogram(s) exist
    if not hists or len(hists) == 0:
        print "Argument is None or empty list: ",hists
        return None
    
    minHist = CorrMat4D(relativeMetric)
    minHist.setInfoCopy(hists[0],"minDiff_%dinputs"%(len(hists)))
    if not minHist.fillHist4DFromMinOfSet(hists):
        return None
    return minHist
 

buildAndFillHists4DFromDifferenceHists()

def CorrelationMatrixHelpers.buildAndFillHists4DFromDifferenceHists	(		hists,
			relativeMetric = False
	)

Definition at line 732 of file CorrelationMatrixHelpers.py.

def buildAndFillHists4DFromDifferenceHists(hists,relativeMetric=False) :
 
    # Must do all possible comparisons
    diffHists = []
    for iHist1 in range(0,len(hists)):
        for iHist2 in range(iHist1+1,len(hists)):
            hist4D = CorrMat4D(relativeMetric)
            hist4D.setInfoCopy(hists[iHist1],"diff_%s_%s"%(hists[iHist1].plotType,hists[iHist2].plotType))
            if not hist4D.fillHist4DFromDifference(hists[iHist1],hists[iHist2]):
                return None
            diffHists.append(hist4D)
    return diffHists
 

buildAndFillHists4DFromEnvelopeOfSet()

def CorrelationMatrixHelpers.buildAndFillHists4DFromEnvelopeOfSet	(		hists,
			relativeMetric = False
	)

Definition at line 769 of file CorrelationMatrixHelpers.py.

def buildAndFillHists4DFromEnvelopeOfSet(hists,relativeMetric=False):
    # Ensure the histogram(s) exist
    if not hists or len(hists) < 2:
        print "Argument is None or contains less than two histograms: ",hists
        return None
 
    envelopeHist = CorrMat4D(relativeMetric)
    envelopeHist.setInfoCopy(hists[0],"envelope_%dinputs"%(len(hists)))
    if not envelopeHist.fillHist4DFromEnvelopeOfSet(hists):
        return None
    return envelopeHist
 

buildAndFillHists4DFromFile()

def CorrelationMatrixHelpers.buildAndFillHists4DFromFile	(		inFile,
			jetDef,
			varString,
			fixedString,
			fixedX,
			fixedY,
			excludeStartString = "",
			granularityFactor = 1,
			relativeMetric = False
	)

Definition at line 696 of file CorrelationMatrixHelpers.py.

def buildAndFillHists4DFromFile(inFile,jetDef,varString,fixedString,fixedX,fixedY,excludeStartString="",granularityFactor=1,relativeMetric=False):
    try:
        iterator = iter(inFile)
    except TypeError:
        # Not iterable
        # Probably a single item
        # Nothing to do in this case
        pass
    else:
        # Iterable
        # Probably a list of files, but watch for a single string
        if isinstance(inFile,str):
            inFile = TFile.Open(inFile,"READ")
        else:
            print "Expected a string, but did not receive one: ",inFile
            print "This method is for building a set of histograms from a single file"
            return None
 
    # Get the list of starts (the string before _var*)
    startStrings = set()
    for histName in inFile.GetKeyNames():
        if excludeStartString != "" and histName.startswith(excludeStartString):
            continue
        # Find the _var and get what's in front of it
        startStrings.add(histName[:histName.find("_var")])
 
    # Now run over the scenarios
    hists4D = [CorrMat4D(relativeMetric) for aString in startStrings]
    for aString,aHist in zip(startStrings,hists4D):
        aHist.setInfo(jetDef,varString,"raw_"+aString)
        if not aHist.fillHist4DFromFile(inFile,fixedString,fixedX,fixedY,aString,granularityFactor):
            return None
 
    return hists4D
 
 

buildAndFillHists4DFromFiles()

def CorrelationMatrixHelpers.buildAndFillHists4DFromFiles	(		inFiles,
			jetDef,
			varString,
			fixedString,
			fixedX,
			fixedY,
			filterStartString = "",
			granularityFactor = 1,
			relativeMetric = False
	)

                                           #

Build-and-fill functions # #

Definition at line 670 of file CorrelationMatrixHelpers.py.

def buildAndFillHists4DFromFiles(inFiles,jetDef,varString,fixedString,fixedX,fixedY,filterStartString="",granularityFactor=1,relativeMetric=False):
    try:
        iterator = iter(inFiles)
    except TypeError:
        # Not iterable
        # Probably a single item
        inFiles = [inFiles]
    else:
        # Iterable
        # Probably a list of files, but watch for strings
        if isinstance(inFiles,str):
            inFiles = [TFile.Open(inFiles,"READ")]
        else:
            for iFile in range(0,len(inFiles)):
                if isinstance(inFiles[iFile],str):
                    inFiles[iFile] = TFile.Open(inFiles[iFile],"READ")
 
    hists4D = [CorrMat4D(relativeMetric) for aFile in inFiles]
    for aFile,aHist in zip(inFiles,hists4D):
        aHist.setInfo(jetDef,varString,"raw" if filterStartString == "" else "raw_"+ re.sub("_","",filterStartString))
        if not aHist.fillHist4DFromFile(aFile,fixedString,fixedX,fixedY,filterStartString,granularityFactor):
            return None
 
    return hists4D
 
 

DrawLabels()

def CorrelationMatrixHelpers.DrawLabels	(		hist,
			jetDefString,
			scenarioString,
			drawATLASLabel,
			labelName
	)

Definition at line 411 of file CorrelationMatrixHelpers.py.

def DrawLabels(hist,jetDefString,scenarioString,drawATLASLabel,labelName):
    if scenarioString != "":
        if drawATLASLabel:
          AtlasStyleMacro.ATLASLabel(0.10,0.845,labelName)
        jetDefLabel = ""
 
        if jetDefString.startswith("AntiKt4"):
          jetDefLabel += "anti-k_{t} #it{R} = 0.4, "
        elif jetDefString.startswith("AntiKt6"):
          jetDefLabel += "anti-k_{t} #it{R} = 0.6, "
        
        if jetDefString.endswith("LCTopo") or jetDefString.endswith("TopoLC"):
          jetDefLabel += "LCW+JES"
        elif jetDefString.endswith("EMTopo") or jetDefString.endswith("TopoEM"):
          jetDefLabel += "EM+JES"
        
        scenarioString = "{0}".format(scenarioString)
        doDrawText(0.10,0.900,jetDefLabel+" 2016")
        doDrawText(0.10,0.955,scenarioString)
    else:
        if drawATLASLabel:
          AtlasStyleMacro.ATLASLabel(0.09,0.955,labelName)
        jetDefLabel = ""
 
        if jetDefString.startswith("AntiKt4"):
          jetDefLabel += "anti-#it{k}_{t} #it{R} = 0.4, "
        elif jetDefString.startswith("AntiKt6"):
          jetDefLabel += "anti-#it{k}_{t} #it{R} = 0.6, "
        
        if jetDefString.endswith("LCTopo") or jetDefString.endswith("TopoLC"):
          jetDefLabel += "LCW+JES + #it{in situ}"
        elif jetDefString.endswith("EMTopo") or jetDefString.endswith("TopoEM"):
          jetDefLabel += "EM+JES + #it{in situ}"
        
        scenarioString = "{0}".format(scenarioString)
        doDrawText(0.50,0.955,jetDefLabel)
        doDrawText(0.09,0.900,"Data 2015, #sqrt{s} = 13 TeV")
 

DrawLabelsGuessScenario()

def CorrelationMatrixHelpers.DrawLabelsGuessScenario

(

histo

)

Definition at line 449 of file CorrelationMatrixHelpers.py.

def DrawLabelsGuessScenario(histo):
    jetDefString = histo.jetDef
    scenarioLabel = histo.hist4D.GetName().replace("4D_varpt_%s_"%(jetDefString),"").replace("4D_vareta_%s_"%(jetDefString),"").replace(".root","")
    plotType = histo.plotType
    if "_" in scenarioLabel:
      if scenarioLabel.startswith("diff_"):
          scenarioLabel = re.sub("diff_","",scenarioLabel)
          scenarioLabel = re.sub("_"," - ",scenarioLabel)
          scenarioLabel = "Correlation differences, "+scenarioLabel
      elif scenarioLabel.startswith("minDiff_"):
          scenarioLabel = re.sub("minDiff_","",scenarioLabel)
          scenarioLabel = re.sub("_",", ",scenarioLabel)
          #scenarioLabel = "Correlation differences, min[" + scenarioLabel + "]"
          scenarioLabel = "Metric 1 (minimum correlation differences)" if not histo.relativeMetric else "Metric 1' (minimum correlation differences)"
      elif scenarioLabel.startswith("maxDiff_"):
          scenarioLabel = re.sub("maxDiff_","",scenarioLabel)
          scenarioLabel = re.sub("_",", ",scenarioLabel)
          scenarioLabel = "Correlation differences, max[" + scenarioLabel + "]"
      elif scenarioLabel.startswith("coverageRaw_"):
          scenarioLabel = re.sub("coverageRaw_","",scenarioLabel)
          scenarioLabel = re.sub("_",", ",scenarioLabel)
          #scenarioLabel = "Correlation loss coverage, [" + scenarioLabel + "]"
          scenarioLabel = "Metric 2 (raw)"
      elif scenarioLabel.startswith("coverageRes_") or plotType == "Metric2" or plotType == "Metric 2":
          scenarioLabel = re.sub("coverageRes_","",scenarioLabel)
          scenarioLabel = re.sub("_",", ",scenarioLabel)
          #scenarioLabel = "Correlation loss remaining, [" + scenarioLabel + "]"
          scenarioLabel = "Metric 2 (uncovered correlation differences)" if not histo.relativeMetric else "Metric 2' (uncovered correlation differences)"
      elif scenarioLabel.startswith("uncertaintyRaw_coverageRaw"):
          #scenarioLabel = "Remaining loss not covered by correlation uncertainties"
          scenarioLabel = "Metric 3 (raw)"
      elif scenarioLabel.startswith("uncertaintyRes_coverageRes") or plotType == "Metric3" or plotType == "Metric 3":
          #scenarioLabel = "Remaining loss beyond correlation uncertainties"
          scenarioLabel = "Metric 3 (uncovered corr. diff. including uncertainties)" if not histo.relativeMetric else "Metric 3' (uncovered corr. diff. including uncertainties)"
    elif scenarioLabel=="uncenvelope":
      scenarioLabel = "Correlation uncertainties"
    else:
      scenarioNum = re.sub("JER","",re.sub("4NP","",re.sub("3NP","",scenarioLabel)))
      if len(scenarioNum) == 1:
          scenarioLabel = "Correlation difference, Rep_{full}^{JES} - Rep_{str.red}^{%s,JES}"%(scenarioNum if not (scenarioNum == "3" and "JER" in scenarioLabel) else "evdm")
      else:
          scenarioNum = "Correlation difference, full - %s"%(scenarioLabel)
    
    DrawLabels(histo.hist4D,jetDefString,"",histo.DrawATLASLabel,histo.ATLASLabelName)
    #DrawLabels(histo.hist4D,jetDefString,scenarioLabel,histo.DrawATLASLabel,histo.ATLASLabelName)
 
    sanitizedLabel= "Uncovered correlation loss" if "Metric 2" in scenarioLabel else (scenarioLabel if "Metric" not in scenarioLabel else re.sub("\‍)","",re.sub(".*\‍(","",scenarioLabel)))
    histo.hist4D.GetZaxis().SetTitle(sanitizedLabel)
    histo.hist4D.GetZaxis().SetTitleOffset(1.8)
 

getFixedValuesFromFile()

def CorrelationMatrixHelpers.getFixedValuesFromFile	(		inFile,
			jetDef
	)

Definition at line 573 of file CorrelationMatrixHelpers.py.

def getFixedValuesFromFile(inFile,jetDef):
    newfixedPt = []
    newfixedEta = []
    for histName in inFile.GetKeyNames():
        # Ensure this histogram is for the collection we want
        if not jetDef in histName:
            continue
        # Ensure this is a difference histogram
        if not histName.startswith("diff_"):
            continue
 
        fixed1,fixed2 = getFixedValuesFromName(histName)
        
        if fixed1 != "" and fixed2 != "":
            if fixed1.startswith("pt") and fixed2.startswith("pt"):
                newfixedPt.append([float(fixed1.replace("pt","",1)),float(fixed2.replace("pt","",1))])
            elif fixed1.startswith("eta") and fixed2.startswith("eta"):
                newfixedEta.append([float(fixed1.replace("eta","",1)),float(fixed2.replace("eta","",1))])
            else:
                print "ERROR: Unexpected mixture of fixed variables for histogram:",histName
                sys.exit(-1)
        else:
            print "ERROR: Failed to parse histogram name for fixed values:",histName
            sys.exit(-2)
 
 
    return newfixedPt,newfixedEta
 
 

getFixedValuesFromFiles()

def CorrelationMatrixHelpers.getFixedValuesFromFiles	(		inFiles,
			jetDef
	)

Definition at line 602 of file CorrelationMatrixHelpers.py.

def getFixedValuesFromFiles(inFiles,jetDef):
    # Get fixed pt and/or eta values from the first file
    newfixedPt,newfixedEta = getFixedValuesFromFile(inFiles[0],jetDef)
    newfixedPt.sort()
    newfixedEta.sort()
    
    # Ensure that subsequent file(s) match the fixed pt/eta values
    for aFile in inFiles[1:]:
        localFixedPt,localFixedEta = getFixedValuesFromFile(aFile,jetDef)
        localFixedPt.sort()
        localFixedEta.sort()
    
        # Check for equality
        # Note that these are floating point equalities, so be careful
        if len(localFixedPt) != len(newfixedPt):
            print "ERROR: File %s has %d fixed pt values, while %s has %d values"%(aFile.GetNameNoDir(),len(localFixedPt),inFiles[0],len(newfixedPt))
            sys.exit(3)
        elif len(localFixedEta) != len(newfixedEta):
            print "ERROR: File %s has %d fixed eta values, while %s has %d values"%(aFile.GetNameNoDir(),len(localFixedEta),inFiles[0],len(newfixedEta))
            sys.exit(4)
        for localVal,globalVal in zip(localFixedPt,newfixedPt):
            if fabs(localVal[0]-globalVal[0]) > 1.e-4 or fabs(localVal[1]-globalVal[1]) > 1.e-4:
                print "ERROR: File %s and %s have different fixed pt values, was comparing %f and %f"%(aFile.GetNameNoDir(),inFiles[0],localVal,globalVal)
                sys.exit(5)
        for localVal,globalVal in zip(localFixedEta,newfixedEta):
            if fabs(localVal[0]-globalVal[0]) > 1.e-4 or fabs(localVal[1]-globalVal[1]) > 1.e-4:
                print "ERROR: File %s and %s have different fixed eta values, was comparing %f and %f"%(aFile.GetNameNoDir(),inFiles[0],localVal,globalVal)
                sys.exit(6)
    
    # Files have now been confirmed to match in fixed values, assuming multiple files were specified
    # Determine the actual pT and eta values available now (not just pairs)
    newfixedPtX = set([])
    newfixedPtY = set([])
    for newfixedPtSet in newfixedPt:
        newfixedPtX.add(newfixedPtSet[0])
        newfixedPtY.add(newfixedPtSet[1])
    newfixedPtX = sorted(newfixedPtX)
    newfixedPtY = sorted(newfixedPtY)
    
    newfixedEtaX = set([])
    newfixedEtaY = set([])
    for newfixedEtaSet in newfixedEta:
        newfixedEtaX.add(newfixedEtaSet[0])
        newfixedEtaY.add(newfixedEtaSet[1])
    newfixedEtaX = sorted(newfixedEtaX)
    newfixedEtaY = sorted(newfixedEtaY)
 
    # Done, return the sorted lists of fixed values
    return newfixedPtX,newfixedPtY,newfixedEtaX,newfixedEtaY
 
 

getFixedValuesFromName()

def CorrelationMatrixHelpers.getFixedValuesFromName

(

histName

)

                                           #

Fixed value manipulation (pT and eta values) # #

Definition at line 550 of file CorrelationMatrixHelpers.py.

def getFixedValuesFromName(histName):
    # Parse the histogram name
    tokens = histName.split("_")
    fixed1 = ""
    fixed2 = ""
    for aToken in tokens:
        keep = False
        if aToken.startswith("pt"):
            keep = True
        elif aToken.startswith("eta"):
            keep = True
        
        if keep:
            if fixed1 == "":
                fixed1 = aToken
            elif fixed2 == "":
                fixed2 = aToken
            else:
                print "ERROR: More than two fixed values appear in name:",histName
                sys.exit(-1)
    return fixed1,fixed2
 
 

relativeMetric()

def CorrelationMatrixHelpers.relativeMetric	(		numerator,
			denominator
	)

Definition at line 653 of file CorrelationMatrixHelpers.py.

def relativeMetric(numerator,denominator):
    if fabs(denominator) < 1.e-3:
        if fabs(numerator) < 1.e-3:
            return 1
        else:
            return globalOOB
    if numerator/denominator < 0:
        print "NUM/DEN = %f/%f"%(numerator,denominator)
    return sqrt(numerator/denominator)
 

saveHists4D()

def CorrelationMatrixHelpers.saveHists4D	(		canvas,
			plotFileName,
			hist,
			oneSidedAxis,
			fixedX,
			fixedY,
			fixedStr,
			scenarioLabel = "",
			drawATLASLabel = True,
			additionalString = ""
	)

Definition at line 499 of file CorrelationMatrixHelpers.py.

def saveHists4D(canvas,plotFileName,hist,oneSidedAxis,fixedX,fixedY,fixedStr,scenarioLabel="",drawATLASLabel=True,additionalString = ""):
 
    # Check for empty inputs
    if not hist:
      pass
    elif isinstance(hist,list):
      # A list, iterate on the entries
      for aHist in hist:
          saveHists4D(canvas,plotFileName,aHist,oneSidedAxis,fixedX,fixedY,fixedStr,drawATLASLabel=drawATLASLabel,additionalString = "{0}.{1}".format(additionalString,hist.index(aHist)))
    else:
      # Not a list, save the output
      hist.DrawATLASLabel = drawATLASLabel
      SetAxisRange(hist.hist4D,oneSidedAxis,hist.OOBT,1e10)
      SetAxisLabels(hist.hist4D,fixedX,fixedY,fixedStr)
      
      if canvas.GetLogx():
          hist.hist4D.GetXaxis().SetMoreLogLabels()
      if canvas.GetLogy():
          hist.hist4D.GetYaxis().SetMoreLogLabels()
      if canvas.GetLogz():
          hist.hist4D.GetZaxis().SetMoreLogLabels()
          hist.hist4D.GetZaxis().SetLabelOffset(0.0010)
 
      if hist.relativeMetric:
          for binX in range(1,hist.hist4D.GetNbinsX()+1):
              for binY in range(1,hist.hist4D.GetNbinsY()+1):
                  if hist.hist4D.GetBinContent(binX,binY) < hist.OOBT:
                      hist.hist4D.SetBinContent(binX,binY,1.e-10)
      hist.hist4D.Draw("colz")
      DrawGrid(hist.hist4D,fixedX,fixedY)
      thisMaxAll,thisMaxAvg = DetermineStatValues(hist.hist4D,fixedX,fixedY,hist.OOBT if not hist.relativeMetric else 1.e-9,1e10,not hist.relativeMetric)
      if scenarioLabel != "": DrawLabels(hist.hist4D,hist.jetDef,scenarioLabel,hist.DrawATLASLabel,hist.ATLASLabelName)
      else: DrawLabelsGuessScenario(hist)
            
      if not (plotFileName.endswith(".eps") or plotFileName.endswith(".png")):
          canvas.Print(plotFileName)
      else:
          mynewname = plotFileName.replace(".png","-{0}-maxAll{1}-maxAvg{2}.png".format(additionalString,int(fabs(thisMaxAll*100)),int(fabs(thisMaxAvg*100))))
          mynewname = mynewname.replace(".eps","-{0}-maxAll{1}-maxAvg{2}.eps".format(additionalString, int(fabs(thisMaxAll*100)),int(fabs(thisMaxAvg*100))))
          canvas.Print(mynewname)
          hist.iEPS += 1
        #canvas.Print(getPlotFileName(plotFileName))