LArConfigFlags.py

Go to the documentation of this file.

# Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
 
from AthenaConfiguration.AthConfigFlags import AthConfigFlags
from AthenaConfiguration.Enums import FlagEnum, LHCPeriod
from AthenaCommon.Logging import logging
 
class RawChannelSource(FlagEnum):
     Input="Input"           # read from the input-file, bytestream or RDO
     Calculated="Calculated" #re-computed by the offline LArRawChannelBuilder
     Both="Both"             # overwrite the digits computed
 
 
def createLArConfigFlags():
    lcf=AthConfigFlags()
 
    lcf.addFlag("LAr.doAlign",lambda prevFlags : prevFlags.GeoModel.Layout=="atlas")
    lcf.addFlag("LAr.doHVCorr",lambda prevFlags : not prevFlags.Input.isMC)
    lcf.addFlag("LAr.doCellEmMisCalib",lambda prevFlags : prevFlags.Input.isMC)
 
    lcf.addFlag("LAr.RawChannelSource", _determineRawChannelSource, type=RawChannelSource)
 
    lcf.addFlag("LAr.doCellNoiseMasking",True)
    lcf.addFlag("LAr.doCellSporadicNoiseMasking",True)
    lcf.addFlag("LAr.doBadFebMasking",lambda prevFlags : not prevFlags.Input.isMC)
    lcf.addFlag("LAr.doDeadOTxCorr",lambda prevFlags : not prevFlags.Input.isMC and prevFlags.GeoModel.Run >= LHCPeriod.Run3)
 
    # Include MC shape folder
    lcf.addFlag("LAr.UseMCShape", True)
    # Name of sqlite file containing Electronic Calibration values
    lcf.addFlag("LAr.ElecCalibSqlite", "")
    # Load Electronic Calibration constants
    lcf.addFlag("LAr.LoadElecCalib", True)
    # Folder name for Optimal Filtering coefficients (empty means default)
    lcf.addFlag("LAr.OFCShapeFolder", "")
    # Load conditions with this `run-number' string
    lcf.addFlag("LAr.ForceIOVRunNumber", "")
    # Include Shape folder
    lcf.addFlag("LAr.UseShape", True)
    # DataBase server string
    lcf.addFlag("LAr.DBConnection", "")
 
    # Number of collisions to optimize OFC for pileup
    lcf.addFlag("LAr.ROD.NumberOfCollisions",0)
    # Number of samples in LAr digitization + ROD emulation
    lcf.addFlag("LAr.ROD.nSamples", 5)
    # Index of first sample in LAr digitization + ROD emulation
    lcf.addFlag("LAr.ROD.FirstSample", 0)
    # Number of preceeding samples (necessary for phase 2 simulation)
    lcf.addFlag("LAr.ROD.nPreceedingSamples", 0)
    # Force using the highest gain autocorrelation function
    # when doing OFC optimization
    lcf.addFlag("LAr.ROD.UseHighestGainAutoCorr", False)
    # Flag not to use pileup noise neither average constrain in EMB and EMEC-OW,
    # and both pileup noise and average constrain everywhere else
    lcf.addFlag("LAr.ROD.DoOFCMixedOptimization", False)
    
    lcf.addFlag("LAr.ROD.UseDelta", 0)
    # Force using the iterative OFC procedure
    lcf.addFlag("LAr.ROD.forceIter",False)
    # NN based energy reconstruction
    lcf.addFlag("LAr.ROD.NNRawChannelBuilding", False)
    # OFFC based energy reconstruction
    lcf.addFlag("LAr.ROD.OFFCRawChannelBuilding", False)
 
    lcf.addFlag("LAr.ROD.OFFCBelowThreshold", 3)
    lcf.addFlag("LAr.ROD.OFFCBelowTillReset", 7)
    lcf.addFlag("LAr.ROD.OFFCNPulse", 7)
    lcf.addFlag("LAr.ROD.OFFCQ3Cut", 0.1)  # relative term, on Q3/A
    lcf.addFlag("LAr.ROD.OFFCQ3Offset", 2.0)  # absolute term in ADC
    lcf.addFlag("LAr.ROD.OFFCFilterThreshold", 2.0)
 
    # Perform a minbias correct to the LArDigit energies before building the raw channels 
    # (SHOULD TURN OFF ConfigFlags.Calo.Cell.doPileupOffsetBCIDCorr to not double count)
    lcf.addFlag("LAr.ROD.ApplyRODBCIDCorr", False)
 
    # default LArRawSC container 
    lcf.addFlag("LAr.LATOME.DTInfoForL1","SC_ET_ID")
    # storing SC CaloCellContainer with bcid'ed energies
    lcf.addFlag("LAr.DT.storeET_ID",False)
    lcf.addFlag("LAr.DT.ET_IDKey","SCell")
    lcf.addFlag("LAr.DT.doSCMasking",True)
    # storing SC CaloCellContainers +-1 around bcid'ed energies
    lcf.addFlag("LAr.DT.storeET_additional",False)
    lcf.addFlag("LAr.DT.ET_PlusKey","SCellPlus")
    lcf.addFlag("LAr.DT.ET_MinusKey","SCellMinus")
 
    
    lcf.addFlag("LAr.NoisyRO.CellQuality", 4000)
    # Number of channels above quality cut
    lcf.addFlag("LAr.NoisyRO.BadChanPerFEB", 30)
    # Number of Bad FEBs per partition cut
    lcf.addFlag("LAr.NoisyRO.BadFEBCut", 5)
    # Number of channels to declare MNB-Loose
    lcf.addFlag("LAr.NoisyRO.MNBLooseCut", 5)
    # Number of channels to declare MNB-Tight
    lcf.addFlag("LAr.NoisyRO.MNBTightCut", 17)
    # Number of channels to declare MNB-Tight wir PS veto
    lcf.addFlag("LAr.NoisyRO.MNBTight_PsVetoCut", [13,3])
    # Number of noisy HVlines
    lcf.addFlag("LAr.NoisyRO.BadHVCut", 3)
    # Fraction of cells noisy on one HV line
    lcf.addFlag("LAr.NoisyRO.BadHVlineFrac", 0.25)
 
    return lcf
 
 
