Dhanya Thattil 38cd10d4e6
Qt5 built in qwt (#570)
- qt4->qt5
- in built qt5 6.1.5 because rhel7 is not upto date with qt5, removed findqwt.cmake
- made a fix in qwt lib (qwt_plot_layout.h) to work with 5.15 and lower versions for qrect constr.
- qt5 forms fixed, qt4 many hard coding forms switched to forms including qtabwidget, scrolls etc, fonts moved to forms
 - docking option enabled by default, removed option to disable docking feature from "Mode"
- added qVersionResolve utility functions to handle compatibility before and after qt5.12
- qtplots (ian's code) takes in gain mode enable to set some settings within the class, with proper gain plot ticks
- ensure gain plots have no zooming of z axis in 2d and y axis in 1d
- removed placeholder text in qpalette in main window form as its not supportd until 5.12 (so using qt5.9 designer insted of qt5.15 to cope)
- tab order
Servers:
- fixed some error messages that were empty for fail in funcs (mostly minor as if this error, major issues)
2022-11-11 15:15:10 +01:00

300 lines
5.6 KiB
Groff

.TH "QwtSpline" 3 "Mon Jun 1 2020" "Version 6.1.5" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtSpline \- A class for spline interpolation\&.
.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_spline\&.h>\fP
.SS "Public Types"
.in +1c
.ti -1c
.RI "enum \fBSplineType\fP { \fBNatural\fP, \fBPeriodic\fP }"
.br
.RI "Spline type\&. "
.in -1c
.SS "Public Member Functions"
.in +1c
.ti -1c
.RI "\fBQwtSpline\fP ()"
.br
.RI "Constructor\&. "
.ti -1c
.RI "\fBQwtSpline\fP (const \fBQwtSpline\fP &)"
.br
.ti -1c
.RI "\fB~QwtSpline\fP ()"
.br
.RI "Destructor\&. "
.ti -1c
.RI "\fBQwtSpline\fP & \fBoperator=\fP (const \fBQwtSpline\fP &)"
.br
.ti -1c
.RI "void \fBsetSplineType\fP (\fBSplineType\fP)"
.br
.ti -1c
.RI "\fBSplineType\fP \fBsplineType\fP () const"
.br
.ti -1c
.RI "bool \fBsetPoints\fP (const QPolygonF &\fBpoints\fP)"
.br
.RI "Calculate the spline coefficients\&. "
.ti -1c
.RI "QPolygonF \fBpoints\fP () const"
.br
.ti -1c
.RI "void \fBreset\fP ()"
.br
.RI "Free allocated memory and set size to 0\&. "
.ti -1c
.RI "bool \fBisValid\fP () const"
.br
.RI "True if valid\&. "
.ti -1c
.RI "double \fBvalue\fP (double x) const"
.br
.ti -1c
.RI "const QVector< double > & \fBcoefficientsA\fP () const"
.br
.ti -1c
.RI "const QVector< double > & \fBcoefficientsB\fP () const"
.br
.ti -1c
.RI "const QVector< double > & \fBcoefficientsC\fP () const"
.br
.in -1c
.SS "Protected Member Functions"
.in +1c
.ti -1c
.RI "bool \fBbuildNaturalSpline\fP (const QPolygonF &)"
.br
.RI "Determines the coefficients for a natural spline\&. "
.ti -1c
.RI "bool \fBbuildPeriodicSpline\fP (const QPolygonF &)"
.br
.RI "Determines the coefficients for a periodic spline\&. "
.in -1c
.SH "Detailed Description"
.PP
A class for spline interpolation\&.
The \fBQwtSpline\fP class is used for cubical spline interpolation\&. Two types of splines, natural and periodic, are supported\&.
.PP
\fBUsage:\fP
.RS 4
.PD 0
.IP "1." 4
First call \fBsetPoints()\fP to determine the spline coefficients for a tabulated function y(x)\&.
.IP "2." 4
After the coefficients have been set up, the interpolated function value for an argument x can be determined by calling \fBQwtSpline::value()\fP\&.
.PP
.RE
.PP
\fBExample:\fP
.RS 4
.PP
.nf
#include <qwt_spline\&.h>
QPolygonF interpolate(const QPolygonF& points, int numValues)
{
QwtSpline spline;
if ( !spline\&.setPoints(points) )
return points;
QPolygonF interpolatedPoints(numValues);
const double delta =
(points[numPoints - 1]\&.x() - points[0]\&.x()) / (points\&.size() - 1);
for(i = 0; i < points\&.size(); i++) / interpolate
{
const double x = points[0]\&.x() + i * delta;
interpolatedPoints[i]\&.setX(x);
interpolatedPoints[i]\&.setY(spline\&.value(x));
}
return interpolatedPoints;
}
.fi
.PP
.RE
.PP
.SH "Member Enumeration Documentation"
.PP
.SS "enum \fBQwtSpline::SplineType\fP"
.PP
Spline type\&.
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fINatural \fP\fP
A natural spline\&.
.TP
\fB\fIPeriodic \fP\fP
A periodic spline\&.
.SH "Constructor & Destructor Documentation"
.PP
.SS "QwtSpline::QwtSpline (const \fBQwtSpline\fP & other)"
Copy constructor
.PP
\fBParameters\fP
.RS 4
\fIother\fP Spline used for initialization
.RE
.PP
.SH "Member Function Documentation"
.PP
.SS "bool QwtSpline::buildNaturalSpline (const QPolygonF & points)\fC [protected]\fP"
.PP
Determines the coefficients for a natural spline\&.
.PP
\fBReturns\fP
.RS 4
true if successful
.RE
.PP
.SS "bool QwtSpline::buildPeriodicSpline (const QPolygonF & points)\fC [protected]\fP"
.PP
Determines the coefficients for a periodic spline\&.
.PP
\fBReturns\fP
.RS 4
true if successful
.RE
.PP
.SS "const QVector< double > & QwtSpline::coefficientsA () const"
.PP
\fBReturns\fP
.RS 4
A coefficients
.RE
.PP
.SS "const QVector< double > & QwtSpline::coefficientsB () const"
.PP
\fBReturns\fP
.RS 4
B coefficients
.RE
.PP
.SS "const QVector< double > & QwtSpline::coefficientsC () const"
.PP
\fBReturns\fP
.RS 4
C coefficients
.RE
.PP
.SS "\fBQwtSpline\fP & QwtSpline::operator= (const \fBQwtSpline\fP & other)"
Assignment operator
.PP
\fBParameters\fP
.RS 4
\fIother\fP Spline used for initialization
.RE
.PP
\fBReturns\fP
.RS 4
*this
.RE
.PP
.SS "QPolygonF QwtSpline::points () const"
.PP
\fBReturns\fP
.RS 4
Points, that have been by \fBsetPoints()\fP
.RE
.PP
.SS "bool QwtSpline::setPoints (const QPolygonF & points)"
.PP
Calculate the spline coefficients\&. Depending on the value of \fIperiodic\fP, this function will determine the coefficients for a natural or a periodic spline and store them internally\&.
.PP
\fBParameters\fP
.RS 4
\fIpoints\fP Points
.RE
.PP
\fBReturns\fP
.RS 4
true if successful
.RE
.PP
\fBWarning\fP
.RS 4
The sequence of x (but not y) values has to be strictly monotone increasing, which means \fCpoints[i]\&.x() < points[i+1]\&.x()\fP\&. If this is not the case, the function will return false
.RE
.PP
.SS "void QwtSpline::setSplineType (\fBSplineType\fP splineType)"
Select the algorithm used for calculating the spline
.PP
\fBParameters\fP
.RS 4
\fIsplineType\fP Spline type
.RE
.PP
\fBSee also\fP
.RS 4
\fBsplineType()\fP
.RE
.PP
.SS "\fBQwtSpline::SplineType\fP QwtSpline::splineType () const"
.PP
\fBReturns\fP
.RS 4
the spline type
.RE
.PP
\fBSee also\fP
.RS 4
\fBsetSplineType()\fP
.RE
.PP
.SS "double QwtSpline::value (double x) const"
Calculate the interpolated function value corresponding to a given argument x\&.
.PP
\fBParameters\fP
.RS 4
\fIx\fP Coordinate
.RE
.PP
\fBReturns\fP
.RS 4
Interpolated coordinate
.RE
.PP
.SH "Author"
.PP
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.