python.OverlayMetadata Namespace Reference

Functions
def	_getFileMD (filenames)
def	validateGeometryTag (logger, target, value)
def	overlayInputMetadataCheck (flags, simDict, tagInfoDict)
def	simulationMetadataCheck (sigdict, pudict)
def	tagInfoMetadataCheck (sigdict, pudict)
def	overlayMetadataCheck (flags)
def	fastChainOverlayMetadataCheck (flags)
def	writeOverlayDigitizationMetadata (flags, pileupDict)

Variables
	logger
	_fileMetadata

Function Documentation

_getFileMD()

def python.OverlayMetadata._getFileMD (   filenames )

private

Definition at line 13 of file OverlayMetadata.py.

def _getFileMD(filenames):
    if type(filenames) is list:
        filename = filenames[0]
    else:
        filename = filenames
 
    if filename not in _fileMetadata:
        logger.info("Obtaining full metadata of %s", filename)
 
        thisFileMD = read_metadata(filename, None, 'full')
        _fileMetadata.update(thisFileMD)
 
    return _fileMetadata[filename]
 
 

fastChainOverlayMetadataCheck()

def python.OverlayMetadata.fastChainOverlayMetadataCheck

(

flags

)

Check fastchain overlay metadata

Definition at line 229 of file OverlayMetadata.py.

def fastChainOverlayMetadataCheck(flags):
    """Check fastchain overlay metadata"""
    if flags.Overlay.DataOverlay:
        filesPileup = flags.Input.SecondaryFiles
    else:
        filesPileup = flags.Input.Files
 
    # pile-up check
    if not flags.Overlay.DataOverlay and filesPileup:
        pileupMetaDataCheck = _getFileMD(filesPileup)
        pileupDigitizationMetadata = pileupMetaDataCheck["/Digitization/Parameters"]
        pileupSimulationMetadata = pileupMetaDataCheck["/Simulation/Parameters"]
        pileupTagInfoMetadata = pileupMetaDataCheck["/TagInfo"]
 
        logger.info("Checking Presampled pile-up metadata against configuration of jobs (i.e. flags)...")
        overlayInputMetadataCheck(flags, pileupSimulationMetadata, pileupTagInfoMetadata)
        logger.info("Completed all checks against Presampled pile-up Simulation metadata.")
 
        if pileupDigitizationMetadata:
            writeOverlayDigitizationMetadata(flags,pileupDigitizationMetadata)
 
 

overlayInputMetadataCheck()

def python.OverlayMetadata.overlayInputMetadataCheck	(		flags,
			simDict,
			tagInfoDict
	)

Check the metadata for signal HITS or presampled pileup RDO file

Definition at line 45 of file OverlayMetadata.py.

def overlayInputMetadataCheck(flags, simDict, tagInfoDict):
    """Check the metadata for signal HITS or presampled pileup RDO file"""
    logger.info("Checking Overlay configuration against Signal or presampled pileup RDO metadata...")
 
    simKeys = simDict.keys()
    tagInfoKeys = tagInfoDict.keys()
 
    # Check the PhysicsList set agrees with that used in the simulation
    if "PhysicsList" in simKeys:
        if re.match(simDict["PhysicsList"], flags.Sim.PhysicsList):
            logger.debug("Overlay configuration matches Signal Simulation metadata. [Sim.PhysicsList = %s]", flags.Sim.PhysicsList)
        else:
            flags.Sim.PhysicsList = simDict["PhysicsList"]
            logger.warning("Overlay Sim.PhysicsList does not match the PhysicsList used in the Signal Simulation step! Assume the value from the Signal Simulation step is correct!")
            logger.warning("Set Sim.PhysicsList = %s", flags.Sim.PhysicsList)
    else:
        logger.error("'PhysicsList' key not found in Signal Simulation metadata!")
        raise AssertionError("Signal Simulation metadata key not found")
 
    # Check the DetDescrVersion set agrees with that used in the simulation
    if "SimLayout" in simKeys:
        if validateGeometryTag(logger, simDict["SimLayout"], flags.GeoModel.AtlasVersion):
            logger.debug("Overlay configuration matches Signal Simulation metadata. [Geomodel.AtlasVersion = %s]",
                         flags.GeoModel.AtlasVersion)
        else:
            flags.GeoModel.AtlasVersion = simDict["SimLayout"]
            logger.warning("Overlay Geomodel.AtlasVersion does not match the value used in the Signal Simulation step! Assume the value from the Signal Simulation step is correct!")
            logger.warning("Set Geomodel.AtlasVersion = %s", flags.GeoModel.AtlasVersion)
    else:
        logger.error("'SimLayout' key not found in Signal Simulation metadata!")
        raise AssertionError("Signal Simulation metadata key not found")
 
    # Check the Conditions Tag set against that used in the simulation
    if "IOVDbGlobalTag" in tagInfoKeys:
        if not re.match(tagInfoDict["IOVDbGlobalTag"], flags.IOVDb.GlobalTag):
            logger.debug("Overlay configuration: [IOVDb.GlobalTag = %s], Signal Simulation metadata: [IOVDb.GlobalTag = %s]",
                         flags.IOVDb.GlobalTag, tagInfoDict['IOVDbGlobalTag'])
    else:
        logger.error("'IOVDbGlobalTag' key not found in Signal Simulation metadata!")
        raise AssertionError("Signal Simulation metadata key not found")
 
    # Set the TRTRangeCut digitizationFlag based on what was used during the simulation.
    if "TRTRangeCut" in simKeys:
        if not re.match(simDict["TRTRangeCut"], str(flags.Sim.TRTRangeCut)):
            flags.Sim.TRTRangeCut = simDict["TRTRangeCut"]
            logger.warning("Overlay Sim.TRTRangeCut does not match the value used in the Signal Simulation step! Assume the value from the Signal Simulation step is correct!")
            logger.warning("Set Sim.TRTRangeCut = %s", flags.Sim.TRTRangeCut)
    else:
        logger.warning("'TRTRangeCut' key not found in Signal Simulation metadata!")
 
    # Check which sub-detectors were simulated
    # TODO: needed?
 
    logger.info("Completed checks of Overlay configuration against Signal Simulation metadata.")
 
 

