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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta name="author" content="Emanuel Eichhammer" />
<meta name="copyright" content="(C) 2011-2016 Emanuel Eichhammer" />
<title>QCPStatisticalBoxData Class Reference</title>
<link href="qcp.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top">
<a class="headerLink" href="index.html">Main Page</a> ·
<a class="headerLink" href="classoverview.html">Class Overview</a> ·
<a class="headerLink" href="hierarchy.html">Hierarchy</a> ·
<a class="headerLink" href="annotated.html">All Classes</a> ·
<a class="headerLink" href="pages.html">Special Pages</a>
<!-- Generated by Doxygen 1.8.12 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Functions</a> |
<a href="#pub-attribs">Public Members</a> |
<a href="#pub-static-methods">Static Public Functions</a> </div>
<div class="headertitle">
<div class="title">QCPStatisticalBoxData Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Holds the data of one single data point for <a class="el" href="classQCPStatisticalBox.html" title="A plottable representing a single statistical box in a plot. ">QCPStatisticalBox</a>.
<a href="classQCPStatisticalBoxData.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Functions</h2></td></tr>
<tr class="memitem:ab96c4b93670a8dcac8a3d4080fd722ee"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#ab96c4b93670a8dcac8a3d4080fd722ee">QCPStatisticalBoxData</a> ()</td></tr>
<tr class="separator:ab96c4b93670a8dcac8a3d4080fd722ee"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66b0c6d39765d0feb49c286fba4e4ef5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a66b0c6d39765d0feb49c286fba4e4ef5">QCPStatisticalBoxData</a> (double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum, const QVector< double > &outliers=QVector< double >())</td></tr>
<tr class="separator:a66b0c6d39765d0feb49c286fba4e4ef5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a168100275e85935207deec86216abc88"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a168100275e85935207deec86216abc88">sortKey</a> () const</td></tr>
<tr class="separator:a168100275e85935207deec86216abc88"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4bbbf44f60ac5eca73c5f4135741562e"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a4bbbf44f60ac5eca73c5f4135741562e">mainKey</a> () const</td></tr>
<tr class="separator:a4bbbf44f60ac5eca73c5f4135741562e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0df3cb31cfd6d48decf6173297b81746"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a0df3cb31cfd6d48decf6173297b81746">mainValue</a> () const</td></tr>
<tr class="separator:a0df3cb31cfd6d48decf6173297b81746"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a2410fcf3d45fa3a1ad09e265b9bcad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classQCPRange.html">QCPRange</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a1a2410fcf3d45fa3a1ad09e265b9bcad">valueRange</a> () const</td></tr>
<tr class="separator:a1a2410fcf3d45fa3a1ad09e265b9bcad"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Members</h2></td></tr>
<tr class="memitem:a2d0b5ca5130e8a73294c46b8b2fd77b8"><td class="memItemLeft" align="right" valign="top"><a id="a2d0b5ca5130e8a73294c46b8b2fd77b8"></a>
double </td><td class="memItemRight" valign="bottom"><b>key</b></td></tr>
<tr class="separator:a2d0b5ca5130e8a73294c46b8b2fd77b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc2f4b8cbff9f2e4a676f32bad8a7e3a"><td class="memItemLeft" align="right" valign="top"><a id="adc2f4b8cbff9f2e4a676f32bad8a7e3a"></a>
double </td><td class="memItemRight" valign="bottom"><b>minimum</b></td></tr>
<tr class="separator:adc2f4b8cbff9f2e4a676f32bad8a7e3a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9f478b4ea0789fa6cff7eebb654b5d4"><td class="memItemLeft" align="right" valign="top"><a id="af9f478b4ea0789fa6cff7eebb654b5d4"></a>
double </td><td class="memItemRight" valign="bottom"><b>lowerQuartile</b></td></tr>
<tr class="separator:af9f478b4ea0789fa6cff7eebb654b5d4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a116cd53ae6685979ec3b051cfc7dbba5"><td class="memItemLeft" align="right" valign="top"><a id="a116cd53ae6685979ec3b051cfc7dbba5"></a>
double </td><td class="memItemRight" valign="bottom"><b>median</b></td></tr>
<tr class="separator:a116cd53ae6685979ec3b051cfc7dbba5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5604dfe04b103e5ac73ce7895b46303b"><td class="memItemLeft" align="right" valign="top"><a id="a5604dfe04b103e5ac73ce7895b46303b"></a>
double </td><td class="memItemRight" valign="bottom"><b>upperQuartile</b></td></tr>
<tr class="separator:a5604dfe04b103e5ac73ce7895b46303b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa2800abda337decfc4277cb8bf846d6f"><td class="memItemLeft" align="right" valign="top"><a id="aa2800abda337decfc4277cb8bf846d6f"></a>
double </td><td class="memItemRight" valign="bottom"><b>maximum</b></td></tr>
<tr class="separator:aa2800abda337decfc4277cb8bf846d6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaa27539fbd941d3f1eb8169e881e308"><td class="memItemLeft" align="right" valign="top"><a id="abaa27539fbd941d3f1eb8169e881e308"></a>
QVector< double > </td><td class="memItemRight" valign="bottom"><b>outliers</b></td></tr>
<tr class="separator:abaa27539fbd941d3f1eb8169e881e308"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Functions</h2></td></tr>
<tr class="memitem:a8c391d5a6c7cebc79b664aad9917b499"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classQCPStatisticalBoxData.html">QCPStatisticalBoxData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a8c391d5a6c7cebc79b664aad9917b499">fromSortKey</a> (double <a class="el" href="classQCPStatisticalBoxData.html#a168100275e85935207deec86216abc88">sortKey</a>)</td></tr>
<tr class="separator:a8c391d5a6c7cebc79b664aad9917b499"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4710ae44b85d4b34b13c3f9301f28c01"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classQCPStatisticalBoxData.html#a4710ae44b85d4b34b13c3f9301f28c01">sortKeyIsMainKey</a> ()</td></tr>
<tr class="separator:a4710ae44b85d4b34b13c3f9301f28c01"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Holds the data of one single data point for <a class="el" href="classQCPStatisticalBox.html" title="A plottable representing a single statistical box in a plot. ">QCPStatisticalBox</a>. </p>
<p>The stored data is:</p>
<ul>
<li><em>key:</em> coordinate on the key axis of this data point (this is the <em>mainKey</em> and the <em>sortKey</em>)</li>
</ul>
<ul>
<li><em>minimum:</em> the position of the lower whisker, typically the minimum measurement of the sample that's not considered an outlier.</li>
</ul>
<ul>
<li><em>lowerQuartile:</em> the lower end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they should contain 50% of the sample data.</li>
</ul>
<ul>
<li><em>median:</em> the value of the median mark inside the quartile box. The median separates the sample data in half (50% of the sample data is below/above the median). (This is the <em>mainValue</em>)</li>
</ul>
<ul>
<li><em>upperQuartile:</em> the upper end of the box. The lower and the upper quartiles are the two statistical quartiles around the median of the sample, they should contain 50% of the sample data.</li>
</ul>
<ul>
<li><em>maximum:</em> the position of the upper whisker, typically the maximum measurement of the sample that's not considered an outlier.</li>
</ul>
<ul>
<li><em>outliers:</em> a QVector of outlier values that will be drawn as scatter points at the <em>key</em> coordinate of this data point (see <a class="el" href="classQCPStatisticalBox.html#ad5241943422eb8e58360a97e99ad6aa7">QCPStatisticalBox::setOutlierStyle</a>)</li>
</ul>
<p>The container for storing multiple data points is <a class="el" href="plottable-statisticalbox_8h.html#a8b773c0c35f8f924701ced6e9915e4c7">QCPStatisticalBoxDataContainer</a>. It is a typedef for <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a> with <a class="el" href="classQCPStatisticalBoxData.html">QCPStatisticalBoxData</a> as the DataType template parameter. See the documentation there for an explanation regarding the data type's generic methods.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="plottable-statisticalbox_8h.html#a8b773c0c35f8f924701ced6e9915e4c7">QCPStatisticalBoxDataContainer</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab96c4b93670a8dcac8a3d4080fd722ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab96c4b93670a8dcac8a3d4080fd722ee">§ </a></span>QCPStatisticalBoxData() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QCPStatisticalBoxData::QCPStatisticalBoxData </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a data point with key and all values set to zero. </p>
</div>
</div>
<a id="a66b0c6d39765d0feb49c286fba4e4ef5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66b0c6d39765d0feb49c286fba4e4ef5">§ </a></span>QCPStatisticalBoxData() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QCPStatisticalBoxData::QCPStatisticalBoxData </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>minimum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>lowerQuartile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>median</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>upperQuartile</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>maximum</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const QVector< double > & </td>
<td class="paramname"><em>outliers</em> = <code>QVector<double>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructs a data point with the specified <em>key</em>, <em>minimum</em>, <em>lowerQuartile</em>, <em>median</em>, <em>upperQuartile</em>, <em>maximum</em> and optionally a number of <em>outliers</em>. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a168100275e85935207deec86216abc88"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a168100275e85935207deec86216abc88">§ </a></span>sortKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double QCPStatisticalBoxData::sortKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <em>key</em> member of this data point.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<a id="a8c391d5a6c7cebc79b664aad9917b499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c391d5a6c7cebc79b664aad9917b499">§ </a></span>fromSortKey()</h2>
<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="classQCPStatisticalBoxData.html">QCPStatisticalBoxData</a> QCPStatisticalBoxData::fromSortKey </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>sortKey</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a data point with the specified <em>sortKey</em>. All other members are set to zero.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<a id="a4710ae44b85d4b34b13c3f9301f28c01"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4710ae44b85d4b34b13c3f9301f28c01">§ </a></span>sortKeyIsMainKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static static bool QCPStatisticalBoxData::sortKeyIsMainKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Since the member <em>key</em> is both the data point key coordinate and the data ordering parameter, this method returns true.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<a id="a4bbbf44f60ac5eca73c5f4135741562e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4bbbf44f60ac5eca73c5f4135741562e">§ </a></span>mainKey()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double QCPStatisticalBoxData::mainKey </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <em>key</em> member of this data point.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<a id="a0df3cb31cfd6d48decf6173297b81746"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0df3cb31cfd6d48decf6173297b81746">§ </a></span>mainValue()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double QCPStatisticalBoxData::mainValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the <em>median</em> member of this data point.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<a id="a1a2410fcf3d45fa3a1ad09e265b9bcad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a2410fcf3d45fa3a1ad09e265b9bcad">§ </a></span>valueRange()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classQCPRange.html">QCPRange</a> QCPStatisticalBoxData::valueRange </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a <a class="el" href="classQCPRange.html" title="Represents the range an axis is encompassing. ">QCPRange</a> spanning from the <em>minimum</em> to the <em>maximum</em> member of this statistical box data point, possibly further expanded by outliers.</p>
<p>For a general explanation of what this method is good for in the context of the data container, see the documentation of <a class="el" href="classQCPDataContainer.html">QCPDataContainer</a>. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/plottables/<a class="el" href="plottable-statisticalbox_8h.html">plottable-statisticalbox.h</a></li>
<li>src/plottables/plottable-statisticalbox.cpp</li>
</ul>
</div><!-- contents -->
</body>
</html>
|
