~l3on/ubuntu/oneiric/qwt/fix-921430

« back to all changes in this revision

Viewing changes to qwt-5.0.2/doc/man/man3/QwtRasterData.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2007-10-05 15:20:41 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20071005152041-qmybqh4fj9jejyo2
Tags: 5.0.2-2
* Handle nostrip build option. (Closes: #437877)
* Build libqwt5-doc package in binary-indep target. (Closes: #443110)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "QwtRasterData" 3 "11 Jun 2007" "Version 5.0.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtRasterData \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by QwtPlotSpectrogram::PrivateData::DummyData.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
\fBQwtRasterData\fP defines an interface to any type of raster data. 
 
14
.PP
 
15
Definition at line 53 of file qwt_raster_data.h.
 
16
.SS "Public Types"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "typedef QMap< double, QPolygonF > \fBContourLines\fP"
 
21
.br
 
22
.ti -1c
 
23
.RI "enum \fBConrecAttribute\fP { \fBIgnoreAllVerticesOnLevel\fP =  1, \fBIgnoreOutOfRange\fP =  2 }"
 
24
.br
 
25
.in -1c
 
26
.SS "Public Member Functions"
 
27
 
 
28
.in +1c
 
29
.ti -1c
 
30
.RI "\fBQwtRasterData\fP ()"
 
31
.br
 
32
.ti -1c
 
33
.RI "\fBQwtRasterData\fP (const QwtDoubleRect &)"
 
34
.br
 
35
.ti -1c
 
36
.RI "virtual \fB~QwtRasterData\fP ()"
 
37
.br
 
38
.ti -1c
 
39
.RI "virtual \fBQwtRasterData\fP * \fBcopy\fP () const =0"
 
40
.br
 
41
.ti -1c
 
42
.RI "virtual void \fBsetBoundingRect\fP (const QwtDoubleRect &)"
 
43
.br
 
44
.ti -1c
 
45
.RI "QwtDoubleRect \fBboundingRect\fP () const "
 
46
.br
 
47
.ti -1c
 
48
.RI "virtual QSize \fBrasterHint\fP (const QwtDoubleRect &) const "
 
49
.br
 
50
.ti -1c
 
51
.RI "virtual void \fBinitRaster\fP (const QwtDoubleRect &, const QSize &raster)"
 
52
.br
 
53
.ti -1c
 
54
.RI "virtual void \fBdiscardRaster\fP ()"
 
55
.br
 
56
.ti -1c
 
57
.RI "virtual double \fBvalue\fP (double x, double y) const =0"
 
58
.br
 
59
.ti -1c
 
60
.RI "virtual \fBQwtDoubleInterval\fP \fBrange\fP () const =0"
 
61
.br
 
62
.ti -1c
 
63
.RI "virtual \fBContourLines\fP \fBcontourLines\fP (const QwtDoubleRect &rect, const QSize &raster, const QList< double > &levels, int flags) const "
 
64
.br
 
65
.in -1c
 
66
.SH "Member Function Documentation"
 
67
.PP 
 
68
.SS "\fBQwtRasterData::ContourLines\fP QwtRasterData::contourLines (const QwtDoubleRect & rect, const QSize & raster, const QList< double > & levels, int flags) const\fC [virtual]\fP"
 
69
.PP
 
70
Calculate contour lines
 
71
.PP
 
72
An adaption of CONREC, a simple contouring algorithm. http://astronomy.swin.edu.au/~pbourke/projection/conrec 
 
73
.PP
 
74
Definition at line 270 of file qwt_raster_data.cpp.
 
75
.PP
 
76
References QwtDoubleInterval::isValid().
 
77
.SS "virtual \fBQwtRasterData\fP* QwtRasterData::copy () const\fC [pure virtual]\fP"
 
78
.PP
 
79
Clone the data. 
 
80
.PP
 
81
Referenced by QwtPlotSpectrogram::setData().
 
82
.SS "void QwtRasterData::discardRaster ()\fC [virtual]\fP"
 
83
.PP
 
84
Discard a raster. 
 
85
.PP
 
86
After the composition of an image \fBQwtPlotSpectrogram\fP calls \fBdiscardRaster()\fP.
 
87
.PP
 
88
The default implementation does nothing, but if data has been loaded in \fBinitRaster()\fP, it could deleted now.
 
89
.PP
 
90
\fBSee also:\fP
 
91
.RS 4
 
92
\fBinitRaster()\fP, \fBvalue()\fP 
 
93
.RE
 
94
.PP
 
95
 
 
96
.PP
 
97
Definition at line 236 of file qwt_raster_data.cpp.
 
98
.SS "void QwtRasterData::initRaster (const QwtDoubleRect &, const QSize & raster)\fC [virtual]\fP"
 
99
.PP
 
100
Initialize a raster. 
 
101
.PP
 
102
Before the composition of an image \fBQwtPlotSpectrogram\fP calls initRaster, announcing the area and its resolution that will be requested.
 
103
.PP
 
104
The default implementation does nothing, but for data sets that are stored in files, it might be good idea to reimplement initRaster, where the data is resampled and loaded into memory.
 
105
.PP
 
106
\fBParameters:\fP
 
107
.RS 4
 
108
\fIrect\fP Area of the raster 
 
109
.br
 
110
\fIraster\fP Number of horizontal and vertical pixels
 
111
.RE
 
112
.PP
 
113
\fBSee also:\fP
 
114
.RS 4
 
115
\fBinitRaster()\fP, \fBvalue()\fP 
 
116
.RE
 
117
.PP
 
118
 
 
119
.PP
 
120
Definition at line 222 of file qwt_raster_data.cpp.
 
121
.SS "virtual \fBQwtDoubleInterval\fP QwtRasterData::range () const\fC [pure virtual]\fP"
 
122
.PP
 
123
\fBReturns:\fP
 
124
.RS 4
 
125
the range of the values 
 
126
.RE
 
127
.PP
 
128
 
 
129
.SS "QSize QwtRasterData::rasterHint (const QwtDoubleRect &) const\fC [virtual]\fP"
 
130
.PP
 
131
Find the raster of the data for an area. 
 
132
.PP
 
133
The resolution is the number of horizontal and vertical pixels that the data can return for an area. An invalid resolution indicates that the data can return values for any detail level.
 
134
.PP
 
135
The resolution will limit the size of the image that is rendered from the data. F.e. this might be important when printing a spectrogram to a A0 printer with 600 dpi.
 
136
.PP
 
137
The default implementation returns an invalid resolution (size)
 
138
.PP
 
139
\fBParameters:\fP
 
140
.RS 4
 
141
\fIrect\fP In most implementations the resolution of the data doesn't depend on the requested rectangle.
 
142
.RE
 
143
.PP
 
144
\fBReturns:\fP
 
145
.RS 4
 
146
Resolution, as number of horizontal and vertical pixels 
 
147
.RE
 
148
.PP
 
149
 
 
150
.PP
 
151
Definition at line 258 of file qwt_raster_data.cpp.
 
152
.SS "virtual double QwtRasterData::value (double x, double y) const\fC [pure virtual]\fP"
 
153
.PP
 
154
\fBReturns:\fP
 
155
.RS 4
 
156
the value at a raster position 
 
157
.RE
 
158
.PP
 
159
 
 
160
 
 
161
.SH "Author"
 
162
.PP 
 
163
Generated automatically by Doxygen for Qwt User's Guide from the source code.