SWGuideDataFormatTable < CMSPublic

CMSPublic Web>SWGuide>SWGuideDataFormatTable (2012-11-26, TaiSakuma) (raw view)

---+!! Data Format Tables for the Offline Guide
%COMPLETE4%
%TOC{title="Contents"}%

<!--
   * Set REL=3_6_0
-->

This is a page to document the data formats in the Offline Guide. This page has replaced the information in the Reference Manual for [[http://cmsdoc.cern.ch/Releases/CMSSW/latest_nightly/doc/html/RecoData.html][RECO]] and [[http://cmsdoc.cern.ch/Releases/CMSSW/latest_nightly/doc/html/AodData.html][AOD]]

---+++ Separate !RECO, !AOD and SIM tables

The tables can be found in the following two pages:
   * SWGuideRecoDataTable for !RECO (including !AOD)
   * SWGuideAodDataTable for !AOD 
   * SWGuideSimDataTable for SIM in RECOSIM and AODSIM (in construction)

 
---+++ Data Format pages
<!--STARTDFSources-->
The full table is put together from separate pages corresponding to [[http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/EventContent/python/EventContent_cff.py?revision=HEAD&view=markup][EventContent_cff.py]].  These pages are for !RECO and !AOD
   * SWGuideDataFormatRecoTracker, responsible Giuseppe Cerati, Giovanni Petrucciani
   * SWGuideDataFormatRecoLocalTracker, responsible  Urs Langenegger, Hella Snoek (!PixelTracker), Michael Segala, Rebeca Gonzalez (!StripTracker)
   * SWGuideDataFormatRecoLocalCalo, responsible ?
   * SWGuideDataFormatRecoEcal, responsible Stefano Argiro
   * SWGuideDataFormatRecoEgamma, responsible Matteo Sani
   * SWGuideDataFormatRecoLocalMuon, responsible Tim Cox (CSC), Mario Pelliccioni (DT), Camilo Carrillo (RPC)
   * SWGuideDataFormatRecoMuon, responsible Vyacheslav Krutelyov
   * SWGuideDataFormatRecoJets, responsible Roman Kogler
   * SWGuideDataFormatRecoMET, responsible Tai Sakuma
   * SWGuideDataFormatRecoBTag, responsible Tommaso Boccali
   * SWGuideDataFormatRecoTauTag, responsible Simone Gennai, Evan Friis
   * SWGuideDataFormatRecoVertex, responsible ?
   * SWGuideDataFormatRecoPixelVertexing, responsible ?
   * SWGuideDataFormatHLTrigger, responsible Christos Leonidopoulos
   * SWGuideDataFormatRecoParticleFlow, responsible Colin Bernet
for SIM (new):
   * SWGuideDataFormatGeneratorInterface, responsible
   * SWGuideDataFormatSimG4Core, responsible
   * SWGuideDataFormatSimTracker, responsible
   * SWGuideDataFormatSimMuon, responsible
   * SWGuideDataFormatSimCalorimetry, responsible ... (not concerned: no RECOSIM or AODSIM)
   * SWGuideDataFormatSimGeneral, responsible ... (not concerned: no RECOSIM or AODSIM)
   * SWGuideDataFormatIOMC, responsible ... (not concerned: no RECOSIM or AODSIM)
for cosmic data (cosmics specific event constents from [[http://cmssw.cvs.cern.ch/cgi-bin/cmssw.cgi/CMSSW/Configuration/EventContent/python/EventContentCosmics_cff.py?revision=HEAD&view=markup][EventContentCosmics_cff.py]])
   * SWGuideDataFormatRecoMuonCosmics in construction
   * SWGuideDataFormatRecoLocalMuonCosmics in construction
   * SWGuideDataFormatRecoEcalCosmics  in construction
   * SWGuideDataFormatRecoLocalCaloCosmics  in construction
   * SWGuideDataFormatRecoLocalTrackerCosmics in construction
   * SWGuideDataFormatL1TriggerCosmics

<!--STOPDFSources-->
There is one-to-one correspondance
of the pages and  people responsible to keep them up-to-date. Tommaso has provided the names and I have contacted these persons on June 28th (see the original [[%ATTACHURL%/dataformatsmail.txt][mail]], the [[%ATTACHURL%/dataformatreminder1.txt][first]] and the [[%ATTACHURL%/reminder2.txt][second]] reminder, and 
the [[%ATTACHURL%/finalcheck.txt][final check]]).

%INCLUDE{"CMS/RecoContacts" pattern="(?:.*?<!--STOPSWRECOCONTACTSDF-->){0}.*?<!--STARTSWRECOCONTACTSDF-->(.*?)<!--STOPSWRECOCONTACTSDF-->.*"}%

The table should provide the necessary information to access the data. It should be clear where an entry from this table should
be added to the skeleton provided by  mkedanlzr. Together with the table, the following example is provided:


---+++ How to use the table
<!--STARTTableInstructions-->
In your analyzer, you should have the header of the data format you will access - you find this by clicking on the entry in the *Containers* column - and in you should add the corresponding entries in the !BuildFile, see WorkBookBuildFilesIntro.

Do the following in =analyze= method of your analyzer
<verbatim>
     Handle<reco::TrackCollection> tracks;
     iEvent.getByLabel("generalTracks",tracks);
     for(reco::TrackCollection::const_iterator itTrack = tracks->begin();
       itTrack != tracks->end();
       ++itTrack) {
          //  your code
   }
</verbatim>
where =reco::TrackCollection= comes from the *Containers* column and =generalTracks= from the *InputTag/Module* column in the following table.
If the data you want to access has an instance name (in parenthesis in the first column) you should use the corresponding =getByLabel= method:
<verbatim>
     Handle<reco::SuperCluster> clusters;
     iEvent.getByLabel("islandSuperClusters","islandEndcapSuperClusters", clusters);
     for(reco::SuperCluster::const_iterator itClust = clusters->begin();
       itClust != clusters->end();
       ++itClust) {
          //  your code
   }
</verbatim>
Note that for the sake of commodity, you can define the input tag name (and instance names) in the configuration file so you do not have to recompile your code
when you want to access objects of different types. This is already done for you if you use the mkedanlz script with -track option and in many tutorials in the WorkBook. The basic use of the script is explained in WorkBookWriteFrameworkModule.
<!--STOPTableInstructions-->

---+++ Instructions to complete the table

I have included some basic information based on the corresponding event content files. This is obviously very, very incomplete due to the wild cards.
Note that
   * the data formats are documented in pages listed above, and you should complete the information as in 3_1_X (in case of differences between the preivous versions see [[#DiffVersions][the note]] below)
      * follow the link to "your" page
      * start editing taking care that you add the "both !RECO and !AOD" data  and "RECO only" data in the correct parts, respectively (green and blue)
   * all the entries which you get from !AOD and !RECO when running =module dump = !EventContentAnalyzer {}= should be documented (for your convenience, these are provided in [[%ATTACHURL%/reco20x.txt][RECO output (updated for 2_0_0)]] and for an [[%ATTACHURL%/aod20x.txt][AOD output (updated for 2_0_x)]], please check that the table documents all entries in these files).
   * for *cosmics*, there are separate tables
      * find the event dump in  [[%ATTACHURL%/cosmics31X.txt][cosmics output (for 3_1_X)]]
      * if convenient, fill in to the cosmic specific pages (!SWGuideDataFormatReco*Cosmics) only the formats which differ from the standard collision running, add the link to the "standard" page (!SWGuideDataFormatReco*) for the rest
   * the first column gives the module name (the instance name in parenthesis if needed), it should be in the exact form in which it will be entered to getByLabel method (see  [[#How_to_use_the_table][the instructions above]])
   * the second column gives the collection name in the exact form in which it entered in Handle in [[#How_to_use_the_table][the instructions above]]
   * the link from the second column points to the class documentation in the reference manual, use the format given as an example, i.e. <verbatim>[[%DOXY%r=%LATEST21X%&c=Track&K={reco}][reco::TrackCollection]]</verbatim> (see [[WorkBookContributors#LinkRefMan][details]]). This points to the header which needs to be added in the analyzer. 
   * do not change the format of the table.

#DiffVersions
The different versions will be presented separately as in SWGuideDataFormatRecoBTag. 
   

---+++ The complete table
And now to the table itself. Note that table fractions are included from the pages where they are defined with INCLUDE statements.  A complete table with RECO and AOD would look like

<verbatim>
<!--STARTTitleDF-->
%TABLE{ tablewidth="100%" columnwidths="30%,30%,40%"}%
| *InputTag/Module (Instance name)* | *Containers* | *Description* | 
<!--STOPTitleDF-->
%INCLUDE{"SWGuideDataFormatRecoTracker" pattern="(?:.*?<!--STOPRecoTrackerDF-->){0}.*?<!--STARTRecoTrackerDF-->(.*?)<!--STOPRecoTrackerDF-->.*"}%
etc
</verbatim>
and it results in:

<!--STARTTitleDF-->
%TABLE{ tablewidth="100%" columnwidths="30%,30%,40%"}%
| *InputTag/Module (Instance name)* | *Containers* | *Description* | 
<!--STOPTitleDF-->
%INCLUDE{"SWGuideDataFormatRecoTracker" pattern="(?:.*?<!--STOPRecoTrackerDF-->){0}.*?<!--STARTRecoTrackerDF-->(.*?)<!--STOPRecoTrackerDF-->.*"}%
%INCLUDE{"SWGuideDataFormatTrackingTools" pattern="(?:.*?<!--STOPTrackingToolsDF-->){0}.*?<!--STARTTrackingToolsDF-->(.*?)<!--STOPTrackingToolsDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoLocalCalo" pattern="(?:.*?<!--STOPRecoLocalCaloDF-->){0}.*?<!--STARTRecoLocalCaloDF-->(.*?)<!--STOPRecoLocalCaloDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoEcal" pattern="(?:.*?<!--STOPRecoEcalDF-->){0}.*?<!--STARTRecoEcalDF-->(.*?)<!--STOPRecoEcalDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoEgamma" pattern="(?:.*?<!--STOPRecoEgammaDF-->){0}.*?<!--STARTRecoEgammaDF-->(.*?)<!--STOPRecoEgammaDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoMuon" pattern="(?:.*?<!--STOPRecoMuonDF-->){0}.*?<!--STARTRecoMuonDF-->(.*?)<!--STOPRecoMuonDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoJets" pattern="(?:.*?<!--STOPRecoJetsDF-->){0}.*?<!--STARTRecoJetsDF-->(.*?)<!--STOPRecoJetsDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoMET" pattern="(?:.*?<!--STOPRecoMETDF-->){0}.*?<!--STARTRecoMETDF-->(.*?)<!--STOPRecoMETDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoBTag" pattern="(?:.*?<!--STOPRecoBTagDF-->){0}.*?<!--STARTRecoBTagDF-->(.*?)<!--STOPRecoBTagDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoTauTag" pattern="(?:.*?<!--STOPRecoTauTagDF-->){0}.*?<!--STARTRecoTauTagDF-->(.*?)<!--STOPRecoTauTagDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoVertex" pattern="(?:.*?<!--STOPRecoVertexDF-->){0}.*?<!--STARTRecoVertexDF-->(.*?)<!--STOPRecoVertexDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoPixelVertexing" pattern="(?:.*?<!--STOPRecoPixelVertexingDF-->){0}.*?<!--STARTRecoPixelVertexingDF-->(.*?)<!--STOPRecoPixelVertexingDF-->.*"}%
%INCLUDE{"SWGuideDataFormatHLTrigger" pattern="(?:.*?<!--STOPHLTriggerDF-->){0}.*?<!--STARTHLTriggerDF-->(.*?)<!--STOPHLTriggerDF-->.*"}%
%INCLUDE{"SWGuideDataFormatRecoParticleFlow" pattern="(?:.*?<!--STOPRecoParticleFlowDF-->){0}.*?<!--STARTRecoParticleFlowDF-->(.*?)<!--STOPRecoParticleFlowDF-->.*"}%



Questions:
   * As reported by Colin, the links to the class references have some strange characters like dd/d5b and numbers in them. July 2008: This has now been solved see WorkBookContributors#LinkRefMan
   * I wanted to add a link to the default definition of the module, but got lost, i.e. where to point in cvs for !ctfWithMaterialTracks? July 2008: this is being investigated, doxygen may be able to do this with python config files.




---++!! Review Status

Main.CMSUserSupport - 24 Apr 2007: Page author

%RESPONSIBLE% Main.CMSUserSupport

Attachments

Topic attachments
I	Attachment	History	Action	Size	Date	Who
txt	aod20x.txt	r2 r1	manage	9.9 K	2008-04-21 - 14:04	CMSUserSupport
txt	cosmics31X.txt	r1	manage	14.4 K	2009-07-22 - 21:42	KatiLassilaPerini
txt	dataformatreminder1.txt	r1	manage	3.0 K	2007-07-02 - 15:12	CMSUserSupport
txt	dataformatsmail.txt	r2 r1	manage	2.0 K	2007-06-28 - 13:40	CMSUserSupport
txt	demoaod.txt	r1	manage	14.8 K	2007-07-11 - 17:08	CMSUserSupport
txt	demoreco.txt	r1	manage	23.7 K	2007-07-11 - 17:08	CMSUserSupport
txt	finalcheck.txt	r1	manage	4.9 K	2007-07-11 - 17:34	CMSUserSupport
txt	reco20x.txt	r1	manage	20.8 K	2008-04-22 - 09:18	CMSUserSupport
txt	reminder2.txt	r1	manage	3.8 K	2007-07-09 - 16:42	CMSUserSupport

Topic revision: r59 - 2012-11-26 - TaiSakuma

CMSPublic

User Support
Reference Manual

Main Areas

- Detector Reco Objects
- Tracks
- Ecal Reco
- Hcal Reco
- Muon System Reco
- Vertex Reco
- Physics Reco Objects
- Muons
- Electrons/Photons
- Jets, missing ET
- b Tagging
- Particle flow
- Tau-ID
- Analysis/Software Tools
- Physics Tools
- MC Truth Tools
- Visualization
- Trouble Shooting
- Code Performance
- Port to New Release
- CRAB
- Analysis Examples
- Higgs
- SUSY/BSM
- Electroweak
- Top
- Heavy Ions

Public webs

- Cern Search
- TWiki Search
- Google Search
CMSPublic All webs

Copyright &© 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback