File: classOpenMS_1_1MRMRTNormalizer.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 (232 lines) | stat: -rw-r--r-- 13,800 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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<HTML>
<HEAD>
<TITLE>MRMRTNormalizer Class Reference</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 id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1MRMRTNormalizer.html">MRMRTNormalizer</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classOpenMS_1_1MRMRTNormalizer-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">MRMRTNormalizer Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>The <a class="el" href="classOpenMS_1_1MRMRTNormalizer.html" title="The MRMRTNormalizer will find retention time peptides in data. ">MRMRTNormalizer</a> will find retention time peptides in data.  
 <a href="classOpenMS_1_1MRMRTNormalizer.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="MRMRTNormalizer_8h_source.html">OpenMS/ANALYSIS/OPENSWATH/MRMRTNormalizer.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aba4109486fe20c9b33bb69992cd101d4"><td class="memItemLeft" align="right" valign="top">static int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MRMRTNormalizer.html#aba4109486fe20c9b33bb69992cd101d4">outlier_candidate</a> (std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;x, std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;y)</td></tr>
<tr class="memdesc:aba4109486fe20c9b33bb69992cd101d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function computes a candidate outlier peptide by iteratively leaving one peptide out to find the one which results in the maximum R^2 of a first order linear regression of the remaining ones. The datapoints are submitted as two vectors of doubles (x- and y-coordinates).  <a href="#aba4109486fe20c9b33bb69992cd101d4">More...</a><br/></td></tr>
<tr class="separator:aba4109486fe20c9b33bb69992cd101d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c2ec4e09bdd94bc5f528f40dc96b01b"><td class="memItemLeft" align="right" valign="top">static std::vector&lt; std::pair<br class="typebreak"/>
&lt; <a class="el" href="classdouble.html">double</a>, <a class="el" href="classdouble.html">double</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MRMRTNormalizer.html#a8c2ec4e09bdd94bc5f528f40dc96b01b">rm_outliers</a> (std::vector&lt; std::pair&lt; <a class="el" href="classdouble.html">double</a>, <a class="el" href="classdouble.html">double</a> &gt; &gt; &amp;pairs, <a class="el" href="classdouble.html">double</a> rsq_limit, <a class="el" href="classdouble.html">double</a> coverage_limit)</td></tr>
<tr class="memdesc:a8c2ec4e09bdd94bc5f528f40dc96b01b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function removes potential outliers from a set of paired points. Two thresholds need to be defined, first a lower R^2 limit to accept the regression for the RT normalization and second, the lower limit of peptide coverage. The algorithms then selects candidate outlier peptides and applies the Chauvenet's criterion on the assumption that the residuals are normal distributed to determine whether the peptides can be removed. This is done iteratively until both limits are reached.  <a href="#a8c2ec4e09bdd94bc5f528f40dc96b01b">More...</a><br/></td></tr>
<tr class="separator:a8c2ec4e09bdd94bc5f528f40dc96b01b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac224bc5bdde5e5d1692f50dcaf763847"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MRMRTNormalizer.html#ac224bc5bdde5e5d1692f50dcaf763847">chauvenet_probability</a> (std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;residuals, int pos)</td></tr>
<tr class="memdesc:ac224bc5bdde5e5d1692f50dcaf763847"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function computes Chauvenet's criterion probability for a vector and a value whose position is submitted.  <a href="#ac224bc5bdde5e5d1692f50dcaf763847">More...</a><br/></td></tr>
<tr class="separator:ac224bc5bdde5e5d1692f50dcaf763847"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33bb531d7b4c02a5cf48aced48e7f69a"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1MRMRTNormalizer.html#a33bb531d7b4c02a5cf48aced48e7f69a">chauvenet</a> (std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;residuals, int pos)</td></tr>
<tr class="memdesc:a33bb531d7b4c02a5cf48aced48e7f69a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function computes Chauvenet's criterion for a vector and a value whose position is submitted.  <a href="#a33bb531d7b4c02a5cf48aced48e7f69a">More...</a><br/></td></tr>
<tr class="separator:a33bb531d7b4c02a5cf48aced48e7f69a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classOpenMS_1_1MRMRTNormalizer.html" title="The MRMRTNormalizer will find retention time peptides in data. ">MRMRTNormalizer</a> will find retention time peptides in data. </p>
<p>This tool will take a description of RT peptides and their normalized retention time to write out a transformation file on how to transform the RT space into the normalized space.</p>
<p>The principle is adapted from Escher et al. Escher, C. et al. (2012), Using iRT, a normalized retention time for more targeted measurement of peptides. Proteomics, 12: 1111-1121. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a33bb531d7b4c02a5cf48aced48e7f69a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static bool chauvenet </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>residuals</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function computes Chauvenet's criterion for a vector and a value whose position is submitted. </p>
<dl class="section return"><dt>Returns</dt><dd>TRUE, if Chauvenet's criterion is fullfilled and the outlier can be removed. </dd></dl>

</div>
</div>
<a class="anchor" id="ac224bc5bdde5e5d1692f50dcaf763847"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="classdouble.html">double</a> chauvenet_probability </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>residuals</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>pos</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function computes Chauvenet's criterion probability for a vector and a value whose position is submitted. </p>
<dl class="section return"><dt>Returns</dt><dd>Chauvenet's criterion probability </dd></dl>

</div>
</div>
<a class="anchor" id="aba4109486fe20c9b33bb69992cd101d4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static int outlier_candidate </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::vector&lt; <a class="el" href="classdouble.html">double</a> &gt; &amp;&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function computes a candidate outlier peptide by iteratively leaving one peptide out to find the one which results in the maximum R^2 of a first order linear regression of the remaining ones. The datapoints are submitted as two vectors of doubles (x- and y-coordinates). </p>
<dl class="section return"><dt>Returns</dt><dd>The position of the candidate outlier peptide as supplied by the vector is returned.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1UnableToFit.html" title="Exception used if an error occurred while fitting a model to a given dataset. ">Exception::UnableToFit</a></td><td>is thrown if fitting cannot be performed </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a8c2ec4e09bdd94bc5f528f40dc96b01b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static std::vector&lt;std::pair&lt;<a class="el" href="classdouble.html">double</a>, <a class="el" href="classdouble.html">double</a>&gt; &gt; rm_outliers </td>
          <td>(</td>
          <td class="paramtype">std::vector&lt; std::pair&lt; <a class="el" href="classdouble.html">double</a>, <a class="el" href="classdouble.html">double</a> &gt; &gt; &amp;&#160;</td>
          <td class="paramname"><em>pairs</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
          <td class="paramname"><em>rsq_limit</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
          <td class="paramname"><em>coverage_limit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This function removes potential outliers from a set of paired points. Two thresholds need to be defined, first a lower R^2 limit to accept the regression for the RT normalization and second, the lower limit of peptide coverage. The algorithms then selects candidate outlier peptides and applies the Chauvenet's criterion on the assumption that the residuals are normal distributed to determine whether the peptides can be removed. This is done iteratively until both limits are reached. </p>
<dl class="section return"><dt>Returns</dt><dd>A vector of pairs is returned if the R^2 limit was reached without reaching the coverage limit. If the limits are reached, an exception is thrown.</dd></dl>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1UnableToFit.html" title="Exception used if an error occurred while fitting a model to a given dataset. ">Exception::UnableToFit</a></td><td>is thrown if fitting cannot be performed </td></tr>
  </table>
  </dd>
</dl>

</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:27 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>