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

« back to all changes in this revision

Viewing changes to doc/html/classOpenMS_1_1Math_1_1ROCCurve.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>ROCCurve Class Reference</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 id="nav-path" class="navpath">
 
18
  <ul>
 
19
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="namespaceOpenMS_1_1Math.html">Math</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a></li>  </ul>
 
20
</div>
 
21
</div><!-- top -->
 
22
<div class="header">
 
23
  <div class="summary">
 
24
<a href="#nested-classes">Classes</a> &#124;
 
25
<a href="#pri-attribs">Private Attributes</a> &#124;
 
26
<a href="classOpenMS_1_1Math_1_1ROCCurve-members.html">List of all members</a>  </div>
 
27
  <div class="headertitle">
 
28
<div class="title">ROCCurve Class Reference<div class="ingroups"><a class="el" href="group__Math.html">Math</a></div></div>  </div>
 
29
</div><!--header-->
 
30
<div class="contents">
 
31
 
 
32
<p>ROCCurves show the tradeoff in sensitivity and specitivity for binary classifiers using different cutoff values.  
 
33
 <a href="classOpenMS_1_1Math_1_1ROCCurve.html#details">More...</a></p>
 
34
 
 
35
<p><code>#include &lt;<a class="el" href="ROCCurve_8h_source.html">OpenMS/MATH/STATISTICS/ROCCurve.h</a>&gt;</code></p>
 
36
<table class="memberdecls">
 
37
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
 
38
Classes</h2></td></tr>
 
39
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve_1_1simsortdec.html">simsortdec</a></td></tr>
 
40
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">predicate for sort()  <a href="classOpenMS_1_1Math_1_1ROCCurve_1_1simsortdec.html#details">More...</a><br/></td></tr>
 
41
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
42
</table><table class="memberdecls">
 
43
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 
44
Public Member Functions</h2></td></tr>
 
45
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
 
46
<tr class="memitem:a3331127a6b41a5d8d7410f44dbba0651"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a3331127a6b41a5d8d7410f44dbba0651">ROCCurve</a> ()</td></tr>
 
47
<tr class="memdesc:a3331127a6b41a5d8d7410f44dbba0651"><td class="mdescLeft">&#160;</td><td class="mdescRight">default constructor  <a href="#a3331127a6b41a5d8d7410f44dbba0651">More...</a><br/></td></tr>
 
48
<tr class="separator:a3331127a6b41a5d8d7410f44dbba0651"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
49
<tr class="memitem:a96e89c09eec7ce22106fe04bce779fa7"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a96e89c09eec7ce22106fe04bce779fa7">~ROCCurve</a> ()</td></tr>
 
50
<tr class="memdesc:a96e89c09eec7ce22106fe04bce779fa7"><td class="mdescLeft">&#160;</td><td class="mdescRight">destructor  <a href="#a96e89c09eec7ce22106fe04bce779fa7">More...</a><br/></td></tr>
 
51
<tr class="separator:a96e89c09eec7ce22106fe04bce779fa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
52
<tr class="memitem:a8113513e0e97550257516be8ed3c5008"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a8113513e0e97550257516be8ed3c5008">ROCCurve</a> (const <a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> &amp;source)</td></tr>
 
53
<tr class="memdesc:a8113513e0e97550257516be8ed3c5008"><td class="mdescLeft">&#160;</td><td class="mdescRight">copy constructor  <a href="#a8113513e0e97550257516be8ed3c5008">More...</a><br/></td></tr>
 
54
<tr class="separator:a8113513e0e97550257516be8ed3c5008"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
55
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
 
56
<tr class="memitem:a36fbc3a9cb63f3c38b5efafdd665089c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a36fbc3a9cb63f3c38b5efafdd665089c">operator=</a> (const <a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> &amp;source)</td></tr>
 
57
<tr class="memdesc:a36fbc3a9cb63f3c38b5efafdd665089c"><td class="mdescLeft">&#160;</td><td class="mdescRight">assignment operator  <a href="#a36fbc3a9cb63f3c38b5efafdd665089c">More...</a><br/></td></tr>
 
58
<tr class="separator:a36fbc3a9cb63f3c38b5efafdd665089c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
59
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
 
60
<tr class="memitem:a1a221078417cf0b1da002a00ddd096e5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a1a221078417cf0b1da002a00ddd096e5">insertPair</a> (<a class="el" href="classdouble.html">double</a> score, bool clas)</td></tr>
 
