<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-us" lang="en-us"><head>

<link rel="stylesheet" href="help_files/style.css" type="text/css" media="all"><!-- ActionTrackerPlugin -->

<link rel="stylesheet" href="help_files/styles.css" type="text/css" media="all">
<script type="text/javascript">
  function editWindow(url) {
    win=open(url,"none","titlebar=0,width=900,height=400,resizable,scrollbars");
    if (win) {win.focus();}
    return false;
  }
</script><!-- /ActionTrackerPlugin --><title>PhysicsToolsDevFireworksOnlineHelp &lt; CMS &lt; TWiki</title>



<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-15">
<link rel="icon" href="https://twiki.cern.ch/twiki/pub/CMS/WebPreferences/favicon.ico" type="image/x-icon">
<link rel="shortcut icon" href="https://twiki.cern.ch/twiki/pub/CMS/WebPreferences/favicon.ico" type="image/x-icon">
<meta name="robots" content="noindex"><link rel="alternate" type="application/rss+xml" title="RSS Feed" href="https://twiki.cern.ch/twiki/bin/view/CMS/WebRss">
<!-- base href="https://twiki.cern.ch/twiki/bin/view/CMS/PhysicsToolsDevFireworksOnlineHelp" -->

<script type="text/javascript" src="help_files/twiki.js"></script>
<script type="text/javascript" src="help_files/pattern.js"></script>
<script type="text/javascript">
//<![CDATA[
	function launchWindow(inWeb, inTopic) {
		return launchTheWindow("/twiki/bin/view/", inWeb, inTopic, "", "viewplain" );
	}
//]]>
</script>





<style type="text/css" media="all">
	
	
</style>
<style type="text/css" media="all">
	@import url('https://twiki.cern.ch/twiki/pub/TWiki/PatternSkin/layout.css');
	@import url('https://twiki.cern.ch/twiki/pub/TWiki/PatternSkin/style.css');
	@import url('/twiki/pub/TWiki/PatternSkin/colors.css');
</style><!--[if IE]>
<style type="text/css" media="screen">
pre {
	overflow-x:auto;
	padding-bottom:expression(this.scrollWidth > this.offsetWidth ? 16 : 0);
}
</style>
<![endif]--><!--[if lte IE 6]> 
<style type="text/css">
#patternLeftBar {
	position:relative; /* IE 5.5 needs this or the contents won't show outside the parent container on print. IE 6.0 needs it only during printable copy! */
}
</style>
<![endif]-->



<style type="text/css" media="all">
	/* Styles that are set using variables */
	#patternLeftBar .patternWebIndicator,
	.patternBookView .twikiTopRow {
		background-color:#99CCFF;
	}
	#patternTopBar { background-image:url("/twiki/pub/TWiki/PatternSkin/TWiki_header.gif"); background-repeat:no-repeat;}
	#patternTopBar { background-color:#ffffff;}
	.patternBookView {
		border-color:#99CCFF;
	}
	.patternPreviewPage #patternMain {
		/* uncomment to set the preview image */
		/*background-image:url("/twiki/pub/TWiki/PreviewBackground/preview2bg.gif");*/
	}
	
	.twikiTable .tableSortIcon img {visibility:hidden;}
	.twikiTable .tableSortUp {background:url("https://twiki.cern.ch/twiki/pub/TWiki/TWikiDocGraphics/tablesortup.gif") no-repeat;}
	.twikiTable .tableSortDown {background:url("https://twiki.cern.ch/twiki/pub/TWiki/TWikiDocGraphics/tablesortdown.gif") no-repeat;}
	.twikiTable .tableSortDiamond {background:url("https://twiki.cern.ch/twiki/pub/TWiki/TWikiDocGraphics/tablesortdiamond.gif") no-repeat;}
</style>
<style type="text/css" media="all">
	@import url('https://twiki.cern.ch/twiki/pub/TWiki/PatternSkin/empty.css');
	@import url('https://twiki.cern.ch/twiki/pub/TWiki/PatternSkin/empty.css');
	
</style>


<style type="text/css" media="all">
	@import url("/twiki/pub/TWiki/PatternSkin/print.css");
</style>


