MixingModule_Full2Fast.py

Go to the documentation of this file.

#####################################
# customisation functions that allow to convert a FullSim PU cfg into a FastSim one
# main functions: prepareGenMixing and prepareDigiRecoMixing
# author: Lukas Vanelderen
# date:   Jan 21 2015
#####################################

import FWCore.ParameterSet.Config as cms

def get_VertexGeneratorPSet_PileUpProducer(process):

    # container for vertex parameters
    vertexParameters = cms.PSet()

    # find the standard vertex generator
    if not hasattr(process,"VtxSmeared"):
        "WARNING: no vtx smearing applied (ok for steps other than SIM)"
        return vertexParameters
    vertexGenerator = process.VtxSmeared

    # check the type of the standard vertex generator
    vertexGeneratorType = vertexGenerator.type_().replace("EvtVtxGenerator","")
    vtxGenMap = {"Betafunc":"BetaFunc","Flat":"Flat","Gauss":"Gaussian"}
    if not vertexGeneratorType in vtxGenMap.keys():
        raise Error("WARNING: given vertex generator type for vertex smearing is not supported")
    vertexParameters.type = cms.string(vtxGenMap[vertexGeneratorType])
    
    # set vertex generator parameters in PileUpProducer
    vertexGeneratorParameterNames = vertexGenerator.parameterNames_()
    for name in vertexGeneratorParameterNames:
        exec("vertexParameters.{0} = {1}".format(name,getattr(vertexGenerator,name).dumpPython()))

    return vertexParameters

def get_PileUpSimulatorPSet_PileUpProducer(_input):

    # container for PileUpSimulator parameters
    PileUpSimulator = cms.PSet()

    # Extract the type of pu distribution
    _type = "none"
    if hasattr(_input,"type"):
        _type = _input.type

    if _type == "poisson":
        if not hasattr(_input.nbPileupEvents,"averageNumber"):
            print "  ERROR while reading PU distribution for FastSim PileUpProducer:"
            print "  when process.mix.input.type is set to 'poisson', process.mix.input.nbPileupEvents.averageNumber must be specified."
            raise
        PileUpSimulator.averageNumber = _input.nbPileupEvents.averageNumber
        PileUpSimulator.usePoisson = cms.bool(True)

    elif _type == "probFunction":
        if not hasattr(_input.nbPileupEvents,"probFunctionVariable") or not hasattr(_input.nbPileupEvents,"probValue"):
            print "  ERROR while reading PU distribution for FastSim PileUpProducer:"
            print "  when process.mix.input.type is set to 'probFunction', process.mix.nbPileupEvents.probFunctionVariable and process.mix.nbPileupEvents.probValue must be specified"
            raise
        PileUpSimulator.usePoisson = cms.bool(False)
        PileUpSimulator.probFunctionVariable = _input.nbPileupEvents.probFunctionVariable
        PileUpSimulator.probValue = _input.nbPileupEvents.probValue

    elif _type != "none":
        print "  ERROR while reading PU distribution for FastSim PileUpProducer:"
        print "  value {0} for process.mix.input.type not supported by FastSim GEN-level PU mixing".format(_type)
        raise

    # minbias files
    from FastSimulation.PileUpProducer.PileUpFiles_cff import puFileNames
    PileUpSimulator.fileNames = puFileNames.fileNames
    
    # a purely technical, but required, setting
    PileUpSimulator.inputFile = cms.untracked.string('PileUpInputFile.txt')

    return PileUpSimulator


def digitizersFull2Fast(digitizers):

    # fastsim does not simulate castor
    if hasattr(digitizers,"castor"):
        delattr(digitizers,"castor")
    else:
        print "WARNING: digitizers has no attribute 'castor'"
        
    # fastsim does not digitize pixel and strip hits, it mixes tracks
    if hasattr(digitizers,"pixel") and hasattr(digitizers,"strip"):
        delattr(digitizers,"pixel")
        delattr(digitizers,"strip")
        import FastSimulation.Tracking.recoTrackAccumulator_cfi
        digitizers.tracker = cms.PSet(FastSimulation.Tracking.recoTrackAccumulator_cfi.recoTrackAccumulator)
    else:
        print "WARNING: digitizers has no attribute 'pixel' and/or 'strip'"
        print "       : => not mixing tracks"

    # fastsim has its own names for simhit collections
    for element in ["ecal","hcal"]:
        if hasattr(digitizers,element):
            getattr(digitizers,element).hitsProducer = "famosSimHits"
        else:
            print "WARNING: digitizers has no attribute '{0}'".format(element)
            
    # fastsim has different input for merged truth
    if hasattr(digitizers,"mergedtruth"):
        digitizers.mergedtruth.allowDifferentSimHitProcesses = True
        digitizers.mergedtruth.simHitCollections = cms.PSet(
            muon = cms.VInputTag( cms.InputTag('MuonSimHits','MuonDTHits'),
                                  cms.InputTag('MuonSimHits','MuonCSCHits'),
                                  cms.InputTag('MuonSimHits','MuonRPCHits') ),
            trackerAndPixel = cms.VInputTag( cms.InputTag('famosSimHits','TrackerHits') )
            )
        digitizers.mergedtruth.simTrackCollection = cms.InputTag('famosSimHits')
        digitizers.mergedtruth.simVertexCollection = cms.InputTag('famosSimHits')

    return digitizers


