CSC_DigitizationConfig.py

Go to the documentation of this file.

"""Define methods to construct configured CSC Digitization tools and algorithms
 
Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
"""
from AthenaConfiguration.ComponentAccumulator import ComponentAccumulator
from AthenaConfiguration.ComponentFactory import CompFactory
from AthenaConfiguration.Enums import ProductionStep
from OutputStreamAthenaPool.OutputStreamConfig import OutputStreamCfg
from MuonConfig.MuonGeometryConfig import MuonGeoModelCfg
from MuonConfig.MuonCondAlgConfig import CscCondDbAlgCfg
from MuonConfig.MuonByteStreamCnvTestConfig import CscDigitToCscRDOCfg
from MuonConfig.MuonCablingConfig import CSCCablingConfigCfg
from DigitizationConfig.TruthDigitizationOutputConfig import TruthDigitizationOutputCfg
from DigitizationConfig.PileUpToolsConfig import PileUpToolsCfg
from DigitizationConfig.PileUpMergeSvcConfig import PileUpMergeSvcCfg, PileUpXingFolderCfg
 
 
# The earliest and last bunch crossing times for which interactions will be sent
# to the CscDigitizationTool.
def CSC_FirstXing():
    return -375
 
 
def CSC_LastXing():
    return 175
 
 
def CSC_RangeCfg(flags, name="CSC_Range", **kwargs):
    """Return a PileUpXingFolder tool configured for CSC"""
    kwargs.setdefault("FirstXing", CSC_FirstXing())
    kwargs.setdefault("LastXing",  CSC_LastXing())
    kwargs.setdefault("CacheRefreshFrequency", 1.0)
    kwargs.setdefault("ItemList", ["CSCSimHitCollection#CSC_Hits"])
    return PileUpXingFolderCfg(flags, name, **kwargs)
 
 
def CSC_DigitizationToolCommonCfg(flags, name="CscDigitizationTool", **kwargs):
    """Return a ComponentAccumulator with configured CscDigitizationTool"""
    acc = ComponentAccumulator()
    if flags.Digitization.PileUp and not flags.Common.isOverlay:
        intervals = []
        if not flags.Digitization.DoXingByXingPileUp:
            intervals += [acc.popToolsAndMerge(CSC_RangeCfg(flags))]
            kwargs.setdefault("OnlyUseContainerName", True)
        kwargs.setdefault("PileUpMergeSvc", acc.getPrimaryAndMerge(PileUpMergeSvcCfg(flags, Intervals=intervals)).name)
    else:
        kwargs.setdefault("OnlyUseContainerName", False)
        kwargs.setdefault("PileUpMergeSvc", '')
    if flags.Digitization.DoXingByXingPileUp:
        kwargs.setdefault("FirstXing", CSC_FirstXing())
        kwargs.setdefault("LastXing",  CSC_LastXing())
    kwargs.setdefault("pedestal", 0.0)
    kwargs.setdefault("WindowLowerOffset", -25.0)
    kwargs.setdefault("WindowUpperOffset",  25.0)
    kwargs.setdefault("isPileUp", False)
    kwargs.setdefault("amplification", 0.43e5)
    kwargs.setdefault("NewDigitEDM", True)
    kwargs.setdefault("DriftVelocity", 39)
    kwargs.setdefault("ElectronEnergy", 66) # eV
 
    from MuonConfig.MuonCalibrationConfig import CscCalibToolCfg
    kwargs.setdefault("cscCalibTool", acc.popToolsAndMerge(CscCalibToolCfg(flags)))
 
    CscDigitizationTool = CompFactory.CscDigitizationTool
    acc.setPrivateTools(CscDigitizationTool(name, **kwargs))
    return acc
 
 
