File: QwtMatrixRasterData.3

package info (click to toggle)
qwt 6.1.2-6
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,848 kB
  • ctags: 15,811
  • sloc: cpp: 57,382; makefile: 41
file content (282 lines) | stat: -rw-r--r-- 6,534 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
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
.TH "QwtMatrixRasterData" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtMatrixRasterData \- 
.PP
A class representing a matrix of values as raster data\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_matrix_raster_data\&.h>\fP
.PP
Inherits \fBQwtRasterData\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBResampleMode\fP { \fBNearestNeighbour\fP, \fBBilinearInterpolation\fP }"
.br
.RI "\fIResampling algorithm The default setting is NearestNeighbour;\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtMatrixRasterData\fP ()"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "virtual \fB~QwtMatrixRasterData\fP ()"
.br
.RI "\fIDestructor\&. \fP"
.ti -1c
.RI "void \fBsetResampleMode\fP (\fBResampleMode\fP mode)"
.br
.RI "\fISet the resampling algorithm\&. \fP"
.ti -1c
.RI "\fBResampleMode\fP \fBresampleMode\fP () const "
.br
.ti -1c
.RI "virtual void \fBsetInterval\fP (Qt::Axis, const \fBQwtInterval\fP &)"
.br
.RI "\fIAssign the bounding interval for an axis\&. \fP"
.ti -1c
.RI "void \fBsetValueMatrix\fP (const QVector< double > &values, int \fBnumColumns\fP)"
.br
.RI "\fIAssign a value matrix\&. \fP"
.ti -1c
.RI "const QVector< double > \fBvalueMatrix\fP () const "
.br
.ti -1c
.RI "void \fBsetValue\fP (int row, int col, double \fBvalue\fP)"
.br
.RI "\fIChange a single value in the matrix\&. \fP"
.ti -1c
.RI "int \fBnumColumns\fP () const "
.br
.ti -1c
.RI "int \fBnumRows\fP () const "
.br
.ti -1c
.RI "virtual QRectF \fBpixelHint\fP (const QRectF &) const "
.br
.RI "\fICalculate the pixel hint\&. \fP"
.ti -1c
.RI "virtual double \fBvalue\fP (double x, double y) const "
.br
.in -1c
.SH "Detailed Description"
.PP 
A class representing a matrix of values as raster data\&. 

\fBQwtMatrixRasterData\fP implements an interface for a matrix of equidistant values, that can be used by a \fBQwtPlotRasterItem\fP\&. It implements a couple of resampling algorithms, to provide values for positions, that or not on the value matrix\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtMatrixRasterData::ResampleMode\fP"

.PP
Resampling algorithm The default setting is NearestNeighbour;\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fINearestNeighbour \fP\fP
Return the value from the matrix, that is nearest to the the requested position\&. 
.TP
\fB\fIBilinearInterpolation \fP\fP
Interpolate the value from the distances and values of the 4 surrounding values in the matrix, 
.SH "Member Function Documentation"
.PP 
.SS "int QwtMatrixRasterData::numColumns () const"

.PP
\fBReturns:\fP
.RS 4
Number of columns of the value matrix 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalueMatrix()\fP, \fBnumRows()\fP, \fBsetValueMatrix()\fP 
.RE
.PP

.SS "int QwtMatrixRasterData::numRows () const"

.PP
\fBReturns:\fP
.RS 4
Number of rows of the value matrix 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalueMatrix()\fP, \fBnumColumns()\fP, \fBsetValueMatrix()\fP 
.RE
.PP

.SS "QRectF QwtMatrixRasterData::pixelHint (const QRectF &area) const\fC [virtual]\fP"

.PP
Calculate the pixel hint\&. \fBpixelHint()\fP returns the geometry of a pixel, that can be used to calculate the resolution and alignment of the plot item, that is representing the data\&.
.PP
.IP "\(bu" 2
NearestNeighbour
.br
 \fBpixelHint()\fP returns the surrounding pixel of the top left value in the matrix\&.
