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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
|
<HTML>
<HEAD>
<TITLE>ProteinInference 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> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<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_1ProteinInference.html">ProteinInference</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="classOpenMS_1_1ProteinInference-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ProteinInference Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>[experimental class] given a peptide quantitation, infer corresponding protein quantities
<a href="classOpenMS_1_1ProteinInference.html#details">More...</a></p>
<p><code>#include <<a class="el" href="ProteinInference_8h_source.html">OpenMS/ANALYSIS/QUANTITATION/ProteinInference.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a75368a6367469257c1a109f862e28a0d"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classOpenMS_1_1Peak2D.html#a4a8c5b2adc05e9ff96a007385bfe9b47">Peak2D::IntensityType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#a75368a6367469257c1a109f862e28a0d">IntensityType</a></td></tr>
<tr class="separator:a75368a6367469257c1a109f862e28a0d"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a560381aa77e7bd3e336c11d731f1eee3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#a560381aa77e7bd3e336c11d731f1eee3">ProteinInference</a> ()</td></tr>
<tr class="memdesc:a560381aa77e7bd3e336c11d731f1eee3"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a560381aa77e7bd3e336c11d731f1eee3">More...</a><br/></td></tr>
<tr class="separator:a560381aa77e7bd3e336c11d731f1eee3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a37b12ca5c0c3478f83d7be8c39aafe4b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#a37b12ca5c0c3478f83d7be8c39aafe4b">ProteinInference</a> (const <a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> &cp)</td></tr>
<tr class="memdesc:a37b12ca5c0c3478f83d7be8c39aafe4b"><td class="mdescLeft"> </td><td class="mdescRight">copy constructor <a href="#a37b12ca5c0c3478f83d7be8c39aafe4b">More...</a><br/></td></tr>
<tr class="separator:a37b12ca5c0c3478f83d7be8c39aafe4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0d8ba8314fcec19eb20389399bb5abc6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#a0d8ba8314fcec19eb20389399bb5abc6">operator=</a> (const <a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> &rhs)</td></tr>
<tr class="memdesc:a0d8ba8314fcec19eb20389399bb5abc6"><td class="mdescLeft"> </td><td class="mdescRight">assignment operator <a href="#a0d8ba8314fcec19eb20389399bb5abc6">More...</a><br/></td></tr>
<tr class="separator:a0d8ba8314fcec19eb20389399bb5abc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a20fb7506e69406aae2f243a9d5edaa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#a3a20fb7506e69406aae2f243a9d5edaa">infer</a> (<a class="el" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> &consensus_map, const <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> reference_map)</td></tr>
<tr class="memdesc:a3a20fb7506e69406aae2f243a9d5edaa"><td class="mdescLeft"> </td><td class="mdescRight">given a peptide quantitation, infer corresponding protein quantities <a href="#a3a20fb7506e69406aae2f243a9d5edaa">More...</a><br/></td></tr>
<tr class="separator:a3a20fb7506e69406aae2f243a9d5edaa"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:ab2903dbcf2209981d0441c7f8b35c827"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#ab2903dbcf2209981d0441c7f8b35c827">infer_</a> (<a class="el" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> &consensus_map, const size_t protein_idenfication_index, const <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> reference_map)</td></tr>
<tr class="separator:ab2903dbcf2209981d0441c7f8b35c827"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe2ebe322f4dd103143bf4edecf33ab1"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ProteinInference.html#abe2ebe322f4dd103143bf4edecf33ab1">sortByUnique_</a> (std::vector< <a class="el" href="classOpenMS_1_1PeptideHit.html">PeptideHit</a> > &peptide_hits_local, const bool is_higher_score_better)</td></tr>
<tr class="separator:abe2ebe322f4dd103143bf4edecf33ab1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>[experimental class] given a peptide quantitation, infer corresponding protein quantities </p>
<p>Infers protein ratios from peptide ratios (currently using unique peptides only). Use the <a class="el" href="classOpenMS_1_1IDMapper.html" title="Annotates an MSExperiment, FeatureMap or ConsensusMap with peptide identifications. ">IDMapper</a> class to add protein and peptide information to a quantitative <a class="el" href="classOpenMS_1_1ConsensusMap.html" title="A container for consensus elements. ">ConsensusMap</a> prior to this step. </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a75368a6367469257c1a109f862e28a0d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classOpenMS_1_1Peak2D.html#a4a8c5b2adc05e9ff96a007385bfe9b47">Peak2D::IntensityType</a> <a class="el" href="classOpenMS_1_1ProteinInference.html#a75368a6367469257c1a109f862e28a0d">IntensityType</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a560381aa77e7bd3e336c11d731f1eee3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
</div>
</div>
<a class="anchor" id="a37b12ca5c0c3478f83d7be8c39aafe4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> & </td>
<td class="paramname"><em>cp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>copy constructor </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3a20fb7506e69406aae2f243a9d5edaa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void infer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> & </td>
<td class="paramname"><em>consensus_map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>reference_map</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>given a peptide quantitation, infer corresponding protein quantities </p>
<p>Infers protein ratios from peptide ratios (currently using unique peptides only). Use the <a class="el" href="classOpenMS_1_1IDMapper.html" title="Annotates an MSExperiment, FeatureMap or ConsensusMap with peptide identifications. ">IDMapper</a> class to add protein and peptide information to a quantitative <a class="el" href="classOpenMS_1_1ConsensusMap.html" title="A container for consensus elements. ">ConsensusMap</a> prior to this step.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">consensus_map</td><td>Peptide quantitation with ProteinIdentifications attached, where Protein quantitation will be attached </td></tr>
<tr><td class="paramname">reference_map</td><td>Index of (iTRAQ) reference channel within the consensus map</td></tr>
</table>
</dd>
</dl>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classOpenMS_1_1Exception_1_1MissingInformation.html" title="Not all required information provided. ">Exception::MissingInformation</a></td><td>if Protein/PeptideIdentifications are missing </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab2903dbcf2209981d0441c7f8b35c827"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void infer_ </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ConsensusMap.html">ConsensusMap</a> & </td>
<td class="paramname"><em>consensus_map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t </td>
<td class="paramname"><em>protein_idenfication_index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> </td>
<td class="paramname"><em>reference_map</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0d8ba8314fcec19eb20389399bb5abc6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a>& operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1ProteinInference.html">ProteinInference</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>assignment operator </p>
</div>
</div>
<a class="anchor" id="abe2ebe322f4dd103143bf4edecf33ab1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool sortByUnique_ </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="classOpenMS_1_1PeptideHit.html">PeptideHit</a> > & </td>
<td class="paramname"><em>peptide_hits_local</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const bool </td>
<td class="paramname"><em>is_higher_score_better</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</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>
|