<script src="help_files/timetabletooltips.js" language="javascript" type="text/javascript"></script></head><body class="patternViewPage patternPrintPage"><a name="PageTop"></a>
<div id="patternScreen">
<div id="patternPageShadow">
<div id="patternPage">
<div id="patternOuter">
<div id="patternFloatWrap">
<div id="patternMain">
<div id="patternMainContents">
<div class="twikiBeforeText"></div><div class="patternContent"><div class="patternTopic"> <h1><a name="CmsShow_Online_Help"></a><a name="_CmsShow_Online_Help"></a> CmsShow Online Help </h1>
<p>
</p><h1><a name="Invocation"></a> Invocation </h1>
<p>
CmsShow is invoked as follows:
</p><p>
</p><pre>./cmsShow.exe [options] &lt;data file&gt;</pre>
<p>
For most uses, no options are required.
<p />
Allowed options:
<pre>

  -i &#91; --input-file ] arg   Input root file
  -c &#91; --config-file ] arg  Include configuration file
  -g &#91; --geom-file ] arg    Include geometry file
  -n &#91; --noconfig ]         Don&#39;t load any configuration file
  -p &#91; --play ] arg         Start in auto playback mode with given interval
                            between events in seconds
  --port arg                Listen to port for new data files to open
  --eve                     Show Eve browser to help debug problems
  -r &#91; --root-interactive ] Enable root prompt.  
  -d &#91; --debug ]            Start the display from a debugger and producer a
                            crash report
  -s &#91; --shine ]            Use advance options to improve rendering quality
                            (anti-alias etc)
  --soft                    Try to force software rendering to avoid problems
                            with bad hardware drivers
  -h &#91; --help ]             Display help message

