Add files from zip
This commit is contained in:
359
doc/man/man3/QwtPlotSpectroCurve.3
Normal file
359
doc/man/man3/QwtPlotSpectroCurve.3
Normal file
@@ -0,0 +1,359 @@
|
||||
.TH "QwtPlotSpectroCurve" 3 "Sun Jul 18 2021" "Version 6.2.0" "Qwt User's Guide" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
QwtPlotSpectroCurve \- Curve that displays 3D points as dots, where the z coordinate is mapped to a color\&.
|
||||
|
||||
.SH SYNOPSIS
|
||||
.br
|
||||
.PP
|
||||
.PP
|
||||
\fC#include <qwt_plot_spectrocurve\&.h>\fP
|
||||
.PP
|
||||
Inherits \fBQwtPlotSeriesItem\fP, and \fBQwtSeriesStore< QwtPoint3D >\fP\&.
|
||||
.SS "Public Types"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "enum \fBPaintAttribute\fP { \fBClipPoints\fP = 1 }"
|
||||
.br
|
||||
.RI "Paint attributes\&. "
|
||||
.ti -1c
|
||||
.RI "typedef QFlags< \fBPaintAttribute\fP > \fBPaintAttributes\fP"
|
||||
.br
|
||||
.in -1c
|
||||
.SS "Public Member Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "\fBQwtPlotSpectroCurve\fP (const QString &\fBtitle\fP=QString())"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "\fBQwtPlotSpectroCurve\fP (const \fBQwtText\fP &\fBtitle\fP)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "virtual \fB~QwtPlotSpectroCurve\fP ()"
|
||||
.br
|
||||
.RI "Destructor\&. "
|
||||
.ti -1c
|
||||
.RI "virtual int \fBrtti\fP () const override"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetPaintAttribute\fP (\fBPaintAttribute\fP, bool on=true)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBtestPaintAttribute\fP (\fBPaintAttribute\fP) const"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetSamples\fP (const \fBQVector\fP< \fBQwtPoint3D\fP > &)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetSamples\fP (\fBQwtSeriesData\fP< \fBQwtPoint3D\fP > *)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetColorMap\fP (\fBQwtColorMap\fP *)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "const \fBQwtColorMap\fP * \fBcolorMap\fP () const"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetColorRange\fP (const \fBQwtInterval\fP &)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "\fBQwtInterval\fP & \fBcolorRange\fP () const"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "virtual void \fBdrawSeries\fP (QPainter *, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRectF &canvasRect, int from, int to) const override"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBsetPenWidth\fP (double)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "double \fBpenWidth\fP () const"
|
||||
.br
|
||||
.in -1c
|
||||
.SS "Protected Member Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "virtual void \fBdrawDots\fP (QPainter *, const \fBQwtScaleMap\fP &xMap, const \fBQwtScaleMap\fP &yMap, const QRectF &canvasRect, int from, int to) const"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
Curve that displays 3D points as dots, where the z coordinate is mapped to a color\&.
|
||||
.PP
|
||||
Definition at line 22 of file qwt_plot_spectrocurve\&.h\&.
|
||||
.SH "Member Typedef Documentation"
|
||||
.PP
|
||||
.SS "typedef QFlags<\fBPaintAttribute\fP > \fBQwtPlotSpectroCurve::PaintAttributes\fP"
|
||||
An ORed combination of \fBPaintAttribute\fP values\&.
|
||||
.PP
|
||||
Definition at line 34 of file qwt_plot_spectrocurve\&.h\&.
|
||||
.SH "Member Enumeration Documentation"
|
||||
.PP
|
||||
.SS "enum \fBQwtPlotSpectroCurve::PaintAttribute\fP"
|
||||
|
||||
.PP
|
||||
Paint attributes\&.
|
||||
.PP
|
||||
\fBEnumerator\fP
|
||||
.in +1c
|
||||
.TP
|
||||
\fB\fIClipPoints \fP\fP
|
||||
Clip points outside the canvas rectangle\&.
|
||||
.PP
|
||||
Definition at line 28 of file qwt_plot_spectrocurve\&.h\&.
|
||||
.SH "Constructor & Destructor Documentation"
|
||||
.PP
|
||||
.SS "QwtPlotSpectroCurve::QwtPlotSpectroCurve (const QString & title = \fCQString()\fP)\fC [explicit]\fP"
|
||||
Constructor
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fItitle\fP Title of the curve
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 55 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "QwtPlotSpectroCurve::QwtPlotSpectroCurve (const \fBQwtText\fP & title)\fC [explicit]\fP"
|
||||
Constructor
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fItitle\fP Title of the curve
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 45 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SH "Member Function Documentation"
|
||||
.PP
|
||||
.SS "const \fBQwtColorMap\fP * QwtPlotSpectroCurve::colorMap () const"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Color Map used for mapping the intensity values to colors
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBsetColorMap()\fP, \fBsetColorRange()\fP, \fBQwtColorMap::color()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 163 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "\fBQwtInterval\fP & QwtPlotSpectroCurve::colorRange () const"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Value interval, that corresponds to the color map
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBsetColorRange()\fP, \fBsetColorMap()\fP, \fBQwtColorMap::color()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 191 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::drawDots (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRectF & canvasRect, int from, int to) const\fC [protected]\fP, \fC [virtual]\fP"
|
||||
Draw a subset of the points
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIpainter\fP Painter
|
||||
.br
|
||||
\fIxMap\fP Maps x-values into pixel coordinates\&.
|
||||
.br
|
||||
\fIyMap\fP Maps y-values into pixel coordinates\&.
|
||||
.br
|
||||
\fIcanvasRect\fP Contents rectangle of the canvas
|
||||
.br
|
||||
\fIfrom\fP Index of the first sample to be painted
|
||||
.br
|
||||
\fIto\fP Index of the last sample to be painted\&. If to < 0 the series will be painted to its last sample\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBdrawSeries()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 270 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::drawSeries (QPainter * painter, const \fBQwtScaleMap\fP & xMap, const \fBQwtScaleMap\fP & yMap, const QRectF & canvasRect, int from, int to) const\fC [override]\fP, \fC [virtual]\fP"
|
||||
Draw a subset of the points
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIpainter\fP Painter
|
||||
.br
|
||||
\fIxMap\fP Maps x-values into pixel coordinates\&.
|
||||
.br
|
||||
\fIyMap\fP Maps y-values into pixel coordinates\&.
|
||||
.br
|
||||
\fIcanvasRect\fP Contents rectangle of the canvas
|
||||
.br
|
||||
\fIfrom\fP Index of the first sample to be painted
|
||||
.br
|
||||
\fIto\fP Index of the last sample to be painted\&. If to < 0 the series will be painted to its last sample\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBdrawDots()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Implements \fBQwtPlotSeriesItem\fP\&.
|
||||
.PP
|
||||
Definition at line 238 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "double QwtPlotSpectroCurve::penWidth () const"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
Pen width used to draw a dot
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBsetPenWidth()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 220 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "int QwtPlotSpectroCurve::rtti () const\fC [override]\fP, \fC [virtual]\fP"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
\fBQwtPlotItem::Rtti_PlotSpectroCurve\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Reimplemented from \fBQwtPlotItem\fP\&.
|
||||
.PP
|
||||
Definition at line 82 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setColorMap (\fBQwtColorMap\fP * colorMap)"
|
||||
Change the color map
|
||||
.PP
|
||||
Often it is useful to display the mapping between intensities and colors as an additional plot axis, showing a color bar\&.
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIcolorMap\fP Color Map
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBcolorMap()\fP, \fBsetColorRange()\fP, \fBQwtColorMap::color()\fP, \fBQwtScaleWidget::setColorBarEnabled()\fP, \fBQwtScaleWidget::setColorMap()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 147 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setColorRange (const \fBQwtInterval\fP & interval)"
|
||||
Set the value interval, that corresponds to the color map
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIinterval\fP interval\&.minValue() corresponds to 0\&.0, interval\&.maxValue() to 1\&.0 on the color map\&.
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBcolorRange()\fP, \fBsetColorMap()\fP, \fBQwtColorMap::color()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 176 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setPaintAttribute (\fBPaintAttribute\fP attribute, bool on = \fCtrue\fP)"
|
||||
Specify an attribute how to draw the curve
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIattribute\fP Paint attribute
|
||||
.br
|
||||
\fIon\fP On/Off /sa PaintAttribute, \fBtestPaintAttribute()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 94 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setPenWidth (double penWidth)"
|
||||
Assign a pen width
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIpenWidth\fP New pen width
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBpenWidth()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 202 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setSamples (const \fBQVector\fP< \fBQwtPoint3D\fP > & samples)"
|
||||
Initialize data with an array of samples\&.
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIsamples\fP Vector of points
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 115 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "void QwtPlotSpectroCurve::setSamples (\fBQwtSeriesData\fP< \fBQwtPoint3D\fP > * data)"
|
||||
Assign a series of samples
|
||||
.PP
|
||||
\fBsetSamples()\fP is just a wrapper for \fBsetData()\fP without any additional value - beside that it is easier to find for the developer\&.
|
||||
.PP
|
||||
\fBParameters\fP
|
||||
.RS 4
|
||||
\fIdata\fP Data
|
||||
.RE
|
||||
.PP
|
||||
\fBWarning\fP
|
||||
.RS 4
|
||||
The item takes ownership of the data object, deleting it when its not used anymore\&.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 130 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
.SS "bool QwtPlotSpectroCurve::testPaintAttribute (\fBPaintAttribute\fP attribute) const"
|
||||
|
||||
.PP
|
||||
\fBReturns\fP
|
||||
.RS 4
|
||||
True, when attribute is enabled
|
||||
.RE
|
||||
.PP
|
||||
\fBSee also\fP
|
||||
.RS 4
|
||||
\fBPaintAttribute\fP, \fBsetPaintAttribute()\fP
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.PP
|
||||
Definition at line 106 of file qwt_plot_spectrocurve\&.cpp\&.
|
||||
|
||||
.SH "Author"
|
||||
.PP
|
||||
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.
|
||||
Reference in New Issue
Block a user