61
<tr class="memdesc:a1a221078417cf0b1da002a00ddd096e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">insert score, type pair  <a href="#a1a221078417cf0b1da002a00ddd096e5">More...</a><br/></td></tr>
 
62
<tr class="separator:a1a221078417cf0b1da002a00ddd096e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
63
<tr class="memitem:a24d6d1f4ec19f75095aca7db96a318db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a24d6d1f4ec19f75095aca7db96a318db">AUC</a> ()</td></tr>
 
64
<tr class="memdesc:a24d6d1f4ec19f75095aca7db96a318db"><td class="mdescLeft">&#160;</td><td class="mdescRight">returns Area Under Curve  <a href="#a24d6d1f4ec19f75095aca7db96a318db">More...</a><br/></td></tr>
 
65
<tr class="separator:a24d6d1f4ec19f75095aca7db96a318db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
66
<tr class="memitem:a3f34900da9e4891b51201eca98da356d"><td class="memItemLeft" align="right" valign="top">std::vector&lt; std::pair&lt; <a class="el" href="classdouble.html">double</a>, <br class="typebreak"/>
 
67
<a class="el" href="classdouble.html">double</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a3f34900da9e4891b51201eca98da356d">curve</a> (<a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> resolution=10)</td></tr>
 
68
<tr class="memdesc:a3f34900da9e4891b51201eca98da356d"><td class="mdescLeft">&#160;</td><td class="mdescRight">some points in the ROC Curve  <a href="#a3f34900da9e4891b51201eca98da356d">More...</a><br/></td></tr>
 
69
<tr class="separator:a3f34900da9e4891b51201eca98da356d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
70
<tr class="memitem:a9f2634099fda0b4e2dd74add7d35d417"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a9f2634099fda0b4e2dd74add7d35d417">cutoffPos</a> (<a class="el" href="classdouble.html">double</a> fraction=0.95)</td></tr>
 
71
<tr class="separator:a9f2634099fda0b4e2dd74add7d35d417"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
72
<tr class="memitem:adfc68429e56bd216d87ea760d3510a2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdouble.html">double</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#adfc68429e56bd216d87ea760d3510a2c">cutoffNeg</a> (<a class="el" href="classdouble.html">double</a> fraction=0.95)</td></tr>
 
73
<tr class="separator:adfc68429e56bd216d87ea760d3510a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
74
</table><table class="memberdecls">
 
75
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
 
76
Private Attributes</h2></td></tr>
 
77
<tr class="memitem:a78997ff796f7446a0dc50f01d0b44b05"><td class="memItemLeft" align="right" valign="top">std::list&lt; std::pair&lt; <a class="el" href="classdouble.html">double</a>, <br class="typebreak"/>
 
78
bool &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a78997ff796f7446a0dc50f01d0b44b05">score_clas_pairs_</a></td></tr>
 
79
<tr class="separator:a78997ff796f7446a0dc50f01d0b44b05"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
80
<tr class="memitem:af115785cb1865606754eb19bca67ed76"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#af115785cb1865606754eb19bca67ed76">pos_</a></td></tr>
 
81
<tr class="separator:af115785cb1865606754eb19bca67ed76"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
82
<tr class="memitem:a3792cb655f038ab426fcd932b725297b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html#a3792cb655f038ab426fcd932b725297b">neg_</a></td></tr>
 
83
<tr class="separator:a3792cb655f038ab426fcd932b725297b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 
84
</table>
 
85
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 
86
<div class="textblock"><p>ROCCurves show the tradeoff in sensitivity and specitivity for binary classifiers using different cutoff values. </p>
 
87
<p>[This class is buggy and usage is discouraged!] </p>
 
88
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 
89
<a class="anchor" id="a3331127a6b41a5d8d7410f44dbba0651"></a>
 
90
<div class="memitem">
 
91
<div class="memproto">
 
92
      <table class="memname">
 
93
        <tr>
 
94
          <td class="memname"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> </td>
 
95
          <td>(</td>
 
96
          <td class="paramname"></td><td>)</td>
 
97
          <td></td>
 
98
        </tr>
 
99
      </table>
 
100
</div><div class="memdoc">
 
101
 
 
102
<p>default constructor </p>
 
103
 
 
104
</div>
 
105
</div>
 
