Configuration/StandardSequences/doc/Sequences.doc - master - githubmirror/cmssw

Configuration/StandardSequences/doc/Sequences.doc
160 строк14 KB
Giulio Eulisse
Snapshot of CMSSW_6_2_0_pre8.
26 июн 2013, 18:12
26 июн 2013, 18:12214ab73

/*!

\page Software_StandardSequences Package Configuration/StandardSequences


<center>
<small>

<!-- @CVS_TAG@ will be substituted at build time, no need to touch -->
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/Configuration/StandardSequences/?cvsroot=CMSSW&only_with_tag=@CVS_TAG@>Source code (CVS tag: @CVS_TAG@)</a> - 
<a href=http://cmsdoc.cern.ch/swdev/viewcvs/viewcvs.cgi/CMSSW/Configuration/StandardSequences/.admin/developers?rev=HEAD&cvsroot=CMSSW&content-type=text/vnd.viewcvs-markup>Administrative privileges</a>
</small>
</center>


\section desc Configuration/StandardSequences 
This package contains the standard configuration fragments (*_cff.py) for most common use cases and options.

\section files Standard Configuration Fragments

\subsection gen Generator Sequences
<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/Generator_cff.py"> Generator_cff.py</a> is 
the default configuration fragment for CMSSW Event Generation and Generator-level analysis tools.
Consists of the following:

- <b> pgen = cms.Sequence(cms.SequencePlaceholder("randomEngineStateProducer")+VertexSmearing+GeneInfo+genJetMET) </b>
 - Includes modeling of the IR spread. Also includes extraction and separate storage of the 
   generator's particles, event weights and event scale. In addition, it includes construction 
   of jets and MET from generator-level particles.
   Specifically, this sequence is composed of 3 (sub)sequences:
  - <b> VertexSmearing </b> (see detailed information below, in the Additional Files)
  - <b> GeneInfo </b> which in its turn involves underlaying components: 
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PhysicsTools/HepMCCandAlgos/python/genParticles_cfi.py">genParticles</a>,
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PhysicsTools/HepMCCandAlgos/python/genEventWeight_cfi.py">genEventWeight</a>,
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PhysicsTools/HepMCCandAlgos/python/genEventScale_cfi.py">genEventScale</a>
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/PhysicsTools/HepMCCandAlgos/python/genEventPdfInfo_cfi.py">genEventPdfInfo</a>
  - <b> genJetMET </b> which in turn involves the following: 
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoJets/Configuration/python/GenJetParticles_cff.py">genJetParticles</a>,
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoJets/Configuration/python/RecoGenJets_cff.py">recoGenJets</a>,
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoMET/Configuration/python/GenMETParticles_cff.py">genMETParticles</a>,
    <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoMET/Configuration/python/RecoGenMET_cff.py">recoGenMET</a>

\subsection sim Simulation Sequences

<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/Simulation_cff.py"> Simulation_cff.py</a> is 
the default configuration fragment for CMSSW Simulation. Requires setup of random seeds for all components
 in play (see below). Consists of the following:

- <b> simulation = cms.Sequence(psim*pdigi)</b>
- <b> psim = cms.Sequence(cms.SequencePlaceholder("randomEngineStateProducer")* <a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideSimulation#SimDefSeq">g4SimHits</a>) </b>
 - Includes full-scale Geant4-based simulation of particles passage through CMS detector, in the presence of the magnetic field. 
   CMS detector description and magnetic field record are included in the configuration together with the simulation module 
   (<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/SimG4Core/Configuration/python/SimG4Core_cff.py">SimG4Core/Configuration/python/SimG4Core_cff.py</a>)
- <b> pdigi = cms.Sequence(cms.SequencePlaceholder("randomEngineStateProducer")*cms.SequencePlaceholder("mix")*doAllDigi*trackingParticles)</b>
 - Includes modeling of pileup (see details below), detector electronics responce for all detector subsystems, and
   association of generator particles and vertices with Geant4-simulated tracks and vertices.
   Specifically, modeling of detector electronics response is composed of 3 (sub)sequences:
 - <b> doAllDigi = cms.Sequence(<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideSimulation#DigiDefSeq">trDigi</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideSimulation#DigiDefSeq">calDigi</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideSimulation#DigiDefSeq">muonDigi</a>) </b>
  - Includes digitization of Tracker Pixels and Tracker Strips (<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/SimTracker/Configuration/python/SimTracker_cff.py">SimTracker/Configuration/python/SimTracker_cff.py</a>), 
    of the ECAL Barrel and EndCap, HCAL HB, HE, HO (<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/SimCalorimetry/Configuration/python/SimCalorimetry_cff.py">SimCalorimetry/Configuration/python/SimCalorimetry_cff.py</a>), and
    of the Muon DT, CSC and RPC (<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/SimMuon/Configuration/python/SimMuon_cff.py">SimMuon/Configuration/python/SimMuon_cff.py</a>). All included configuration fragments
    contain required geometry setup for a given detector subsystem.

\subsection seq1 Reconstruction Sequences

<a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/Reconstruction_cff.py"> Reconstruction_cff.py</a> is
the default configuration fragment for CMSSW Reconstruction. Changes with time and is defined looking at the various needs wrt algorithms, 
space on disk, time available for reconstruction. 
At the moment, the standard \b reconstruction sequence is composed of (please note that at least the distinction between 
global/highlevel reconstruction does not really reflect functional aspects):
- <b> localreco </b> \ref localreco "More details"
- <b> globalreco </b> \ref globalreco "More details"
- <b> highlevelreco </b> \ref highlevelreco "More details"


Other options are:
- \b reconstruction_withRS = reconstruction: the default, with Road Search global tracking activated.
- \b reconstruction_plusGSF : the same as the default, with Gaussian Sum Filter global tracking activated.

\section additional Additional Files

- <b> Random Seeds</b> include: currently, seeds are given for physics events generation or read-in (source) and 
  detector simulation 
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/SimulationRandomNumberGeneratorSeeds_cff.py"> 
   SimulationRandomNumberGeneratorSeeds_cff.py</a>: seeds for source, vertex smearing, Geant4-based simulation of
   particles interactions with CMS detector materials, modeling of mixing, and modeling of electronics response 
   for all CMS detector subsystems.

- \b Vertex includes: in order to allow an easy configuration of the Vertex Smearing, 4 Configuration Fragments are provided. 
  The user is supposed to include one and only one among:
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/VtxSmearedNoSmear_cff.py">
   VtxSmearedNoSmear_cff.py</a>: disables vertex smearing. Actually, it smears, but by fractions of a micron.
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/VtxSmearedGauss_cff.py">
   VtxSmearedGauss_cff.py</a>: vertex smearing as in ORCA. On the transverse plane, 15 um gaussian smearing. Longitudinally (z), 
   5.3 cm gaussian smearing. This is the \b ADVICED option
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/VtxSmearedFlat_cff.py">
   VtxSmearedFlat_cff.py</a>: flat vertex smearing. On the transverse plane, 15 um flat smearing. Longitudinally (z), 5.3 cm flat smearing.
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/VtxSmearedBeamProfile_cff.py">
   VtxSmearedBeamProfile_cff.py</a>: vertex smearing which resembles beam profile.

- \b Mixing includes: three options are given to the user, who has to choose one and only one among:
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingNoPileUp_cff.py">
   MixingNoPileUp_cff.py</a>: no pile up at all.
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingLowLumiPileUp_cff.py">
   MixingLowLumiPileUp_cff.py</a>: piles up 5.0 events on average (Poisson statistics), in bunches from -5 to +3. 
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingHighLumiPileUp_cff.py">
   MixingHighLumiPileUp_cff.py</a>: piles up 25.0 events on average (Poisson statistics), in bunches from -5 to +3.

- \b Additional includes (for HLT/OnSel MC production) 
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/HLTtable_cff.py">
   HLTtable_cff.py</a>: High-Level Trigger table in form of paths
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingLowLumiPileUp_OnSel_cff.py">
   MixingLowLumiPileUp_OnSel_cff.py</a>: piles up 5.0 events on average (Poisson statistics), IN-TIME PU (for OnSel/HLT studies)
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingHighLumiPileUp_OnSel_cff.py">
   MixingHighLumiPileUp_OnSel_cff.py</a>: piles up 25.0 events on average (Poisson statistics), IN-TIME PU (for OnSel/HLT studies)
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/MixingStartUpLumiPileUp_OnSel_cff.py">
   MixingStartUpLumiPileUp_OnSel_cff.py</a>: piles up 2.0 events on average (Poisson statistics), IN-TIME PU (for OnSel/HLT studies)
 - <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/StandardSequences/python/StandardFragment_OnSel_cff.py">
   StandardFragment_OnSel_cff.py</a>: Configuration fragment for GEN-SIM i.e. VtxSmeared and GEANT simulation only.


<hr>

Last updated: @DATE@ K. Lassila-Perini



*/
/*!

\page Software_StandardSequencesMore Package Configuration/StandardSequences - more details

\section localreco Local reconstruction sequences

- <b> localreco = cms.Sequence(<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideTrackReco#DefSeq">trackerlocalreco</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideMuonSystemReco#DefSeq">muonlocalreco</a>+calolocalreco)</b>
 - Local reconstruction simulation-compatible (no frontier, no oracle) for all the subdetectors. 
 - \b trackerlocalreco is defined in <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoLocalTracker/Configuration/python/RecoLocalTracker_cff.py">RecoLocalTracker/Configuration/python/RecoLocalTracker_cff.py</a> and includes
   - <b> trackerlocalreco = cms.Sequence(pixeltrackerlocalreco*striptrackerlocalreco)</b>
   - <b> pixeltrackerlocalreco = cms.Sequence(siPixelClusters*siPixelRecHits)</b>
   - <b> striptrackerlocalreco = cms.Sequence(siStripZeroSuppression*siStripClusters*siStripMatchedRecHits)</b>
 - \b muonlocalreco is defined in <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoLocalMuon/Configuration/python/RecoLocalMuon_cff.py">RecoLocalMuon/Configuration/python/RecoLocalMuon_cff.py</a> and includes 
   - <b> muonlocalreco = cms.Sequence(dtlocalreco+csclocalreco+rpcRecHits)</b>
 - \b calolocalreco is defined in <a href="http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/RecoLocalCalo/Configuration/python/RecoLocalCalo_cff.py">RecoLocalCalo/Configuration/python/RecoLocalCalo_cff.py</a> and includes
   - <b> calolocalreco = cms.Sequence(<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideEcalReco#DefSeq">ecalLocalRecoSequence</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideHcalReco#DefSeq">hcalLocalRecoSequence</a>) </b>

\section globalreco Global reconstruction sequences

- <b> globalreco = cms.Sequence(offlineBeamSpot+recopixelvertexing*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideTrackReco#DefSeq">ckftracks</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideEcalReco#DefSeq">ecalClusters</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideHcalReco#DefSeq">caloTowersRec</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideJetMet#DefSeq">recoJets</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideJetMet#DefSeq">metreco</a>+<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideMuons#DefSeq">muonreco_plus_isolation</a>)</b>
 - Global reconstruction is the reconstruction within only one subdetector. The standard sequence include only 
   CKF Global Tracking, Muon Reconstruction (STA Muons and Mu+Tk Muons), ECAL Clusterization (Island+Hybrid), 
   Calorimetric Towers, Reconstructed Jets (MidPoint+KT) and Missing ET.

\section highlevelreco High level reconstruction sequences
 
<b> highlevelreco = cms.Sequence(<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideVertexReco#DefSeq">vertexreco</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideJetMet#DefSeq">recoJetAssociations</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideBTagging#DefSeq">btagging</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideVertexReco#DefSeq">tautagging</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideEgamma#DefSeq">egammarecoFull</a>*<a href="https://twiki.cern.ch/twiki/bin/view/CMS/SWGuideParticleFlow#DefSeq">particleFlowReco*recoPFJets*PFTau</a>)</b>
 - High Level reconstruction. With the caveat as in the previous paragraph, this sequence considers modules which need 
   information from more than a subdetector. The current sequence includes tracking and vertexing with only pixels, 
   vertexing with full tracking, b tagging with track counting, and tau tagging with cone isolation.

*/