JKQTPlotter trunk/v5.0.0
an extensive Qt5+Qt6 Plotter framework (including a feature-richt plotter widget, a speed-optimized, but limited variant and a LaTeX equation renderer!), written fully in C/C++ and without external dependencies
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
JKQTPYFunctionLineGraph Class Reference
JKQTPlotter: Qt based Scientific Plotter Class » Type/Class/Function Documentation » Plot Element Classes » Concrete Graph Classes » Line/Symbol Graphs » Function Graphs

This implements line plots where the data is taken from a user supplied function $ x=f(y) $. More...

#include <jkqtpevaluatedfunction.h>

Inheritance diagram for JKQTPYFunctionLineGraph:
[legend]
Collaboration diagram for JKQTPYFunctionLineGraph:
[legend]

Public Member Functions

 JKQTPYFunctionLineGraph (const jkqtpSimplePlotFunctionType &f, const QString &title, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPYFunctionLineGraph (const jkqtpSimplePlotFunctionType &f, const QString &title, JKQTPlotter *parent)
 class constructor
 
 JKQTPYFunctionLineGraph (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPYFunctionLineGraph (JKQTPlotter *parent)
 class constructor
 
 JKQTPYFunctionLineGraph (jkqtpSimplePlotFunctionType &&f, const QString &title, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPYFunctionLineGraph (jkqtpSimplePlotFunctionType &&f, const QString &title, JKQTPlotter *parent)
 class constructor
 
 JKQTPYFunctionLineGraph (SpecialFunction type, const QVector< double > &params, const QString &title, JKQTBasePlotter *parent)
 class constructor
 
 JKQTPYFunctionLineGraph (SpecialFunction type, const QVector< double > &params, const QString &title, JKQTPlotter *parent)
 class constructor
 
virtual void draw (JKQTPEnhancedPainter &painter) override
 plots the graph to the plotter object specified as parent
 
- Public Member Functions inherited from JKQTPFunctorLineGraphBase
 JKQTPFunctorLineGraphBase (const jkqtpSimplePlotFunctionType &f, const QString &title, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPFunctorLineGraphBase (const jkqtpSimplePlotFunctionType &f, const QString &title, JKQTPlotter *parent)
 class constructor
 
 JKQTPFunctorLineGraphBase (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPFunctorLineGraphBase (JKQTPlotter *parent)
 class constructor
 
 JKQTPFunctorLineGraphBase (jkqtpSimplePlotFunctionType &&f, const QString &title, JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPFunctorLineGraphBase (jkqtpSimplePlotFunctionType &&f, const QString &title, JKQTPlotter *parent)
 class constructor
 
 JKQTPFunctorLineGraphBase (SpecialFunction type, const QVector< double > &params, const QString &title, JKQTBasePlotter *parent)
 class constructor
 
 JKQTPFunctorLineGraphBase (SpecialFunction type, const QVector< double > &params, const QString &title, JKQTPlotter *parent)
 class constructor
 
virtual ~JKQTPFunctorLineGraphBase () override
 class destructor
 
virtual jkqtpPlotFunctionType getErrorPlotFunction () const
 this function calculates the error at a given position
 
virtual jkqtpSimplePlotFunctionType getErrorSimplePlotFunction () const
 this function calculates the error at a given position, simplified form without parameters
 
virtual jkqtpPlotFunctionType getPlotFunctionFunctor () const
 the function to be plotted
 
virtual jkqtpSimplePlotFunctionType getSimplePlotFunction () const
 a simple function to be plotted, simplified form without parameters
 
bool isSimplePlotFunction () const
 returns whether the plot function was defined as a jkqtpSimpleParametricCurveFunctionType (true ) or a jkqtpParametricCurveFunctionType (false )
 
virtual void setErrorPlotFunction (const jkqtpPlotFunctionType &__value)
 sets a functor to be used for calculating errors
 
virtual void setErrorPlotFunction (const jkqtpSimplePlotFunctionType &__value)
 sets a functor to be used for calculating errors
 
virtual void setErrorPlotFunction (jkqtpPlotFunctionType &&__value)
 sets a functor to be used for calculating errors
 
virtual void setErrorPlotFunction (jkqtpSimplePlotFunctionType &&__value)
 sets a functor to be used for calculating errors
 
virtual void setPlotFunctionFunctor (const jkqtpPlotFunctionType &__value)
 sets a functor to be plotted
 
virtual void setPlotFunctionFunctor (const jkqtpSimplePlotFunctionType &__value)
 sets a functor to be plotted
 
virtual void setPlotFunctionFunctor (jkqtpPlotFunctionType &&__value)
 sets a functor to be plotted
 
virtual void setPlotFunctionFunctor (jkqtpSimplePlotFunctionType &&__value)
 sets a functor to be plotted
 
void setSpecialFunction (SpecialFunction function)
 sets function to the given special function
 
- Public Member Functions inherited from JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase
 JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase (JKQTPlotter *parent)
 class constructor
 
virtual ~JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase () override
 class destructor
 
virtual void drawKeyMarker (JKQTPEnhancedPainter &painter, const QRectF &rect) override
 plots a key marker inside the specified rectangle rect
 
bool getDrawErrorLines () const
 indicates whether error lines should be drawn
 
bool getDrawErrorPolygons () const
 indicates whether an error polygon should be drawn
 
virtual QColor getErrorFillColor () const
 color of the error graph fill
 
virtual Qt::BrushStyle getErrorFillStyle () const
 fill style, if the error curve should be filled
 
virtual QColor getErrorLineColor () const
 color of the error graph
 
virtual Qt::PenStyle getErrorLineStyle () const
 linestyle of the error graph lines
 
virtual double getErrorLineWidth () const
 width (pixels) of the error graph
 
virtual QColor getKeyLabelColor () const override
 returns the color to be used for the key label
 
- Public Member Functions inherited from JKQTPEvaluatedFunctionWithErrorsGraphBase
 JKQTPEvaluatedFunctionWithErrorsGraphBase (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPEvaluatedFunctionWithErrorsGraphBase (JKQTPlotter *parent)
 class constructor
 
virtual ~JKQTPEvaluatedFunctionWithErrorsGraphBase ()
 class destructor
 
int getErrorParameterColumn () const
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the error plot function
 
QVector< double > & getInternalErrorParams ()
 returns the currently set internal parameter vector
 
const QVector< double > & getInternalErrorParams () const
 returns the currently set internal parameter vector
 
virtual bool usesColumn (int c) const override
 returns true if the given column is used by the graph
 
- Public Member Functions inherited from JKQTPEvaluatedFunctionGraphBase
 JKQTPEvaluatedFunctionGraphBase (JKQTBasePlotter *parent=nullptr)
 class constructor
 
 JKQTPEvaluatedFunctionGraphBase (JKQTPlotter *parent)
 class constructor
 
virtual ~JKQTPEvaluatedFunctionGraphBase ()
 class destructor
 
double getDataCleanupMaxAllowedAngleDegree () const
 in the clean-up step of plot-data creation, a point is removed from the data, if it caused its neighboring line-segments to form an angle less than this value, given in degrees.
 
bool getDisplaySamplePoints () const
 if true [default: off] display the points where the function has been sampled
 
QVector< double > & getInternalParams ()
 returns the currently set internal parameter vector
 
const QVector< double > & getInternalParams () const
 returns the currently set internal parameter vector
 
unsigned int getMaxRefinementDegree () const
 the maximum number of recursive refinement steps
 
double getMinPixelPerSample () const
 create one sample at least every minPixelPerSample pixels
 
unsigned int getMinSamples () const
 the minimum number of points to evaluate the function at
 
int getParameterColumn () const
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the plot function
 
double getSlopeTolerance () const
 the tolerance for the difference of two subsequent slopes
 
void setCopiedParams (const double *params, int N)
 sets the params from a copy of the given array of length N
 
virtual void setParams (const QVector< double > &params)
 sets the params as a pointer to an internal COPY of the given vector (not the data of the vector, as then the size would be unknown!!!)
 
- Public Member Functions inherited from JKQTPGraph
 JKQTPGraph (JKQTBasePlotter *parent=nullptr)
 class constructor
 
virtual ~JKQTPGraph ()=default
 default wirtual destructor
 
- Public Member Functions inherited from JKQTPPlotElement
 JKQTPPlotElement (JKQTBasePlotter *parent=nullptr)
 class constructor
 
virtual ~JKQTPPlotElement ()=default
 default wirtual destructor
 
QPointF backTransform (const QPointF &x) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
 
QPointF backTransform (double x, double y) const
 tool routine that back-transforms a QPointF according to the parent's transformation rules (pixels --> plot coordinate)
 
double backtransformX (double x) const
 tool routine that backtransforms an x-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in xAxisRef
 
double backtransformY (double y) const
 tool routine that backtransforms a y-coordinate (pixels --> plot coordinate) for this plot element, uses the axis referenced in yAxisRef
 
virtual void drawOutside (JKQTPEnhancedPainter &painter, QRect leftSpace, QRect rightSpace, QRect topSpace, QRect bottomSpace)
 plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
 
QImage generateKeyMarker (QSize size=QSize(16, 16))
 returns an image with a key marker inside

 
virtual void getOutsideSize (JKQTPEnhancedPainter &painter, int &leftSpace, int &rightSpace, int &topSpace, int &bottomSpace)
 if the graph plots outside the actual plot field of view (e.g. color bars, scale bars, ...)
 
JKQTBasePlotter * getParent ()
 returns the parent painter class
 
const JKQTBasePlotter * getParent () const
 returns the parent painter class
 
QString getTitle () const
 returns the the title of the plot

 
const JKQTPCoordinateAxis * getXAxis () const
 returns the actual x-Axis-object from the parent plotter, referenced in xAxisRef
 
JKQTPCoordinateAxisRef getXAxisRef () const
 indicates which coordinate axis to use for coordinate transforms in x-direction
 
const JKQTPCoordinateAxis * getYAxis () const
 returns the actual y-Axis-object from the parent plotter, referenced in yAxisRef
 
JKQTPCoordinateAxisRef getYAxisRef () const
 indicates which coordinate axis to use for coordinate transforms in y-direction
 
virtual double hitTest (const QPointF &posSystem, QPointF *closestSpotSystem=nullptr, QString *label=nullptr, HitTestMode mode=HitTestXY) const
 returns the closest distance of the plot element to the (screen pixel) position pos, or NAN
 
bool isHighlighted () const
 returns whether the graph is shown in a highlighted style in the plot

 
bool isVisible () const
 returns whether the graph is visible in the plot

 
void setAxes (JKQTPCoordinateAxisRef ref)
 set the coordinate axes to use for this plot element
 
virtual void setParent (JKQTBasePlotter *parent)
 sets the parent painter class
 
virtual void setParent (JKQTPlotter *parent)
 sets the parent painter class
 
void setXAxis (JKQTPCoordinateAxisRef ref)
 indicates which coordinate axis to use for coordinate transforms in x-direction
 
void setYAxis (JKQTPCoordinateAxisRef ref)
 indicates which coordinate axis to use for coordinate transforms in y-direction
 
QPointF transform (const QPointF &x) const
 tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
 
QPolygonF transform (const QPolygonF &x) const
 tool routine that transforms a QPolygonF according to the parent's transformation rules (plot coordinate --> pixels)
 
QPointF transform (double x, double y) const
 tool routine that transforms a QPointF according to the parent's transformation rules (plot coordinate --> pixels)
 
QPainterPath transformToLinePath (const QPolygonF &x) const
 tool routine that transforms a QPolygonF according to the parent's transformation rules and returns a (non-closed) path consisting of lines (plot coordinate --> pixels)
 
QVector< double > transformX (const QVector< double > &x) const
 transform all x-coordinates in a vector x
 
double transformX (double x) const
 tool routine that transforms an x-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in xAxisRef
 
QVector< double > transformY (const QVector< double > &x) const
 transform all y-coordinates in a vector x
 
double transformY (double y) const
 tool routine that transforms a y-coordinate (plot coordinate --> pixels) for this plot element, uses the axis referenced in yAxisRef
 
- Public Member Functions inherited from JKQTPGraphLineAndFillStyleMixin
 JKQTPGraphLineAndFillStyleMixin ()
 class constructor
 
bool doDrawLine () const
 indicates whether to draw a line on the circumference of the described area (i.e. along the data points from xColumn and yColumn as well as xColumn and yColumn2 or not
 
bool doFillCurve () const
 indicates whether to fill the space between the curve and the x-axis
 
bool getDrawLine () const
 indicates whether to draw a line on the circumference of the described area (i.e. along the data points from xColumn and yColumn as well as xColumn and yColumn2 or not
 
bool getFillCurve () const
 indicates whether to fill the space between the curve and the x-axis
 
void setDrawLine (bool __value)
 indicates whether to draw a line on the circumference of the described area (i.e. along the data points from xColumn and yColumn as well as xColumn and yColumn2 or not
 
void setFillCurve (bool __value)
 indicates whether to fill the space between the curve and the x-axis
 
- Public Member Functions inherited from JKQTPGraphFillStyleMixin
 JKQTPGraphFillStyleMixin ()
 class constructor
 
virtual ~JKQTPGraphFillStyleMixin ()
 
QBrush getFillBrush (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QBrush from the graph fill styling properties
 
QColor getFillColor () const
 set the color of the graph filling
 
const QGradient * getFillGradient () const
 get the gradient object of the graph filling
 
Qt::BrushStyle getFillStyle () const
 get the fill style of the graph
 
QPixmap getFillTexture () const
 set the color of the graph filling
 
QImage getFillTextureImage () const
 set the color of the graph filling
 
void initFillStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
 initiaize the fill style (from the parent plotter)
 
void initFillStyleInvertedColor (JKQTPGraphFillStyleMixin *other)
 initiaize the fill style from another JKQTPGraphFillStyleMixin other by inverting its fill color
 
void setFillBrush (const QBrush &b)
 sets a fill brush (overwrites all internal properties!)
 
void setFillColor (const QColor &__value)
 set the color of the graph filling
 
void setFillColor (const QColor &__value, double alpha)
 set the color of the graph filling
 
void setFillGradient (const QGradient &__value)
 set the filling of the graph to a gradient and sets fill style to a gradient setting
 
void setFillStyle (Qt::BrushStyle __value)
 set the fill style of the graph
 
void setFillTexture (const QImage &__value)
 set the color of the graph filling and sets fill style to Qt::TexturePattern
 
void setFillTexture (const QPixmap &__value)
 set the color of the graph filling and sets fill style to Qt::TexturePattern
 
void setFillTransform (const QTransform &b)
 sets a fill transformation
 
- Public Member Functions inherited from JKQTPGraphLineStyleMixin
 JKQTPGraphLineStyleMixin ()
 class constructor
 
virtual ~JKQTPGraphLineStyleMixin ()
 
QColor getHighlightingLineColor () const
 get the color of the graph line when highlighted
 
QPen getHighlightingLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties
 
QPen getHighlightingLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, suitable for drawing rectangle with sharp corners
 
QPen getKeyLinePen (JKQTPEnhancedPainter &painter, const QRectF &rect, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, but uses getKeyLineWidthPx() for the width, i.e. constructs a pen for drawing lines in key-symbols
 
double getKeyLineWidthPx (JKQTPEnhancedPainter &painter, const QRectF &keyRect, const JKQTBasePlotter *parent) const
 returns the linewidth for drawing lines in a key entry with keyRect for the symbol, using painter and parent .
 
QBrush getLineBrush () const
 gets the brush used to fill the line area
 
Qt::PenCapStyle getLineCapStyle () const
 gets the cap style
 
QColor getLineColor () const
 get the color of the graph line
 
qreal getLineDashOffset () const
 returns the dash offset for a custom dash style
 
QVector< qreal > getLineDashPattern () const
 gets the dash pattern for a custom dash style
 
Qt::PenJoinStyle getLineJoinStyle () const
 returns the join style
 
QPen getLinePen (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties
 
QPen getLinePenForRects (JKQTPEnhancedPainter &painter, JKQTBasePlotter *parent) const
 constructs a QPen from the line styling properties, suitable for drawing rectangles with sharp edges
 
Qt::PenStyle getLineStyle () const
 get the style of the graph line
 
double getLineWidth () const
 get the line width of the graph line (in pt)
 
void initLineStyle (JKQTBasePlotter *parent, int &parentPlotStyle, JKQTPPlotStyleType styletype=JKQTPPlotStyleType::Default)
 initiaize the line style (from the parent plotter)
 
void setHighlightingLineColor (const QColor &__value)
 set the color of the graph line when highlighted
 
void setHighlightingLineColor (const QColor &__value, double alpha)
 set the color of the graph line when highlighted
 
void setLineBrush (const QBrush &style)
 sets the brush used to fill the line area
 
void setLineCapStyle (Qt::PenCapStyle style)
 sets the cap style
 
void setLineColor (const QColor &__value)
 set the color of the graph line
 
void setLineColor (const QColor &__value, double alpha)
 set the color of the graph line
 
void setLineColorInvertedFrom (QColor __noninvertedColor)
 sets the line-color as an inverted version of the given color
 
void setLineDashOffset (qreal offset)
 sets the dash offset for a custom dash style
 
void setLineDashPattern (const QVector< qreal > &pattern)
 sets the dash pattern for a custom dash style
 
void setLineJoinStyle (Qt::PenJoinStyle style)
 sets the join style
 
void setLineStyle (Qt::PenStyle __value)
 set the style of the graph line
 
void setLineWidth (double __value)
 set the line width of the graph line (in pt)
 

Protected Member Functions

virtual std::function< QPointF(double)> buildErrorFunctorSpec () override
 this function returns a functor that is used to generate the plot data in coordinate space, based on a range of the dependent variable in coordinate space. In addition it also contains the value range over which to evaluate the functor PlotFunctorSpec::func
 
virtual PlotFunctorSpec buildPlotFunctorSpec () override
 this function returns a functor that is used to generate the plot data in coordinate space, based on a range of the dependent variable in coordinate space. In addition it also contains the value range over which to evaluate the functor PlotFunctorSpec::func
 
virtual bool getXMinMax (double &minx, double &maxx, double &smallestGreaterZero) override
 get the maximum and minimum x-value of the graph
 
virtual bool getYMinMax (double &miny, double &maxy, double &smallestGreaterZero) override
 get the maximum and minimum y-value of the graph
 
- Protected Member Functions inherited from JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase
void drawXGraph (JKQTPEnhancedPainter &painter)
 plots the graph to the plotter object specified as parent
 
void drawYGraph (JKQTPEnhancedPainter &painter)
 plots the graph to the plotter object specified as parent
 
QBrush getErrorBrush (JKQTPEnhancedPainter &painter) const
 
QPen getErrorLinePen (JKQTPEnhancedPainter &painter) const
 
- Protected Member Functions inherited from JKQTPEvaluatedFunctionWithErrorsGraphBase
virtual void collectParameters () override
 ensure that current function parameters for plotFunction (which may stem from different sources, as direct data, a datastore column ...) are stored in iparams and ierrorparams
 
- Protected Member Functions inherited from JKQTPEvaluatedFunctionGraphBase
virtual void createPlotData (bool collectParams=true)
 fill the data array with data from the function plotFunction
 
void drawSamplePoints (JKQTPEnhancedPainter &painter, QColor graphColor)
 draw all the sample points in data as small symbols
 
- Protected Member Functions inherited from JKQTPGraph
virtual void drawErrorsAfter (JKQTPEnhancedPainter &)
 this function is used to plot error inidcators after plotting the graphs.
 
virtual void drawErrorsBefore (JKQTPEnhancedPainter &)
 this function is used to plot error inidcators before plotting the graphs.
 
bool getDataMinMax (int column, double &minx, double &maxx, double &smallestGreaterZero)
 get the maximum and minimum value of the given column
 
- Protected Member Functions inherited from JKQTPPlotElement
void addHitTestData (const HitTestLocation &loc)
 clear the internal datastore for hitTest()
 
void addHitTestData (const QPointF &pos_, const QString &label_)
 clear the internal datastore for hitTest()
 
void addHitTestData (const QPointF &pos_, int index_, const QString &label_)
 clear the internal datastore for hitTest()
 
void addHitTestData (const QPointF &pos_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
 clear the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
 
void addHitTestData (double x_, double y_, const QString &label_)
 add a new point on the graph to the internal datastore for hitTest()
 
void addHitTestData (double x_, double y_, int index_, const QString &label_)
 clear the internal datastore for hitTest()
 
void addHitTestData (double x_, double y_, int index_=-1, const JKQTPDatastore *datastore=nullptr)
 add a new point on the graph to the internal datastore for hitTest(), this variant uses formatHitTestDefaultLabel() to auto-generate the label
 
void clearHitTestData ()
 clear the internal datastore for hitTest()
 
virtual QString formatHitTestDefaultLabel (double x, double y, int index=-1, const JKQTPDatastore *datastore=nullptr) const
 tool-function for hitTest(), which formats a default label, taking into account the x- and y-position (both provided) and optionally the errors of these positions.
 
void reserveHitTestData (int points)
 reserve list entries for up to points graph points in the internal datastore for hitTest()
 
QString xFloatToString (double v, int past_comma=-1) const
 converts a x-value v into a string, taking into account the type of x-axis
 
QString yFloatToString (double v, int past_comma=-1) const
 converts a x-value v into a string, taking into account the type of x-axis
 

Additional Inherited Members

- Public Types inherited from JKQTPFunctorLineGraphBase
enum  SpecialFunction {
  Polynomial ,
  Line =Polynomial ,
  Exponential ,
  PowerLaw
}
 
- Public Types inherited from JKQTPPlotElement
enum  HitTestMode {
  HitTestXY ,
  HitTestXOnly ,
  HitTestYOnly
}
 modes of operation for the function hitTest() More...
 
- Public Slots inherited from JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase
void setColor (QColor c)
 set color, fill color and error color at the same time

 
void setDrawErrorLines (bool __value)
 indicates whether error lines should be drawn
 
void setDrawErrorPolygons (bool __value)
 indicates whether an error polygon should be drawn
 
virtual void setErrorFillColor (const QColor &__value)
 color of the error graph fill
 
virtual void setErrorFillStyle (Qt::BrushStyle __value)
 fill style, if the error curve should be filled
 
virtual void setErrorLineColor (const QColor &__value)
 color of the error graph
 
virtual void setErrorLineStyle (Qt::PenStyle __value)
 linestyle of the error graph lines
 
virtual void setErrorLineWidth (double __value)
 width (pixels) of the error graph
 
- Public Slots inherited from JKQTPEvaluatedFunctionWithErrorsGraphBase
void setErrorParameterColumn (int __value)
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the error plot function
 
void setErrorParameterColumn (size_t __value)
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the error plot function
 
void setErrorParams (const QVector< double > &errorParams)
 sets the error params as a pointer to an internal COPY of the given vector (not the data of the vector, as then the size would be unknown!!!)
 
void setErrorParamsV (double p1)
 set the internal error function parameters to {p1}
 
void setErrorParamsV (double p1, double p2)
 set the internal error function parameters to {p1,p2}
 
void setErrorParamsV (double p1, double p2, double p3)
 set the internal error function parameters to {p1,p2,p3}
 
void setErrorParamsV (double p1, double p2, double p3, double p4)
 set the internal error function parameters to {p1,p2,p3,p4}
 
void setErrorParamsV (double p1, double p2, double p3, double p4, double p5)
 set the internal error function parameters to {p1,p2,p3,p4,p5}
 
- Public Slots inherited from JKQTPEvaluatedFunctionGraphBase
void setDataCleanupMaxAllowedAngleDegree (double __value)
 in the clean-up step of plot-data creation, a point is removed from the data, if it caused its neighboring line-segments to form an angle less than this value, given in degrees.
 
void setDisplaySamplePoints (bool __value)
 if true [default: off] display the points where the function has been sampled
 
void setMaxRefinementDegree (const unsigned int &__value)
 the maximum number of recursive refinement steps
 
void setMinPixelPerSample (double __value)
 create one sample at least every minPixelPerSample pixels
 
void setMinSamples (const unsigned int &__value)
 the minimum number of points to evaluate the function at
 
void setParameterColumn (int __value)
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the plot function
 
void setParameterColumn (size_t __value)
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the plot function
 
void setParamsV (double p1)
 set an internal parameter vector as function parameters, initialized with {p1}
 
void setParamsV (double p1, double p2)
 set an internal parameter vector as function parameters, initialized with {p1,p2}
 
void setParamsV (double p1, double p2, double p3)
 set an internal parameter vector as function parameters, initialized with {p1,p2,p3}
 
void setParamsV (double p1, double p2, double p3, double p4)
 set an internal parameter vector as function parameters, initialized with {p1,p2,p3,p4}
 
void setParamsV (double p1, double p2, double p3, double p4, double p5)
 set an internal parameter vector as function parameters, initialized with {p1,p2,p3,p4,p5}
 
void setSlopeTolerance (double __value)
 the tolerance for the difference of two subsequent slopes
 
- Public Slots inherited from JKQTPPlotElement
void setHighlighted (bool __value)
 sets whether the graph is drawn in a highlighted style in the plot

 
virtual void setTitle (const QString &__value)
 sets the title of the plot (for display in key!).
 
void setVisible (bool __value)
 sets whether the graph is visible in the plot

 
- Protected Attributes inherited from JKQTPFunctorLineGraphBase
jkqtpPlotFunctionType errorPlotFunction
 this function calculates the error at a given position
 
jkqtpSimplePlotFunctionType errorSimplePlotFunction
 this function calculates the error at a given position, simplified form without parameters
 
jkqtpPlotFunctionType plotFunction
 the function to be plotted
 
jkqtpSimplePlotFunctionType simplePlotFunction
 a simple function to be plotted, simplified form without parameters
 
- Protected Attributes inherited from JKQTPEvaluatedFunctionWithErrorsGraphDrawingBase
bool drawErrorLines
 indicates whether error lines should be drawn
 
bool drawErrorPolygons
 indicates whether an error polygon should be drawn
 
QColor errorColor
 color of the error graph
 
QColor errorFillColor
 color of the error graph fill
 
Qt::BrushStyle errorFillStyle
 fill style, if the error curve should be filled
 
double errorLineWidth
 width (pixels) of the error graph
 
Qt::PenStyle errorStyle
 linestyle of the error graph lines
 
- Protected Attributes inherited from JKQTPEvaluatedFunctionWithErrorsGraphBase
int errorParameterColumn
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the error plot function
 
QVector< double > ierrorparams
 internal storage for the current error function parameters for errorPlotFunction (which may stem from different sources, as direct data, a datastore column ...)
 
- Protected Attributes inherited from JKQTPEvaluatedFunctionGraphBase
QVector< QPointF > data
 plot data calculated by createPlotData(), i.e. the datapoints $ \mbox{transform}\left(x, y=f(x, \vec{p})\right) $ to be plotted
 
double dataCleanupMaxAllowedAngleDegree
 in the clean-up step of plot-data creation, a point is removed from the data, if it caused its neighboring line-segments to form an angle less than this value, given in degrees.
 
bool displaySamplePoints
 if true [default: off] display the points where the function has been sampled
 
QVector< double > iparams
 internal storage for the current function parameters for plotFunction (which may stem from different sources, as direct data, a datastore column ...)
 
unsigned int maxRefinementDegree
 the maximum number of recursive refinement steps
 
double minPixelPerSample
 create one sample at least every minPixelPerSample pixels
 
unsigned int minSamples
 the minimum number of points to evaluate the function at
 
int parameterColumn
 if set, the values from this datatsore column are used for the parameters p1 , p2 , p3 , ... of the plot function
 
double slopeTolerance
 the tolerance for the difference of two subsequent slopes
 
- Protected Attributes inherited from JKQTPPlotElement
QVector< HitTestLocation > m_hitTestData
 dataset with graph-points and associated data from the function hitTest()
 
JKQTBasePlotter * parent
 the plotter object this object belongs to
 
int parentPlotStyle
 internal storage for the used parent plot style
 
- Properties inherited from JKQTPPlotElement
bool highlighted
 indicates whether the graph is shown in a "highlghted" in the plot
 
QString title
 title of the plot (for display in key!). If no title is supplied, no key entry is drawn.
 
bool visible
 indicates whether the graph is visible in the plot
 
JKQTPCoordinateAxisRef xAxisRef
 indicates which coordinate axis to use for coordinate transforms in x-direction
 
JKQTPCoordinateAxisRef yAxisRef
 indicates which coordinate axis to use for coordinate transforms in y-direction
 
- Properties inherited from JKQTPGraphLineAndFillStyleMixin
bool drawLine
 
bool fillCurve
 
- Properties inherited from JKQTPGraphFillStyleMixin
QColor fillColor
 
Qt::BrushStyle fillStyle
 
- Properties inherited from JKQTPGraphLineStyleMixin
QColor highlightingLineColor
 
QColor lineColor
 
Qt::PenStyle lineStyle
 
double lineWidth
 

Detailed Description

This implements line plots where the data is taken from a user supplied function $ x=f(y) $.

The following image shows some example graphs:

Note
Auto-scaling of the plot is deactivated (by overwriting getXMinMax() and getYMinMax() to return false ), as it depends on the axes (hen-egg-problem!) Set the plot-ranges by hand!!!
See also
Example (JKQTPlotter): Plotting Mathematical Functions as Line Graphs , JKQTPXFunctionLineGraph, JKQTPXYFunctionLineGraph

Constructor & Destructor Documentation

◆ JKQTPYFunctionLineGraph() [1/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( JKQTBasePlotter *  parent = nullptr)

class constructor

◆ JKQTPYFunctionLineGraph() [2/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( JKQTPlotter *  parent)

class constructor

◆ JKQTPYFunctionLineGraph() [3/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( const jkqtpSimplePlotFunctionType &  f,
const QString &  title,
JKQTBasePlotter *  parent = nullptr 
)

class constructor

◆ JKQTPYFunctionLineGraph() [4/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( const jkqtpSimplePlotFunctionType &  f,
const QString &  title,
JKQTPlotter *  parent 
)

class constructor

◆ JKQTPYFunctionLineGraph() [5/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( jkqtpSimplePlotFunctionType &&  f,
const QString &  title,
JKQTBasePlotter *  parent = nullptr 
)

class constructor

◆ JKQTPYFunctionLineGraph() [6/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( jkqtpSimplePlotFunctionType &&  f,
const QString &  title,
JKQTPlotter *  parent 
)

class constructor

◆ JKQTPYFunctionLineGraph() [7/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( SpecialFunction  type,
const QVector< double > &  params,
const QString &  title,
JKQTBasePlotter *  parent 
)

class constructor

◆ JKQTPYFunctionLineGraph() [8/8]

JKQTPYFunctionLineGraph::JKQTPYFunctionLineGraph ( SpecialFunction  type,
const QVector< double > &  params,
const QString &  title,
JKQTPlotter *  parent 
)

class constructor

Member Function Documentation

◆ buildErrorFunctorSpec()

virtual std::function< QPointF(double)> JKQTPYFunctionLineGraph::buildErrorFunctorSpec ( )
overrideprotectedvirtual

this function returns a functor that is used to generate the plot data in coordinate space, based on a range of the dependent variable in coordinate space. In addition it also contains the value range over which to evaluate the functor PlotFunctorSpec::func

This function has to be overridden by each class. Depending on the way that class defines the actual plot function, this function has to compose its return type in different ways. The three most common ways are:

  • plot a function $ f(x) $ i.e. the plot points will be $ [x, f(x)] $ and the value rage will be the x-axis range. This is implemented by e.g. JKQTPXFunctionLineGraph.
  • plot a function $ f(y) $ i.e. the plot points will be $ [f(y), y] $ and the value rage will be the y-axis range. This is implemented by e.g. JKQTPYFunctionLineGraph.
  • plot a function $ [x,y]=\vec{f}(t) $ i.e. the plot points will be $ \vec{f}(t) $ and the value rage will be a user-defined range for $ gt $. This is implemented by e.g. JKQTPXYFunctionLineGraph. .

Implements JKQTPEvaluatedFunctionWithErrorsGraphBase.

◆ buildPlotFunctorSpec()

virtual PlotFunctorSpec JKQTPYFunctionLineGraph::buildPlotFunctorSpec ( )
overrideprotectedvirtual

this function returns a functor that is used to generate the plot data in coordinate space, based on a range of the dependent variable in coordinate space. In addition it also contains the value range over which to evaluate the functor PlotFunctorSpec::func

This function has to be overridden by each class. Depending on the way that class defines the actual plot function, this function has to compose its return type in different ways. The three most common ways are:

  • plot a function $ f(x) $ i.e. the plot points will be $ [x, f(x)] $ and the value rage will be the x-axis range. This is implemented by e.g. JKQTPXFunctionLineGraph.
  • plot a function $ f(y) $ i.e. the plot points will be $ [f(y), y] $ and the value rage will be the y-axis range. This is implemented by e.g. JKQTPYFunctionLineGraph.
  • plot a function $ [x,y]=\vec{f}(t) $ i.e. the plot points will be $ \vec{f}(t) $ and the value rage will be a user-defined range for $ gt $. This is implemented by e.g. JKQTPXYFunctionLineGraph. .

Implements JKQTPEvaluatedFunctionGraphBase.

◆ draw()

virtual void JKQTPYFunctionLineGraph::draw ( JKQTPEnhancedPainter &  painter)
overridevirtual

plots the graph to the plotter object specified as parent

Implements JKQTPPlotElement.

◆ getXMinMax()

virtual bool JKQTPYFunctionLineGraph::getXMinMax ( double &  minx,
double &  maxx,
double &  smallestGreaterZero 
)
overrideprotectedvirtual

get the maximum and minimum x-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters
[out]minxminimal x-value used in the graph
[out]maxxmaximal x-value used in the graph
[out]smallestGreaterZerothe smalles x-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)
Returns
true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Reimplemented from JKQTPEvaluatedFunctionGraphBase.

◆ getYMinMax()

virtual bool JKQTPYFunctionLineGraph::getYMinMax ( double &  miny,
double &  maxy,
double &  smallestGreaterZero 
)
overrideprotectedvirtual

get the maximum and minimum y-value of the graph

The result is given in the two parameters which are call-by-reference parameters!

Parameters
[out]minyminimal y-value used in the graph
[out]maxymaximal y-value used in the graph
[out]smallestGreaterZerothe smalles y-value in the graph, which is larger than 0 (this is used in auto-sizing for logarithmic axes)
Returns
true on success, i.e. if there were datapoints in the plot, or false on failure (e.g. when the graph is empty)

Reimplemented from JKQTPEvaluatedFunctionGraphBase.

The documentation for this class was generated from the following file: