File: TOPPView_introduction.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (67 lines) | stat: -rw-r--r-- 5,748 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<HTML>
<HEAD>
<TITLE>Introduction</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">Introduction </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>TOPPView is a viewer for MS and HPLC-MS data. It can be used to inspect files in mzML, mzData, mzXML, ANDI/MS and several other text-based file formats. It also supports viewing data from an OpenMS database.</p>
<p>In each view, several datasets can be displayed using the layer concept. This allows visual comparison of several datasets as well as displaying input data and output data of an algorithm together.</p>
<p>TOPPView is intended for visual inspection of the data by experimentalists as well as for analysis software by developers.</p>
<div class="image">
<img src="TOPPView_parts.png" alt="TOPPView_parts.png"/>
</div>
 <p>The above example image shows a 2D view of TOPPView (blue rectangle) and the corresponding <a class="el" href="TOPPView_modes.html">Display modes and view options</a> (red rectangle). In the right dock area, you can see the <a class="el" href="TOPPView_introduction.html#TOPPView_layers">Layers</a> (yellow rectangle), the <a class="el" href="TOPPView_introduction.html#TOPPView_browser">Spectrum browser</a> (magenta rectangle) and the <a class="el" href="TOPPView_introduction.html#TOPPView_filtering">Data filtering</a> tool (green rectangle). Switching between open windows can be done using the tab bar (black rectangle).</p>
<h1><a class="anchor" id="TOPPView_layers"></a>
Layers</h1>
<p>Each view of TOPPView supports several datasets, called layers. In the <em>layer</em> <em>manager</em> (dock window in the upper right corner), layers can be hidden and shown using the check box in front of each layer name.</p>
<p>By clicking on a layer, this layer is selected, which is indicated by a blue background. The selected layer can be manipulated using the <em>Tools</em> menu.</p>
<p>Layers can be copied by dragging them to the tab bar. If the layer is dropped on a tab, it is added to the corresponding window. If the layer is dropped on the tab bar but not on a tab, a new window with that layer is added.</p>
<h1><a class="anchor" id="TOPPView_browser"></a>
Spectrum browser</h1>
<p>The spectra contained in a peak map can be browsed in the <em>spectrum</em> <em>browser</em>. It displays a tree view of all spectra in the current layer, where a spectrum with MS level <em>n</em> is a child of the spectrum with MS level <em>n</em> - <em>1</em> that contains its corresponding precursor peak. For each spectrum in the list, the retention time and (for spectra with MS level &gt; 1) the m/z value of the precursor peak are also shown.</p>
<p>If a 2D or 3D window is active, double-clicking a spectrum will open it in a new 1D window. If the active window is a 1D view, the spectra can be browsed and the currently selected spectrum will be shown.</p>
<h1><a class="anchor" id="TOPPView_filtering"></a>
Data filtering</h1>
<p>TOPPView allows filtering of the displayed peak data and feature data. Peak data can be filtered according to intensity and meta data. Meta data is arbitrary data the peak is annotated with. Feature data can be filtered according to intensity, charge, quality and meta data.</p>
<p>Data filters are managed by a dock window. Filters can be added, removed and edited through the context menu (right button mouse click) of the data filters window. For convenience, filters can also be edited by double-clicking them.</p>
<h1><a class="anchor" id="TOPPView_command_line"></a>
Command line options</h1>
<p>Several files can be opened in one layer from the command line by putting a '+' character between the file names. The following command opens three files in three layers of the same window: </p>
<div class="fragment"><div class="line">TOPPView file1.mzML + file2.mzML + file3.mzML</div>
</div><!-- fragment --><p> Without the '+' the files would be opened in three different windows.</p>
<p>The color gradient used to display a file can be changed by adding one of several '@' commands. The following command opens the file with a white-to-black gradient: </p>
<div class="fragment"><div class="line">TOPPView file1.mzML @bw</div>
</div><!-- fragment --><p>For more information on command line parameters call: </p>
<div class="fragment"><div class="line">TOPPView --help</div>
</div><!-- fragment --><h1><a class="anchor" id="TOPPView_help"></a>
Looking for help?</h1>
<p>You can display a short help text for each button and dock window of TOPPView by clicking on it in <em>What's</em> <em>this</em>? mode. <em>What's</em> <em>this</em>? mode can be entered using the <em>Help</em> menu.</p>
<div class="image">
<img src="TOPPView_help.png" alt="TOPPView_help.png"/>
</div>
  </div></div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:25 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>