.IP "\(bu" 2
BilinearInterpolation
.br
 Returns an empty rectangle recommending to render in target device ( f\&.e\&. screen ) resolution\&.
.PP
.PP
\fBParameters:\fP
.RS 4
\fIarea\fP Requested area, ignored 
.RE
.PP
\fBReturns:\fP
.RS 4
Calculated hint
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBResampleMode\fP, setMatrix(), \fBsetInterval()\fP 
.RE
.PP

.PP
Reimplemented from \fBQwtRasterData\fP\&.
.SS "\fBQwtMatrixRasterData::ResampleMode\fP QwtMatrixRasterData::resampleMode () const"

.PP
\fBReturns:\fP
.RS 4
resampling algorithm 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetResampleMode()\fP, \fBvalue()\fP 
.RE
.PP

.SS "void QwtMatrixRasterData::setInterval (Qt::Axisaxis, const \fBQwtInterval\fP &interval)\fC [virtual]\fP"

.PP
Assign the bounding interval for an axis\&. Setting the bounding intervals for the X/Y axis is mandatory to define the positions for the values of the value matrix\&. The interval in Z direction defines the possible range for the values in the matrix, what is f\&.e used by \fBQwtPlotSpectrogram\fP to map values to colors\&. The Z-interval might be the bounding interval of the values in the matrix, but usually it isn't\&. ( f\&.e a interval of 0\&.0-100\&.0 for values in percentage )
.PP
\fBParameters:\fP
.RS 4
\fIaxis\fP X, Y or Z axis 
.br
\fIinterval\fP Interval
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBQwtRasterData::interval()\fP, \fBsetValueMatrix()\fP 
.RE
.PP

.PP
Reimplemented from \fBQwtRasterData\fP\&.
.SS "void QwtMatrixRasterData::setResampleMode (\fBResampleMode\fPmode)"

.PP
Set the resampling algorithm\&. 
.PP
\fBParameters:\fP
.RS 4
\fImode\fP Resampling mode 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBresampleMode()\fP, \fBvalue()\fP 
.RE
.PP

.SS "void QwtMatrixRasterData::setValue (introw, intcol, doublevalue)"

.PP
Change a single value in the matrix\&. 
.PP
\fBParameters:\fP
.RS 4
\fIrow\fP Row index 
.br
\fIcol\fP Column index 
.br
\fIvalue\fP New value
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalue()\fP, \fBsetValueMatrix()\fP 
.RE
.PP

.SS "void QwtMatrixRasterData::setValueMatrix (const QVector< double > &values, intnumColumns)"

.PP
Assign a value matrix\&. The positions of the values are calculated by dividing the bounding rectangle of the X/Y intervals into equidistant rectangles ( pixels )\&. Each value corresponds to the center of a pixel\&.
.PP
\fBParameters:\fP
.RS 4
\fIvalues\fP Vector of values 
.br
\fInumColumns\fP Number of columns
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalueMatrix()\fP, \fBnumColumns()\fP, \fBnumRows()\fP, \fBsetInterval()\fP() 
.RE
.PP

.SS "double QwtMatrixRasterData::value (doublex, doubley) const\fC [virtual]\fP"

.PP
\fBReturns:\fP
.RS 4
the value at a raster position
.RE
.PP
\fBParameters:\fP
.RS 4
\fIx\fP X value in plot coordinates 
.br
\fIy\fP Y value in plot coordinates
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBResampleMode\fP 
.RE
.PP

.PP
Implements \fBQwtRasterData\fP\&.
.SS "const QVector< double > QwtMatrixRasterData::valueMatrix () const"

.PP
\fBReturns:\fP
.RS 4
Value matrix 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetValueMatrix()\fP, \fBnumColumns()\fP, \fBnumRows()\fP, \fBsetInterval()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.