~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to doc/html/tutorial_transformations.html

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<HTML>
 
2
<HEAD>
 
3
<TITLE>Data reduction (peak picking, feature detection)</TITLE>
 
4
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
 
5
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
 
6
</HEAD>
 
7
<BODY BGCOLOR="#FFFFFF">
 
8
<A href="index.html">Home</A> &nbsp;&middot;
 
9
<A href="classes.html">Classes</A> &nbsp;&middot;
 
10
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
 
11
<A href="modules.html">Modules</A> &nbsp;&middot;
 
12
<A href="functions_func.html">Members</A> &nbsp;&middot;
 
13
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
 
14
<A href="pages.html">Related Pages</A>
 
15
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
16
<!-- Generated by Doxygen 1.8.5 -->
 
17
</div><!-- top -->
 
18
<div class="header">
 
19
  <div class="headertitle">
 
20
<div class="title">Data reduction (peak picking, feature detection) </div>  </div>
 
21
</div><!--header-->
 
22
<div class="contents">
 
23
<div class="textblock"><p>Data reduction in LC-MS analysis mostly consists of two steps. In the first step, called "peak picking", important information of the mass spectrometric peaks (e.g. peaks' mass centroid positions, their areas under curve and full-width-at-half-maxima) are extracted from the raw LC-MS data. The second data reduction step, called "feature finding", represents the quantitation of all peptides in a proteomic sample. Therefore, the signals in a LC-MS map caused by all charge and isotopic variants of the peptide are detected and summarized resulting in a list of compounds or features, each characterized by mass, retention time and abundance. The classes described in this section can be found in the <em>TRANSFORMATIONS</em> folder.</p>
 
24
<div class="image">
 
25
<img src="RawPeakFeatureMap.png" alt="RawPeakFeatureMap.png"/>
 
26
<div class="caption">
 
27
A peptide feature at different stages of data reduction.</div></div>
 
28
<h1><a class="anchor" id="transformations_pp"></a>
 
29
Peak picking</h1>
 
30
<p>For peak picking, the class <em>PeakPickerCWT</em> or <em>PeakPickerHiRes</em> is used. Because this class detects and extracts mass spectrometric peaks it is applicable to LC-MS as well as MALDI raw data.</p>
 
31
<p>The following example (Tutorial_PeakPickerCWT.C) shows how to open a raw map, initialize a PeakPickerCWT object, set the most important parameters (the scale of the wavelet, a peak's minimal height and fwhm), and start the peak picking process.</p>
 
32
 <div class="fragment"><div class="line"><span class="keywordtype">int</span> <a class="code" href="RNPxl_8C.html#a217dbf8b442f20279ea00b898af96f52">main</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>** argv)</div>
 
33
<div class="line">{</div>
 
34
<div class="line">  <span class="keywordflow">if</span> (argc &lt; 2) <span class="keywordflow">return</span> 1;</div>
 
35
<div class="line">  <span class="comment">// the path to the data should be given on the command line</span></div>
 
36
<div class="line">  String tutorial_data_path(argv[1]);</div>
 
37
<div class="line">  </div>
 
38
<div class="line">  PeakMap exp_raw;</div>
 
39
<div class="line">  PeakMap exp_picked;</div>
 
40
<div class="line"></div>
 
41
<div class="line">  MzMLFile mzml_file;</div>
 
42
<div class="line">  mzml_file.load(tutorial_data_path + <span class="stringliteral">&quot;/data/Tutorial_PeakPickerCWT.mzML&quot;</span>, exp_raw);</div>
 
43
<div class="line"></div>
 
44
<div class="line">  PeakPickerCWT pp;</div>
 
45
<div class="line">  Param param;</div>
 
46
<div class="line">  param.setValue(<span class="stringliteral">&quot;peak_width&quot;</span>, 0.1);</div>
 
47
<div class="line">  pp.setParameters(param);</div>
 
48
<div class="line"></div>
 
49
<div class="line">  pp.pickExperiment(exp_raw, exp_picked);</div>
 
50
<div class="line">  exp_picked.updateRanges();</div>
 
51
<div class="line"></div>
 
52
<div class="line">  cout &lt;&lt; <span class="stringliteral">&quot;\nMinimal fwhm of a mass spectrometric peak: &quot;</span> &lt;&lt; (<a class="code" href="group__Concept.html#gace75bfb1aba684e874dffee13738bd15">DoubleReal</a>)param.getValue(<span class="stringliteral">&quot;peak_width&quot;</span>)</div>
 
53
<div class="line">       &lt;&lt; <span class="stringliteral">&quot;\n\nNumber of picked peaks &quot;</span> &lt;&lt; exp_picked.getSize() &lt;&lt; std::endl;</div>
 
54
<div class="line"></div>
 
55
<div class="line">  <span class="keywordflow">return</span> 0;</div>
 
56
<div class="line">} <span class="comment">//end of main</span></div>
 
57
</div><!-- fragment --></p>
 
58
<p>The output of the program is: </p>
 
59
<div class="fragment"><div class="line">Scale of the wavelet: 0.2</div>
 
60
<div class="line">Minimal fwhm of a mass spectrometric peak: 0.1</div>
 
61
<div class="line">Minimal intensity of a mass spectrometric peak 500</div>
 
62
<div class="line"></div>
 
63
<div class="line">Number of picked peaks 14</div>
 
64
</div><!-- fragment --><dl class="section note"><dt>Note</dt><dd>A rough standard value for the peak's scale is the average fwhm of a mass spectrometric peak.</dd></dl>
 
65
<h1><a class="anchor" id="transformations_ff"></a>
 
66
Feature detection</h1>
 
67
<p>The FeatureFinders implement different algorithms for the detection and quantitation of peptides from LC-MS maps. In contrast to the previous step (peak picking), we do not only search for pronounced signals (peak) in the LC-MS map but search explicitly for peptides which can be recognized by their isotopic pattern.</p>
 
68
<p>OpenMS offers different algorithms for this task. Details of how to apply them are given in the TOPP documentation. Please also refer to our publications on the OpenMS web page. TOPP contains multiple command line programs which allow to execute our algorithms without writing a single line of code.</p>
 
69
<p>But you can also write your own FeatureFinder application. This gives you more flexibility and is straightforward to do. A short example (Tutorial_FeatureFinder.C) is given below. First we need to instantiate the FeatureFinder, its parameters and the input/output data:</p>
 
70
 <div class="fragment"><div class="line">  FeatureFinder ff;</div>
 
71
<div class="line">  <span class="comment">// ... set parameters (e.g. from INI file)</span></div>
 
72
<div class="line">  Param parameters;</div>
 
73
<div class="line">  <span class="comment">// ... set input data (e.g. from mzML file)</span></div>
 
74
<div class="line">  MSExperiment&lt;&gt; input;</div>
 
75
<div class="line">  <span class="comment">// ... set output data structure</span></div>
 
76
</div><!-- fragment --></p>
 
77
<p>Then we run the FeatureFinder. The first argument is the algorithm name (here 'simple'). Using the second and third parameter, the peak and feature data is handed to the algorithm. The fourth argument sets the parameters used by the algorithm. <div class="fragment"><div class="line">  <a class="code" href="classOpenMS_1_1FeatureMap.html">FeatureMap&lt;&gt;</a> output;</div>
 
78
<div class="line">  <span class="comment">// ... set user-specified seeds, if needed</span></div>
 
79
<div class="line">  <a class="code" href="classOpenMS_1_1FeatureMap.html">FeatureMap&lt;&gt;</a> seeds;</div>
 
80
<div class="line"></div>
 
81
<div class="line">  ff.run(<span class="stringliteral">&quot;simple&quot;</span>, input, output, parameters, seeds);</div>
 
82
</div><!-- fragment --> Now the FeatureMap is filled with the found features. </p>
 
83
</div></div><!-- contents -->
 
84
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
85
<TABLE width="100%" border="0">
 
86
<TR>
 
87
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
88
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:24 using doxygen 1.8.5</font></TD>
 
89
</TR>
 
90
</TABLE>
 
91
</BODY>
 
92
</HTML>