def CSC_DigitizationToolCfg(flags, name="CscDigitizationTool", **kwargs):
    """Return a ComponentAccumulator with configured CscDigitizationTool"""
    acc = ComponentAccumulator()
    kwargs.setdefault("InputObjectName", "CSC_Hits")
    kwargs.setdefault("OutputObjectName", "CSC_DIGITS")
    if flags.Common.ProductionStep == ProductionStep.PileUpPresampling:
        kwargs.setdefault("CSCSimDataCollectionOutputName", flags.Overlay.BkgPrefix + "CSC_SDO")
    else:
        kwargs.setdefault("CSCSimDataCollectionOutputName", "CSC_SDO")
    tool = acc.popToolsAndMerge(CSC_DigitizationToolCommonCfg(flags, name, **kwargs))
    acc.setPrivateTools(tool)
    return acc
 
 
def CSC_OverlayDigitizationToolCfg(flags, name="CscOverlayDigitizationTool", **kwargs):
    """Return a ComponentAccumulator with CscDigitizationTool configured for Overlay"""
    kwargs.setdefault("OnlyUseContainerName", False)
    kwargs.setdefault("OutputObjectName", flags.Overlay.SigPrefix + "CSC_DIGITS")
    kwargs.setdefault("CSCSimDataCollectionOutputName", flags.Overlay.SigPrefix + "CSC_SDO")
    kwargs.setdefault("PileUpMergeSvc", '')
    return CSC_DigitizationToolCommonCfg(flags, name, **kwargs)
 
 
def CSC_OutputCfg(flags):
    """Return ComponentAccumulator with Output for CSC. Not standalone."""
    acc = ComponentAccumulator()
    if flags.Output.doWriteRDO:
        ItemList = ["CscRawDataContainer#*"]
        if flags.Digitization.EnableTruth:
            ItemList += ["CscSimDataCollection#*CSC_SDO"]
            acc.merge(TruthDigitizationOutputCfg(flags))
        acc.merge(OutputStreamCfg(flags, "RDO", ItemList))
    return acc
 
 
def CSC_DigitizationBasicCfg(flags, **kwargs):
    """Return ComponentAccumulator for CSC digitization"""
    acc = MuonGeoModelCfg(flags)
    acc.merge(CscCondDbAlgCfg(flags))
    if "PileUpTools" not in kwargs:
        PileUpTools = acc.popToolsAndMerge(CSC_DigitizationToolCfg(flags))
        kwargs["PileUpTools"] = PileUpTools
    acc.merge(PileUpToolsCfg(flags, **kwargs))
    return acc
 
 
def CSC_OverlayDigitizationBasicCfg(flags, **kwargs):
    """Return ComponentAccumulator with CSC Overlay digitization"""
    acc = MuonGeoModelCfg(flags)
    acc.merge(CscCondDbAlgCfg(flags))
 
    if flags.Common.ProductionStep != ProductionStep.FastChain:
        from SGComps.SGInputLoaderConfig import SGInputLoaderCfg
        acc.merge(SGInputLoaderCfg(flags, ["CSCSimHitCollection#CSC_Hits"]))
 
    if "DigitizationTool" not in kwargs:
        tool = acc.popToolsAndMerge(CSC_OverlayDigitizationToolCfg(flags))
        kwargs["DigitizationTool"] = tool
 
    if flags.Concurrency.NumThreads > 0:
        kwargs.setdefault("Cardinality", flags.Concurrency.NumThreads)
 
    # Set common overlay extra inputs
    kwargs.setdefault("ExtraInputs", flags.Overlay.ExtraInputs)
 
    CscDigitBuilder = CompFactory.CscDigitBuilder
    acc.addEventAlgo(CscDigitBuilder(name="CscOverlayDigitBuilder", **kwargs))
    return acc
 
 
# with output defaults
def CSC_DigitizationCfg(flags, **kwargs):
    """Return ComponentAccumulator for CSC digitization and Output"""
    acc = CSC_DigitizationBasicCfg(flags, **kwargs)
    acc.merge(CSC_OutputCfg(flags))
    return acc
 
 
def CSC_DigitizationDigitToRDOCfg(flags):
    """Return ComponentAccumulator with CSC Digitization and Digit to CSCRDO"""
    acc = CSC_DigitizationCfg(flags)
    acc.merge(CSCCablingConfigCfg(flags))
    acc.merge(CscDigitToCscRDOCfg(flags))
    return acc