106
<a class="anchor" id="a96e89c09eec7ce22106fe04bce779fa7"></a>
 
107
<div class="memitem">
 
108
<div class="memproto">
 
109
<table class="mlabels">
 
110
  <tr>
 
111
  <td class="mlabels-left">
 
112
      <table class="memname">
 
113
        <tr>
 
114
          <td class="memname">virtual ~<a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> </td>
 
115
          <td>(</td>
 
116
          <td class="paramname"></td><td>)</td>
 
117
          <td></td>
 
118
        </tr>
 
119
      </table>
 
120
  </td>
 
121
  <td class="mlabels-right">
 
122
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
 
123
  </tr>
 
124
</table>
 
125
</div><div class="memdoc">
 
126
 
 
127
<p>destructor </p>
 
128
 
 
129
</div>
 
130
</div>
 
131
<a class="anchor" id="a8113513e0e97550257516be8ed3c5008"></a>
 
132
<div class="memitem">
 
133
<div class="memproto">
 
134
      <table class="memname">
 
135
        <tr>
 
136
          <td class="memname"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> </td>
 
137
          <td>(</td>
 
138
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> &amp;&#160;</td>
 
139
          <td class="paramname"><em>source</em></td><td>)</td>
 
140
          <td></td>
 
141
        </tr>
 
142
      </table>
 
143
</div><div class="memdoc">
 
144
 
 
145
<p>copy constructor </p>
 
146
 
 
147
</div>
 
148
</div>
 
149
<h2 class="groupheader">Member Function Documentation</h2>
 
150
<a class="anchor" id="a24d6d1f4ec19f75095aca7db96a318db"></a>
 
151
<div class="memitem">
 
152
<div class="memproto">
 
153
      <table class="memname">
 
154
        <tr>
 
155
          <td class="memname"><a class="el" href="classdouble.html">double</a> AUC </td>
 
156
          <td>(</td>
 
157
          <td class="paramname"></td><td>)</td>
 
158
          <td></td>
 
159
        </tr>
 
160
      </table>
 
161
</div><div class="memdoc">
 
162
 
 
163
<p>returns Area Under Curve </p>
 
164
 
 
165
</div>
 
166
</div>
 
167
<a class="anchor" id="a3f34900da9e4891b51201eca98da356d"></a>
 
168
<div class="memitem">
 
169
<div class="memproto">
 
170
      <table class="memname">
 
171
        <tr>
 
172
          <td class="memname">std::vector&lt;std::pair&lt;<a class="el" href="classdouble.html">double</a>, <a class="el" href="classdouble.html">double</a>&gt; &gt; curve </td>
 
173
          <td>(</td>
 
174
          <td class="paramtype"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a>&#160;</td>
 
175
          <td class="paramname"><em>resolution</em> = <code>10</code></td><td>)</td>
 
176
          <td></td>
 
177
        </tr>
 
178
      </table>
 
179
</div><div class="memdoc">
 
180
 
 
181
<p>some points in the ROC Curve </p>
 
182
 
 
183
</div>
 
184
</div>
 
185
<a class="anchor" id="adfc68429e56bd216d87ea760d3510a2c"></a>
 
186
<div class="memitem">
 
187
<div class="memproto">
 
188
      <table class="memname">
 
189
        <tr>
 
190
          <td class="memname"><a class="el" href="classdouble.html">double</a> cutoffNeg </td>
 
191
          <td>(</td>
 
192
          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
 
193
          <td class="paramname"><em>fraction</em> = <code>0.95</code></td><td>)</td>
 
194
          <td></td>
 
195
        </tr>
 
196
      </table>
 
197
</div><div class="memdoc">
 
198
 
 
199
</div>
 
200
</div>
 
201
<a class="anchor" id="a9f2634099fda0b4e2dd74add7d35d417"></a>
 
202
<div class="memitem">
 
203
<div class="memproto">
 
204
      <table class="memname">
 
205
        <tr>
 
206
          <td class="memname"><a class="el" href="classdouble.html">double</a> cutoffPos </td>
 
207
          <td>(</td>
 
208
          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
 
209
          <td class="paramname"><em>fraction</em> = <code>0.95</code></td><td>)</td>
 
210
          <td></td>
 
211
        </tr>
 
212
      </table>
 
213
</div><div class="memdoc">
 
214
 
 
215
</div>
 
216
</div>
 
217
<a class="anchor" id="a1a221078417cf0b1da002a00ddd096e5"></a>
 
