← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtColorMap.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
qwt-5.1.2/doc/man/man3/QwtColorMap.3
 
1
.TH "QwtColorMap" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtColorMap \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
Inherited by \fBQwtAlphaColorMap\fP, and \fBQwtLinearColorMap\fP.
 
10
.PP
 
11
.SH "Detailed Description"
 
12
.PP 
 
13
\fBQwtColorMap\fP is used to map values into colors. 
 
14
 
 
15
For displaying 3D data on a 2D plane the 3rd dimension is often displayed using colors, like f.e in a spectrogram.
 
16
.PP
 
17
Each color map is optimized to return colors for only one of the following image formats:
 
18
.PP
 
19
.IP "\(bu" 2
 
20
QImage::Format_Indexed8
 
21
.br
 
22
 
 
23
.IP "\(bu" 2
 
24
QImage::Format_ARGB32
 
25
.br
 
26
 
 
27
.PP
 
28
.PP
 
29
\fBSee also:\fP
 
30
.RS 4
 
31
\fBQwtPlotSpectrogram\fP, \fBQwtScaleWidget\fP 
 
32
.RE
 
33
.PP
 
34
 
 
35
.PP
 
36
Definition at line 44 of file qwt_color_map.h.
 
37
.SS "Public Types"
 
38
 
 
39
.in +1c
 
40
.ti -1c
 
41
.RI "enum \fBFormat\fP { \fBRGB\fP, \fBIndexed\fP }"
 
42
.br
 
43
.in -1c
 
44
.SS "Public Member Functions"
 
45
 
 
46
.in +1c
 
47
.ti -1c
 
48
.RI "\fBQwtColorMap\fP (\fBFormat\fP=QwtColorMap::RGB)"
 
49
.br
 
50
.ti -1c
 
51
.RI "virtual \fB~QwtColorMap\fP ()"
 
52
.br
 
53
.ti -1c
 
54
.RI "\fBFormat\fP \fBformat\fP () const"
 
55
.br
 
56
.ti -1c
 
57
.RI "virtual \fBQwtColorMap\fP * \fBcopy\fP () const=0"
 
58
.br
 
59
.ti -1c
 
60
.RI "virtual QRgb \fBrgb\fP (const \fBQwtDoubleInterval\fP &interval, double value) const=0"
 
61
.br
 
62
.ti -1c
 
63
.RI "virtual unsigned char \fBcolorIndex\fP (const \fBQwtDoubleInterval\fP &interval, double value) const=0"
 
64
.br
 
65
.ti -1c
 
66
.RI "QColor \fBcolor\fP (const \fBQwtDoubleInterval\fP &, double value) const"
 
67
.br
 
68
.ti -1c
 
69
.RI "virtual QVector< QRgb > \fBcolorTable\fP (const \fBQwtDoubleInterval\fP &) const"
 
70
.br
 
71
.in -1c
 
72
.SH "Member Enumeration Documentation"
 
73
.PP 
 
74
.SS "enum \fBQwtColorMap::Format\fP"
 
75
.PP
 
76
.IP "\(bu" 2
 
77
RGB
 
78
.br
 
79
 The map is intended to map into QRgb values.
 
80
.IP "\(bu" 2
 
81
Indexed
 
82
.br
 
83
 The map is intended to map into 8 bit values, that are indices into the color table.
 
84
.PP
 
85
.PP
 
86
\fBSee also:\fP
 
87
.RS 4
 
88
\fBrgb()\fP, \fBcolorIndex()\fP, \fBcolorTable()\fP 
 
89
.RE
 
90
.PP
 
91
 
 
92
.PP
 
93
Definition at line 57 of file qwt_color_map.h.
 
94
.SH "Constructor & Destructor Documentation"
 
95
.PP 
 
96
.SS "QwtColorMap::QwtColorMap (\fBFormat\fP = \fCQwtColorMap::RGB\fP)"
 
97
.PP
 
98
Constructor. 
 
99
.PP
 
100
Definition at line 164 of file qwt_color_map.cpp.
 
101
.SS "QwtColorMap::~QwtColorMap ()\fC [virtual]\fP"
 
102
.PP
 
103
Destructor. 
 
104
.PP
 
105
Definition at line 170 of file qwt_color_map.cpp.
 
106
.SH "Member Function Documentation"
 
107
.PP 
 
108
.SS "\fBQwtColorMap::Format\fP QwtColorMap::format () const\fC [inline]\fP"
 
109
.PP
 
110
\fBReturns:\fP
 
111
.RS 4
 
112
Intended format of the color map 
 