</pre>
<p />
<h1><a name="Viewing_an_event"></a> Viewing an event </h1>
<p>
</p><h4><a name="What_is_shown"></a><a name="What_is_shown_"></a> What is shown? </h4>
<p>
In the default configuration, CmsShow knows about the following objects:
</p><p> </p><ul>
<li> ECal energy
</li> <li> HCal energy
</li> <li> jets
</li> <li> electrons
</li> <li> muons
</li> <li> MET
</li> <li> tracks
</li> <li> primary vertices
</li> <li> DT muon segments
</li> <li> CSC muon segments
</li> <li> L1 jets
</li> <li> L1 EM objects
</li> <li> L1 muons
</li> <li> L1 MET
</li> <li> generator-level particles
</li></ul> 
<p>
Not all these objects are visible by default; see <i>Visible and invisible
items</i> below.  Each type of object has a color, which can be used to
distinguish it from other objects.  The color is the same across views; for
example, the default jet color is yellow, and jets show up in yellow in all
views.  See <i>Controlling object properties</i> to learn how to manipulate
the object properties (visibility and color).
</p><p>
</p><h4><a name="Views"></a> Views </h4>
<p>
Multiple <i>views</i> of the event are available.  
</p><p> </p><ul>
<li> <strong>Glimpse View</strong>: to give the user a "glimpse" of the
event, the glimpse view shows the high-level objects (jets, electrons,
muons, MET). The size of the object is proportional to its energy.
</li> <li> <strong>rho-phi</strong> and <strong>rho-z</strong> projections
</li> <li> <strong>3D Lego</strong>: calo towers are show as stacked
lego plots (HCal on top of ECal). This view is available in 2D (energy
proportional to tower area) or 3D (energy proportional to height). To
switch between 2D and 3D, rotate the view with the left mouse button.
The segmentation of the view adapts to the zoom (mouse wheel or right
mouse button). Also shown are MET (solid line), -MET (dashed line),
jets (circles) and muons (crosses).
</li> <li> <strong>Table views</strong>: tables containing detailed
information about physics objects, triggers and tracking are available
by clicking the tabs above the graphics view area. To sort the tables,
click on the column headers.
</li> <li> <strong>List view</strong>: the list view to the left of
the graphics view area contains a list of all objects known to the
event display. This list can be used to control which objects are
visible (see <i>Visible and invisible items</i>) and to     select objects (see <i>Selecting</i>).
</li></ul> 
<p>
To keep track of objects, two handy features are available.  Hovering over an
object with the mouse in any view makes the object light up in all other views
(as well as displaying a small information window about the object).  Clicking
on an object selects it (see <i>Selecting</i> below) in all views.
</p><p>
The view area is divided into one "big" area and multiple "small" areas; the
icon in the top left corner of each view swaps that view into the big area.  The
graphical views and tables can be "undocked" from the main CmsShow window by
clicking the "undock" icon.  This is handy if you want to see the graphical
views of the event and the detailed information in the tables side-by-side, for
example, or if you want to show several views in large windows.  
</p><p>
Some views have additional properties.  These can be changed with the <i>View
Controller</i>, which is brought up by clicking on the view title bar.
</p><p>
Views can be removed (with the icon in the top right corner of the view) or
added (through the File -&gt; New Viewer menu).
</p><p>
For some objects, more detail is available through <i>detailed views</i>.  These
detailed views can be opened by selecting an object (by clicking on it), then
pushing the "Open Detailed View" button in the Object Display Controller (for
more information about the Object Display Controller, see <i>Controlling object
properties</i>). 
</p><p>
</p><h4><a name="Controlling_object_properties"></a> Controlling object properties </h4>
<p>
Each object has two properties: color and visibility.  The user can select a
non-default color for an object, for example to identify a "special" electron in
all views.  The visibility flag is used primarily to keep low-energy objects
from cluttering the views.  Both properties are controlled by the <i>Object
Display Controller</i>.  This controller window opens the first time an object is
selected (by clicking on an object); if it is subsequently closed, it can be
re-opened from the Window -&gt; Show Object Display Controller menu.
</p><p>
</p><h4><a name="Controlling_collection_propertie"></a> Controlling collection properties </h4>
<p>
Collections have the same properties as individual objects: color and
visibility.  The collection properties can be controlled from the <i>Collection
Controller</i>.  To open this window, click a collection name in the list view or
use the Window -&gt; Show Collection Controller menu.  The collection visibility
flag is used to keep the views uncluttered by hiding some collections.
</p><p>
The Collection Controller can also filter and select items in a collection.
(For example, it can make all jets with Et &lt; 15 GeV invisible.)  See <i>Filtering</i>
and <i>Selecting</i> below.
</p><p>
</p><h4><a name="Filtering"></a> Filtering </h4>
<p>
To limit clutter in the views, it may be desirable to make low-energy objects
invisible.  "Filtering" is accomplished by entering a filter expression in the
<i>Collection Controller</i> window (see <i>Controlling collection properties</i> above).
This expression is interpreted using CINT.  (For convenience, the special symbol
$ can be used as shorthand for the collection name.)  The objects for which the
filter expression is false become invisible in the graphical views; they are
shaded in the text tables and moved to the end of the table.
</p><p>
</p><h4><a name="Selecting"></a> Selecting </h4>
<p>
Selection is a useful tool for keeping track of objects in the different views.
An object can be selected by clicking on the object in any view.  The selection
propagates to all other views.  Multiple objects can be selected by holding the
Control key while clicking (this toggles selection).  For example, if a muon
sparks the user's interest in the rho-phi view, the user can find out more about
the muon by selecting it and reading the selected row in the muon table.  (It
may be more convenient to have the rho-phi view and table in separate windows so
they can be viewed side-by-side.  To do this, the table can be "undocked" from
the CmsShow window with the "undock" button; see <i>Views</i> above.)
</p><p>
Objects can also be selected using the "Select" tab of the Collection Controller
(see <i>Controlling collection properties</i> above).  The selection is performed by
entering an expression.  See the description for the filter expression in
<i>Filtering</i> above. 
</p><p>
</p><h4><a name="Adding_and_removing_items"></a> Adding and removing items </h4>
<p>
Collections can be removed from the event display by pushing the "Remove
Collection" button in the "Data" tab of the Collection Controller (see
<i>Controlling collection properties</i>).  
</p><p>
Additional collections can be added to the event display with the <i>Add
Collection</i> feature.  This window is opened by clicking the + button above the
list view or with the Window -&gt; Show Add Collection menu.  The user can pick a
collection from a list of all collections present in the data file.  (To sort
the list of collections, click on the column headers.)  A useful
example application is to add jets that were clustered with a different
algorithm than the default jets (iterativeCone5CaloJets), set their color to
green, and compare the yellow and green jets in the lego view.
</p><p>
</p><h4><a name="Saving_and_loading_configuration"></a> Saving and loading configurations </h4>
<p>
The configuration of the event display (collection colors etc.) can be saved
with the File -&gt; Save Configuration menu.  Likewise, a saved configuration can
be loaded with the File -&gt; Load Configuration menu.
</p><p>
</p><h4><a name="Getting_a_hard_copy"></a> Getting a hard copy </h4>
<p>
To save a copy of a graphical view, use the File -&gt; Export Main Image menu or
the Save Image button in the View Controller.  The tables can be dumped to the
terminal or into a text file, or they can be piped to a print command (lpr or
something fancier like enscript), using the buttons at the top of the table.
</p><p>
</p><h1><a name="Navigating_the_data"></a> Navigating the data </h1>
<p>
</p><h4><a name="Loading_a_file"></a> Loading a file </h4>
<p>
To open a data file, use the File -&gt; Open Data File menu.
</p><p>
</p><h4><a name="Going_to_an_event"></a> Going to an event </h4>
<p>
You can navigate between events with the arrow buttons above the list view or by
entering a run and event number in the fields to the right of the navigation
buttons. 
</p><p>
</p><h4><a name="Filtering_events"></a> Filtering events </h4>
<p>
To show only events that pass a filter, enter an expression in the "Filter"
field to the right of the navigation buttons.  This expression is interpreted by
CINT, and only events for which the expression is true are displayed.  For
convenience, collections can be referred to by their CmsShow names (the names
displayed in the list view) rather than their fwlite names.  Thus,
"$Electrons.pt() &gt; 10" would select events where there is at
least one electron in the Electrons collection ("pixelMatchGsfElectrons" by
default) with 10 GeV pt.</p></div><!-- /patternTopic-->
</div><!-- /patternContent-->
</div><!-- /patternMainContents-->
</div><!-- /patternMain-->
</div><!-- /patternFloatWrap-->
</div><!-- /patternOuter-->
</div><!-- /patternPage-->
</div><!-- /patternPageShadow-->
</div><!-- /patternScreen-->
</body></html>