218
<div class="memitem">
 
219
<div class="memproto">
 
220
      <table class="memname">
 
221
        <tr>
 
222
          <td class="memname">void insertPair </td>
 
223
          <td>(</td>
 
224
          <td class="paramtype"><a class="el" href="classdouble.html">double</a>&#160;</td>
 
225
          <td class="paramname"><em>score</em>, </td>
 
226
        </tr>
 
227
        <tr>
 
228
          <td class="paramkey"></td>
 
229
          <td></td>
 
230
          <td class="paramtype">bool&#160;</td>
 
231
          <td class="paramname"><em>clas</em>&#160;</td>
 
232
        </tr>
 
233
        <tr>
 
234
          <td></td>
 
235
          <td>)</td>
 
236
          <td></td><td></td>
 
237
        </tr>
 
238
      </table>
 
239
</div><div class="memdoc">
 
240
 
 
241
<p>insert score, type pair </p>
 
242
 
 
243
</div>
 
244
</div>
 
245
<a class="anchor" id="a36fbc3a9cb63f3c38b5efafdd665089c"></a>
 
246
<div class="memitem">
 
247
<div class="memproto">
 
248
      <table class="memname">
 
249
        <tr>
 
250
          <td class="memname"><a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a>&amp; operator= </td>
 
251
          <td>(</td>
 
252
          <td class="paramtype">const <a class="el" href="classOpenMS_1_1Math_1_1ROCCurve.html">ROCCurve</a> &amp;&#160;</td>
 
253
          <td class="paramname"><em>source</em></td><td>)</td>
 
254
          <td></td>
 
255
        </tr>
 
256
      </table>
 
257
</div><div class="memdoc">
 
258
 
 
259
<p>assignment operator </p>
 
260
 
 
261
</div>
 
262
</div>
 
263
<h2 class="groupheader">Member Data Documentation</h2>
 
264
<a class="anchor" id="a3792cb655f038ab426fcd932b725297b"></a>
 
265
<div class="memitem">
 
266
<div class="memproto">
 
267
<table class="mlabels">
 
268
  <tr>
 
269
  <td class="mlabels-left">
 
270
      <table class="memname">
 
271
        <tr>
 
272
          <td class="memname"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> neg_</td>
 
273
        </tr>
 
274
      </table>
 
275
  </td>
 
276
  <td class="mlabels-right">
 
277
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
 
278
  </tr>
 
279
</table>
 
280
</div><div class="memdoc">
 
281
 
 
282
</div>
 
283
</div>
 
284
<a class="anchor" id="af115785cb1865606754eb19bca67ed76"></a>
 
285
<div class="memitem">
 
286
<div class="memproto">
 
287
<table class="mlabels">
 
288
  <tr>
 
289
  <td class="mlabels-left">
 
290
      <table class="memname">
 
291
        <tr>
 
292
          <td class="memname"><a class="el" href="group__Concept.html#gaba0996d26f7be2572973245b51852757">UInt</a> pos_</td>
 
293
        </tr>
 
294
      </table>
 
295
  </td>
 
296
  <td class="mlabels-right">
 
297
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
 
298
  </tr>
 
299
</table>
 
300
</div><div class="memdoc">
 
301
 
 
302
</div>
 
303
</div>
 
304
<a class="anchor" id="a78997ff796f7446a0dc50f01d0b44b05"></a>
 
305
<div class="memitem">
 
306
<div class="memproto">
 
307
<table class="mlabels">
 
308
  <tr>
 
309
  <td class="mlabels-left">
 
310
      <table class="memname">
 
311
        <tr>
 
312
          <td class="memname">std::list&lt;std::pair&lt;<a class="el" href="classdouble.html">double</a>, bool&gt; &gt; score_clas_pairs_</td>
 
313
        </tr>
 
314
      </table>
 
315
  </td>
 
316
  <td class="mlabels-right">
 
317
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
 
318
  </tr>
 
319
</table>
 
320
</div><div class="memdoc">
 
321
 
 
322
</div>
 
323
</div>
 
324
</div><!-- contents -->
 
325
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
 
326
<TABLE width="100%" border="0">
 
327
<TR>
 
328
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
 
329
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:38 using doxygen 1.8.5</font></TD>
 
330
</TR>
 
331
</TABLE>
 
332
</BODY>
 
333
</HTML>