113
.RE
 
114
.PP
 
115
\fBSee also:\fP
 
116
.RS 4
 
117
\fBFormat\fP 
 
118
.RE
 
119
.PP
 
120
 
 
121
.PP
 
122
Definition at line 216 of file qwt_color_map.h.
 
123
.PP
 
124
Referenced by QwtPainter::drawColorBar().
 
125
.SS "virtual \fBQwtColorMap\fP* QwtColorMap::copy () const\fC [pure virtual]\fP"
 
126
.PP
 
127
Clone the color map. 
 
128
.PP
 
129
Implemented in \fBQwtLinearColorMap\fP, and \fBQwtAlphaColorMap\fP.
 
130
.PP
 
131
Referenced by QwtScaleWidget::setColorMap(), and QwtPlotSpectrogram::setColorMap().
 
132
.SS "virtual QRgb QwtColorMap::rgb (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [pure virtual]\fP"
 
133
.PP
 
134
Map a value of a given interval into a rgb value. 
 
135
.PP
 
136
\fBParameters:\fP
 
137
.RS 4
 
138
\fIinterval\fP Range for the values 
 
139
.br
 
140
\fIvalue\fP Value 
 
141
.RE
 
142
.PP
 
143
\fBReturns:\fP
 
144
.RS 4
 
145
rgb value, corresponding to value 
 
146
.RE
 
147
.PP
 
148
 
 
149
.PP
 
150
Implemented in \fBQwtLinearColorMap\fP, and \fBQwtAlphaColorMap\fP.
 
151
.PP
 
152
Referenced by color(), colorTable(), and QwtPainter::drawColorBar().
 
153
.SS "virtual unsigned char QwtColorMap::colorIndex (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [pure virtual]\fP"
 
154
.PP
 
155
Map a value of a given interval into a color index 
 
156
.PP
 
157
\fBParameters:\fP
 
158
.RS 4
 
159
\fIinterval\fP Range for the values 
 
160
.br
 
161
\fIvalue\fP Value 
 
162
.RE
 
163
.PP
 
164
\fBReturns:\fP
 
165
.RS 4
 
166
color index, corresponding to value 
 
167
.RE
 
168
.PP
 
169
 
 
170
.PP
 
171
Implemented in \fBQwtLinearColorMap\fP.
 
172
.PP
 
173
Referenced by color(), and QwtPainter::drawColorBar().
 
174
.SS "QColor QwtColorMap::color (const \fBQwtDoubleInterval\fP & interval, double value) const\fC [inline]\fP"
 
175
.PP
 
176
Map a value into a color
 
177
.PP
 
178
\fBParameters:\fP
 
179
.RS 4
 
180
\fIinterval\fP Valid interval for values 
 
181
.br
 
182
\fIvalue\fP Value
 
183
.RE
 
184
.PP
 
185
\fBReturns:\fP
 
186
.RS 4
 
187
Color corresponding to value
 
188
.RE
 
189
.PP
 
190
\fBWarning:\fP
 
191
.RS 4
 
192
This method is slow for Indexed color maps. If it is necessary to map many values, its better to get the color table once and find the color using \fBcolorIndex()\fP. 
 
193
.RE
 
194
.PP
 
195
 
 
196
.PP
 
197
Definition at line 198 of file qwt_color_map.h.
 
198
.PP
 
199
References colorIndex(), colorTable(), and rgb().
 
200
.SS "QwtColorTable QwtColorMap::colorTable (const \fBQwtDoubleInterval\fP & interval) const\fC [virtual]\fP"
 
201
.PP
 
202
Build and return a color map of 256 colors
 
203
.PP
 
204
The color table is needed for rendering indexed images in combination with using \fBcolorIndex()\fP.
 
205
.PP
 
206
\fBParameters:\fP
 
207
.RS 4
 
208
\fIinterval\fP Range for the values 
 
209
.RE
 
210
.PP
 
211
\fBReturns:\fP
 
212
.RS 4
 
213
A color table, that can be used for a QImage 
 
214
.RE
 
215
.PP
 
216
 
 
217
.PP
 
218
Definition at line 183 of file qwt_color_map.cpp.
 
219
.PP
 
220
References QwtDoubleInterval::isValid(), QwtDoubleInterval::minValue(), rgb(), and QwtDoubleInterval::width().
 
221
.PP
 
222
Referenced by color(), and QwtPainter::drawColorBar().
 
223
 
 
224
.SH "Author"
 
225
.PP 
 
226
Generated automatically by Doxygen for Qwt User's Guide from the source code.