overlayMetadataCheck()

def python.OverlayMetadata.overlayMetadataCheck

(

flags

)

Check overlay metadata

Definition at line 193 of file OverlayMetadata.py.

def overlayMetadataCheck(flags):
    """Check overlay metadata"""
    if flags.Overlay.DataOverlay:
        files = flags.Input.Files
        filesPileup = flags.Input.SecondaryFiles
    else:
        files = flags.Input.SecondaryFiles
        filesPileup = flags.Input.Files
 
    if files:
        signalMetadata = _getFileMD(files)
        signalSimulationMetadata = signalMetadata["/Simulation/Parameters"]
        signalTagInfoMetadata = signalMetadata["/TagInfo"]
        # signal check
        overlayInputMetadataCheck(flags, signalSimulationMetadata, signalTagInfoMetadata)
    else:
        # This can be the case for the FastChain with overlay 
        # It is not an error.
        logger.info("Simulation metadata check not done due to no inputs")
 
    # pile-up check
    if not flags.Overlay.DataOverlay and filesPileup:
        pileupMetaDataCheck = _getFileMD(filesPileup)
        pileupDigitizationMetadata = pileupMetaDataCheck["/Digitization/Parameters"]
        pileupSimulationMetadata = pileupMetaDataCheck["/Simulation/Parameters"]
        pileupTagInfoMetadata = pileupMetaDataCheck["/TagInfo"]
   
        logger.info("Checking Presampled pile-up metadata against Signal Simulation metadata...")
        simulationMetadataCheck(signalSimulationMetadata, pileupSimulationMetadata)
        tagInfoMetadataCheck(signalTagInfoMetadata, pileupTagInfoMetadata)
        logger.info("Completed all checks against Presampled pile-up Simulation metadata.")
 
        if pileupDigitizationMetadata:
            writeOverlayDigitizationMetadata(flags,pileupDigitizationMetadata)
 
 

simulationMetadataCheck()

def python.OverlayMetadata.simulationMetadataCheck	(		sigdict,
			pudict
	)

Check the simulation metadata for presampled pileup RDO file

Definition at line 101 of file OverlayMetadata.py.

def simulationMetadataCheck(sigdict, pudict):
    """Check the simulation metadata for presampled pileup RDO file"""
    sigkeys = sigdict.keys()
    pukeys = pudict.keys()
 
    # Loop over metadata keys which must have matching values
    warningKeys = ['G4Version']
    sigKeysToCheck = ['PhysicsList', 'SimLayout', 'MagneticField', 'hitFileMagicNumber'] + warningKeys
    for o in sigKeysToCheck:
        try:
            assert o in pukeys
        except AssertionError:
            logger.error("%s key missing from Presampled pile-up Simulation metadata!", o)
            raise AssertionError("Presampled pile-up Simulation metadata key not found")
        try:
            assert o in sigkeys
        except AssertionError:
            logger.error("%s key missing from Signal Simulation metadata!", o)
            raise AssertionError("Signal Simulation metadata key not found")
        try:
            if o == "SimLayout":  # allow last part of the simulation tag to differ
                assert validateGeometryTag(logger, sigdict[o], pudict[o])
            elif not isinstance(pudict[o], type(sigdict[o])):
                assert re.match(str(pudict[o]), str(sigdict[o]))
            else:
                if isinstance(pudict[o], str):
                    assert re.match(pudict[o], sigdict[o])
                elif isinstance(pudict[o], int):
                    assert (pudict[o] == sigdict[o])
                else:
                    assert re.match(str(pudict[o]), str(sigdict[o]))
        except AssertionError:
            if o in warningKeys:
                logger.warning("Simulation metadata mismatch! Presampled pile-up: [%s = %s] Signal: [%s = %s]", o, pudict[o], o, sigdict[o])
            else:
                logger.error("Simulation metadata mismatch! Presampled pile-up: [%s = %s] Signal: [%s = %s]", o, pudict[o], o, sigdict[o])
                raise AssertionError("Simulation metadata mismatch")
 
 