_lArRunInfo=None
 
def _getLArRunInfo(prevFlags):
    log = logging.getLogger('LArConfigFlags.getLArRunInfo')
    global _lArRunInfo #Cache of lar run info
    if _lArRunInfo is None:
        from LArConditionsCommon.LArRunFormat import getLArFormatForRun
        runnbr=prevFlags.Input.RunNumbers[0] #If more than one run, assume config for first run is valid for all runs
        dbStr="COOLONL_LAR/"+prevFlags.IOVDb.DatabaseInstance
        _lArRunInfo=getLArFormatForRun(run=runnbr,connstring=dbStr)
        log.info("Got LArRunInfo for run %d",runnbr)
    return _lArRunInfo
 
 
def _determineRawChannelSource(prevFlags):
    log = logging.getLogger('LArConfigFlags.determineRawChannelSource')
    if prevFlags.Input.isMC or prevFlags.Overlay.DataOverlay:
        return RawChannelSource.Input
 
    lri=_getLArRunInfo(prevFlags)
    #runType: 0=RawData, 1=RawDataResult, 2=Result
    if lri is None or lri.runType is None:
        log.warning("WARNING do not have LArRunInfo !")
        return RawChannelSource.Both
    log.info("runType %d",lri.runType())
    if (lri.runType()==0):
        return RawChannelSource.Calculated #Have only digits in bytestream
    elif (lri.runType()==1 or lri.runType()==2):
        return RawChannelSource.Both       #Have both, digits and raw-channels in bytestream
    else:
        log.warning("Unknown LAr run type %i",lri.runType())
        return RawChannelSource.Both