def prepareGenMixing(process):
    
    # prepare digitizers and mixObjects for Gen-mixing
    process = prepareDigiRecoMixing(process)

    # OOT PU not supported for Gen-mixing: disable it
    process.mix.maxBunch = cms.int32(0)
    process.mix.minBunch = cms.int32(0)
    
    # set the bunch spacing
    # bunch spacing matters for calorimeter calibration
    # setting the bunch spacing here, will have actually no effect,
    # but leads to consistency with the bunch spacing as hard coded in
    # FastSimulation/PileUpProducer/plugins/PileUpProducer.cc
    # where it is propagated to the pileUpInfo, from which calorimeter calibration reads the bunch spacing
    process.mix.bunchspace = 450

    # define the PileUpProducer module
    process.famosPileUp = cms.EDProducer(
        "PileUpProducer",
        PileUpSimulator = cms.PSet(),
        VertexGenerator = cms.PSet()
        )

    # get the pu vertex distribution
    process.famosPileUp.VertexGenerator = get_VertexGeneratorPSet_PileUpProducer(process)


    # get pu distribution from MixingModule
    process.famosPileUp.PileUpSimulator = get_PileUpSimulatorPSet_PileUpProducer(process.mix.input)     

    # MixingModule only used for digitization, no need for input
    del process.mix.input

    # Insert the PileUpProducer in the simulation sequence
    pos = process.psim.index(process.famosSimHits)
    process.psim.insert(pos,process.famosPileUp)

    # No track mixing when Gen-mixing
    del process.mix.digitizers.tracker
    del process.mix.mixObjects.mixRecoTracks
    del process.generalTracks
    process.generalTracks = process.generalTracksBeforeMixing.clone()
    process.iterTracking.replace(process.generalTracksBeforeMixing,process.generalTracks)
    del process.generalTracksBeforeMixing

    # Use generalTracks where DIGI-RECO mixing requires preMixTracks
    process.generalConversionTrackProducer.TrackProducer = cms.string('generalTracks')
    process.generalConversionTrackProducerTmp.TrackProducer = cms.string('generalTracks')
    process.trackerDrivenElectronSeedsTmp.TkColList = cms.VInputTag(cms.InputTag("generalTracks"))
    process.trackerDrivenElectronSeeds.oldTrackCollection = "generalTracks"

    # take care of the track aliases for HLT
    
    _parameters = {
        "generalTracks":cms.VPSet( cms.PSet(type=cms.string('recoTracks')),
                                   cms.PSet(type=cms.string('recoTrackExtras')),
                                   cms.PSet(type=cms.string('TrackingRecHitsOwned')),
                                   cms.PSet(type=cms.string('floatedmValueMap')))
        }
    process.hltIter4HighPtMerged = cms.EDAlias(**_parameters)
    process.hltIter2HighPtMerged = cms.EDAlias(**_parameters)
    process.hltIter4Merged = cms.EDAlias(**_parameters)
    process.hltIter2Merged = cms.EDAlias(**_parameters)
    process.hltIter4Tau3MuMerged = cms.EDAlias(**_parameters)
    process.hltIter4MergedReg = cms.EDAlias(**_parameters)
    process.hltIter2MergedForElectrons = cms.EDAlias(**_parameters)
    process.hltIter2MergedForPhotons = cms.EDAlias(**_parameters)
    process.hltIter2L3MuonMerged = cms.EDAlias(**_parameters)
    process.hltIter2L3MuonMergedReg = cms.EDAlias(**_parameters)
    process.hltIter2MergedForBTag = cms.EDAlias(**_parameters)
    process.hltIter2MergedForTau = cms.EDAlias(**_parameters)
    process.hltIter4MergedForTau = cms.EDAlias(**_parameters)
    process.hltIter2GlbTrkMuonMerged = cms.EDAlias(**_parameters)
    process.hltIter2HighPtTkMuMerged  = cms.EDAlias(**_parameters)
    process.hltIter2HighPtTkMuIsoMerged  = cms.EDAlias(**_parameters)
    process.hltIter2DisplacedJpsiMerged     = cms.EDAlias(**_parameters)
    process.hltIter2DisplacedPsiPrimeMerged = cms.EDAlias(**_parameters)
    process.hltIter2DisplacedNRMuMuMerged   = cms.EDAlias(**_parameters)
    process.hltIter0PFlowTrackSelectionHighPurityForBTag = cms.EDAlias(**_parameters)
    process.hltIter4MergedWithIter012DisplacedJets = cms.EDAlias(**_parameters)

    # PileUp info must be read from PileUpProducer, rather than from MixingModule
    process.addPileupInfo.PileupMixingLabel = cms.InputTag("famosPileUp")
    
    return process

def prepareDigiRecoMixing(process):

    # switch to FastSim digitizers
    process.mix.digitizers = digitizersFull2Fast(process.mix.digitizers)

    # switch to FastSim mixObjects
    import FastSimulation.Configuration.mixObjects_cfi
    process.mix.mixObjects = FastSimulation.Configuration.mixObjects_cfi.theMixObjects

    # fastsim does not simulate castor
    # fastsim does not digitize pixel and strip hits
    for element in ["simCastorDigis","simSiPixelDigis","simSiStripDigis"]:
        if hasattr(process,element):
            delattr(process,element)
    
    # get rid of some FullSim specific psets that work confusing when dumping FastSim cfgs 
    # (this is optional)
    del process.theDigitizers
    del process.theDigitizersValid    
    del process.trackingParticles
    del process.stripDigitizer
    del process.SiStripSimBlock
    del process.castorDigitizer
    del process.pixelDigitizer
    del process.ecalDigitizer
    
    # get rid of FullSim specific services that work confusing when dumping FastSim cfgs
    # (this is optional)
    del process.siStripGainSimESProducer

    return process