tagInfoMetadataCheck()

def python.OverlayMetadata.tagInfoMetadataCheck	(		sigdict,
			pudict
	)

Check the tag info metadata for presampled pileup RDO File

Definition at line 140 of file OverlayMetadata.py.

def tagInfoMetadataCheck(sigdict, pudict):
    """Check the tag info metadata for presampled pileup RDO File"""
    sigkeys = sigdict.keys()
    pukeys = pudict.keys()
 
    logger.debug("Signal /TagInfo ", sigdict)
    logger.debug("Pileup /TagInfo ", pudict)
 
    sigOnlyDict = dict()
    sigOnlyKeySet = set(sigkeys).difference(set(pukeys))
    logger.debug("The following keys only appear in Signal /TagInfo metadata:")
    logger.debug(sigOnlyKeySet)
    for key in sigOnlyKeySet:
        sigOnlyDict[key] = sigdict[key]
        logger.debug("  key: ", key, "value: ", sigdict[key])
        pass
    # TODO: extra
    keysToCompareSet = set(sigkeys).intersection(set(pukeys))
    logger.debug("The following keys appear in Signal and Presampled pile-up /TagInfo metadata:")
    logger.debug(keysToCompareSet)
    
    # Loop over metadata keys which must have matching values
    warningKeys = ['IOVDbGlobalTag']
    sigKeysToCheck = warningKeys
    for o in sigKeysToCheck:
        try:
            assert o in pukeys
        except AssertionError:
            logger.error("%s key missing from Presampled pile-up Simulation metadata!", o)
            raise AssertionError("Presampled pile-up Simulation metadata key not found")
        try:
            assert o in sigkeys
        except AssertionError:
            logger.error("%s key missing from Signal Simulation metadata!", o)
            raise AssertionError("Signal Simulation metadata key not found")
        try:
            if not isinstance(pudict[o], type(sigdict[o])):
                assert re.match(str(pudict[o]), str(sigdict[o]))
            else:
                if isinstance(pudict[o], str):
                    assert re.match(pudict[o], sigdict[o])
                elif isinstance(pudict[o], int):
                    assert (pudict[o] == sigdict[o])
                else:
                    assert re.match(str(pudict[o]), str(sigdict[o]))
        except AssertionError:
            if o in warningKeys:
                logger.warning("Simulation metadata mismatch! Presampled pile-up: [%s = %s] Signal: [%s = %s]", o, pudict[o], o, sigdict[o])
            else:
                logger.error("Simulation metadata mismatch! Presampled pile-up: [%s = %s] Signal: [%s = %s]", o, pudict[o], o, sigdict[o])
                raise AssertionError("Simulation metadata mismatch")
 
 

validateGeometryTag()

def python.OverlayMetadata.validateGeometryTag	(		logger,
			target,
			value
	)

Validate geometry tag so it is the same as target

Definition at line 28 of file OverlayMetadata.py.

def validateGeometryTag(logger, target, value):
    """Validate geometry tag so it is the same as target"""
    target_layout = target.split('-')
    value_layout = value.split('-')
    if len(target_layout) != len(value_layout):
        return False
 
    for p, s in zip(target_layout[:-1], value_layout[:-1]):
        if not re.match(p, s):
            return False
 
    if not re.match(target_layout[-1], value_layout[-1]):
        logger.warning("Simulation geometry tag mismatch! %s vs %s", target, value)
    
    return True
 
 

writeOverlayDigitizationMetadata()

def python.OverlayMetadata.writeOverlayDigitizationMetadata	(		flags,
			pileupDict
	)

Definition at line 251 of file OverlayMetadata.py.

def writeOverlayDigitizationMetadata(flags,pileupDict):
    from IOVDbMetaDataTools import ParameterDbFiller
    dbFiller = ParameterDbFiller.ParameterDbFiller()
    runNumber = flags.Input.RunNumbers[0]
    runNumberEnd = flags.Input.RunNumbers[-1]
    if runNumberEnd == runNumber:
        runNumberEnd += 1
    logger.debug('ParameterDbFiller BeginRun = %s', str(runNumber) )
    dbFiller.setBeginRun(runNumber)
    logger.debug('ParameterDbFiller EndRun   = %s', str(runNumberEnd) )
    dbFiller.setEndRun(runNumberEnd)
 
    logger.info('Filling Digitization MetaData')
 
    # Copy over pileup dictionary
    for key in pileupDict:
        value = str(pileupDict[key])
        logger.info('DigitizationMetaData: setting "%s" to be %s', key, value)
        if key in ["BeamIntensityPattern"]:
            dbFiller.addDigitParam64(key, value)
        else:
            dbFiller.addDigitParam(key, value)
 
    # Make the MetaData Db
    dbFiller.genDigitDb()

Variable Documentation

_fileMetadata

python.OverlayMetadata._fileMetadata

private

Definition at line 11 of file OverlayMetadata.py.

logger

python.OverlayMetadata.logger

Definition at line 8 of file OverlayMetadata.py.