File: QwtRasterData.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 (224 lines) | stat: -rw-r--r-- 6,282 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
.TH "QwtRasterData" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtRasterData \- 
.PP
\fBQwtRasterData\fP defines an interface to any type of raster data\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_raster_data\&.h>\fP
.PP
Inherited by \fBQwtMatrixRasterData\fP\&.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBConrecFlag\fP { \fBIgnoreAllVerticesOnLevel\fP = 0x01, \fBIgnoreOutOfRange\fP = 0x02 }"
.br
.RI "\fIFlags to modify the contour algorithm\&. \fP"
.ti -1c
.RI "typedef QMap< double, QPolygonF > \fBContourLines\fP"
.br
.RI "\fIContour lines\&. \fP"
.ti -1c
.RI "typedef QFlags< \fBConrecFlag\fP > \fBConrecFlags\fP"
.br
.RI "\fIFlags to modify the contour algorithm\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtRasterData\fP ()"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "virtual \fB~QwtRasterData\fP ()"
.br
.RI "\fIDestructor\&. \fP"
.ti -1c
.RI "virtual void \fBsetInterval\fP (Qt::Axis, const \fBQwtInterval\fP &)"
.br
.ti -1c
.RI "const \fBQwtInterval\fP & \fBinterval\fP (Qt::Axis) const "
.br
.ti -1c
.RI "virtual QRectF \fBpixelHint\fP (const QRectF &) const "
.br
.RI "\fIPixel hint\&. \fP"
.ti -1c
.RI "virtual void \fBinitRaster\fP (const QRectF &, const QSize &raster)"
.br
.RI "\fIInitialize a raster\&. \fP"
.ti -1c
.RI "virtual void \fBdiscardRaster\fP ()"
.br
.RI "\fIDiscard a raster\&. \fP"
.ti -1c
.RI "virtual double \fBvalue\fP (double x, double y) const =0"
.br
.ti -1c
.RI "virtual \fBContourLines\fP \fBcontourLines\fP (const QRectF &rect, const QSize &raster, const QList< double > &levels, \fBConrecFlags\fP) const "
.br
.in -1c
.SH "Detailed Description"
.PP 
\fBQwtRasterData\fP defines an interface to any type of raster data\&. 

\fBQwtRasterData\fP is an abstract interface, that is used by \fBQwtPlotRasterItem\fP to find the values at the pixels of its raster\&.
.PP
Often a raster item is used to display values from a matrix\&. Then the derived raster data class needs to implement some sort of resampling, that maps the raster of the matrix into the requested raster of the raster item ( depending on resolution and scales of the canvas )\&. 
.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtRasterData::ConrecFlag\fP"

.PP
Flags to modify the contour algorithm\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIIgnoreAllVerticesOnLevel \fP\fP
Ignore all vertices on the same level\&. 
.TP
\fB\fIIgnoreOutOfRange \fP\fP
Ignore all values, that are out of range\&. 
.SH "Member Function Documentation"
.PP 
.SS "\fBQwtRasterData::ContourLines\fP QwtRasterData::contourLines (const QRectF &rect, const QSize &raster, const QList< double > &levels, \fBConrecFlags\fPflags) const\fC [virtual]\fP"
Calculate contour lines
.PP
\fBParameters:\fP
.RS 4
\fIrect\fP Bounding rectangle for the contour lines 
.br
\fIraster\fP Number of data pixels of the raster data 
.br
\fIlevels\fP List of limits, where to insert contour lines 
.br
\fIflags\fP Flags to customize the contouring algorithm
.RE
.PP
\fBReturns:\fP
.RS 4
Calculated contour lines
.RE
.PP
An adaption of CONREC, a simple contouring algorithm\&. http://local.wasp.uwa.edu.au/~pbourke/papers/conrec/ 
.SS "void QwtRasterData::discardRaster ()\fC [virtual]\fP"

.PP
Discard a raster\&. After the composition of an image \fBQwtPlotSpectrogram\fP calls \fBdiscardRaster()\fP\&.
.PP
The default implementation does nothing, but if data has been loaded in \fBinitRaster()\fP, it could deleted now\&.
.PP
\fBSee Also:\fP
.RS 4
\fBinitRaster()\fP, \fBvalue()\fP 
.RE
.PP

.SS "void QwtRasterData::initRaster (const QRectF &area, const QSize &raster)\fC [virtual]\fP"

.PP
Initialize a raster\&. Before the composition of an image \fBQwtPlotSpectrogram\fP calls \fBinitRaster()\fP, announcing the area and its resolution that will be requested\&.
.PP
The default implementation does nothing, but for data sets that are stored in files, it might be good idea to reimplement \fBinitRaster()\fP, where the data is resampled and loaded into memory\&.
.PP
\fBParameters:\fP
.RS 4
\fIarea\fP Area of the raster 
.br
\fIraster\fP Number of horizontal and vertical pixels
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBinitRaster()\fP, \fBvalue()\fP 
.RE
.PP

.SS "const \fBQwtInterval\fP & QwtRasterData::interval (Qt::Axisaxis) const\fC [inline]\fP"

.PP
\fBReturns:\fP
.RS 4
Bounding interval for a axis 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetInterval\fP 
.RE
.PP

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

.PP
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
Width and height of the hint need to be the horizontal and vertical distances between 2 neighbored points\&. The center of the hint has to be the position of any point ( it doesn't matter which one )\&.
.PP
An empty hint indicates, that there are values for any detail level\&.
.PP
Limiting the resolution of the image might significantly improve the performance and heavily reduce the amount of memory when rendering a QImage from the raster data\&.
.PP
The default implementation returns an empty rectangle recommending to render in target device ( f\&.e\&. screen ) resolution\&.
.PP
\fBParameters:\fP
.RS 4
\fIarea\fP In most implementations the resolution of the data doesn't depend on the requested area\&.
.RE
.PP
\fBReturns:\fP
.RS 4
Bounding rectangle of a pixel 
.RE
.PP

.PP
Reimplemented in \fBQwtMatrixRasterData\fP\&.
.SS "void QwtRasterData::setInterval (Qt::Axisaxis, const \fBQwtInterval\fP &interval)\fC [virtual]\fP"
Set the bounding interval for the x, y or z coordinates\&.
.PP
\fBParameters:\fP
.RS 4
\fIaxis\fP Axis 
.br
\fIinterval\fP Bounding interval
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBinterval()\fP 
.RE
.PP

.PP
Reimplemented in \fBQwtMatrixRasterData\fP\&.
.SS "virtual double QwtRasterData::value (doublex, doubley) const\fC [pure 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

.PP
Implemented in \fBQwtMatrixRasterData\fP\&.

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