mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-26 02:21:43 +08:00
668 lines
28 KiB
Plaintext
668 lines
28 KiB
Plaintext
/*!
|
|
|
|
\defgroup jkqtplotter JKQTPlotter: Qt based Scientific Plotter Class
|
|
|
|
A Qt based plotter for 2D scientific graphs. Main Plotting widget is JKQTPlotter.
|
|
|
|
|
|
\defgroup jkqtpdatastorage Data Storage Classes/System
|
|
\ingroup jkqtplotter
|
|
|
|
The classes in this group implement a data storage system for use with the main plotter class.
|
|
Basically a table of data is generated as a set of logical columns that may be bound to different
|
|
data sources (internal or external memory arrays. Later on it is simply possible to plot graphs
|
|
using the column number and the not a link to the actual data array, as the link is stored in these
|
|
classes.
|
|
|
|
\see \ref JKQTPlotterBasicJKQTPDatastore for a detailed description of how to use this class for data management!
|
|
|
|
\defgroup jkqtpexternalinterfaces Interfaces To Other Libraries
|
|
\ingroup jkqtpdatastorage
|
|
|
|
|
|
\defgroup jkqtpinterfaceopencv OpenCV Interfaceing Tools
|
|
\ingroup jkqtpexternalinterfaces
|
|
|
|
Classes and functions in this group allow JKQTPlotter to directly work with <a href="https://opencv.org/">OpenCV</a> data structures.
|
|
|
|
Examples:
|
|
- \ref JKQTPlotterImagePlotOpenCV
|
|
- \ref JKQTPlotterImagePlotRGBOpenCV
|
|
.
|
|
|
|
The OpenCV-binding itself is header-only, and NOT compiled into the JKQtPlotter libraries. Therefore you can simply include the header and use the facilities provided by it.
|
|
|
|
The CMake-build system of JKQtPlotter (and its examples) is compatible with both OpenCV 3.4.x and 4.x and uses the standard `find_package(OpenCV)` facilities provided by OpenCV to compile and bind against that library.
|
|
If you want to build the OpenCV-based JKQtPlotter examples (see list above), you either have to ensure that CMake finds OpenCV by itself (i.e. somewhere in the default search paths), or you can set the CMake variable `OpenCV_DIR` so it points to the OpenCV directory before configuring JKQtPlotter.
|
|
|
|
|
|
|
|
\defgroup jkqtpinterfacecimg CImg Interfaceing Tools
|
|
\ingroup jkqtpexternalinterfaces
|
|
|
|
Classes and functions in this group allow JKQTPlotter to directly work with <a href="http://cimg.eu/">CImg</a> data structures <a href="http://cimg.eu/reference/structcimg__library_1_1CImg.html">CImg<T>></a>.
|
|
|
|
Examples:
|
|
- \ref JKQTPlotterImagePlotCImg
|
|
- \ref JKQTPlotterImagePlotRGBCImg
|
|
.
|
|
|
|
The CImg-binding itself is header-only (as CImg is itself), and NOT compiled into the JKQtPlotter libraries. Therefore you can simply include the header and use the facilities provided by it.
|
|
|
|
The CMake-build system of JKQtPlotter (and its examples) provides facilities to allow for `find_package(CImg)` to compile against that library.
|
|
If you want to build the CImg-based JKQtPlotter examples (see list above), you either have to ensure that CMake finds CImg by itself (i.e. somewhere in the default search paths, e.g. `CMAKE_INSTALL_PREFIX`), or you can set the CMake variable `CImg_DIR` so it points to the directory of the `CImg.h` file, or before configuring JKQtPlotter.
|
|
|
|
|
|
|
|
\defgroup jkqtpplottersupprt Support Classes and Functions
|
|
\ingroup jkqtplotter
|
|
|
|
\defgroup jkqtpplotterclasses Plotter Class & Plotter Widget
|
|
\ingroup jkqtplotter
|
|
|
|
This group contains the actual plotter classes, that implement layout management code,
|
|
coordinate system management an actual plotter widget ...
|
|
|
|
There are two main classes:
|
|
- JKQTBasePlotter is a QObject-derived class that implements all the plotting logic and drawing code. It does not implement a Qt widget though.
|
|
- JKQTPlotter is a QWidget-based class that contains a JKQTBasePlotter and uses it to draw plots onto a Qt form.
|
|
.
|
|
|
|
|
|
\defgroup jkqtplotter_elements Plot Elements
|
|
\ingroup jkqtplotter
|
|
|
|
This group assembles all classes that represent different elements of a plot (managed by JKQTBasePlotter/JKQTPlotter).
|
|
There are these major subgroups:
|
|
- \ref jkqtpbaseplotter_elements contains all non-graph objects, i.e. things like coordinate axes and so on
|
|
- \ref jkqtplotter_graphsgroup contains the actual graph classes
|
|
.
|
|
|
|
\defgroup jkqtpbaseplotter_elements Basic (non-graph) Plot Elements (coordinate axes, ...)
|
|
\ingroup jkqtplotter_elements
|
|
|
|
This group contains some tool classes that implement basic elements of the plot (coordinate axes, key, ...).
|
|
These classes are used by JKQTPlotterBase to output the plot.
|
|
|
|
|
|
\defgroup jkqtplotter_graphsgroup Graph Classes
|
|
\ingroup jkqtplotter_elements
|
|
|
|
This group contains all classes in the JKQTPlotter library that may be used to draw a graph (i.e. a curve) onto a plot.
|
|
|
|
\tableofcontents
|
|
|
|
\section jkqtplotter_graphsgroup_classstructure Graph Class Structure
|
|
|
|
\subsection jkqtplotter_graphsgroup_classstructure_basics Graph Classes
|
|
|
|
Each type of graph is represented by another class, which has to be derived from JKQTPPlotElement. This class provides a basic virtual interface
|
|
that allows JKQTPlotter to draw the graphs represented by them. This interface consists of these functions:
|
|
- JKQTPPlotElement::draw() draws the graph onto a given JKQTPEnhancedPainter (derived from <a href="http://doc.qt.io/qt-5/qpainter.html">QPainter</a>)
|
|
- JKQTPPlotElement::drawKeyMarker() draws the small marker image in the plot legend
|
|
- JKQTPPlotElement::getKeyLabelColor() returns a color for the legend entry for the graph
|
|
- JKQTPPlotElement::getXMinMax() returns the extent of the graph in x-direction (e.g. for auto-zooming)
|
|
- JKQTPPlotElement::getYMinMax() returns the extent of the graph in Y-direction (e.g. for auto-zooming)
|
|
.
|
|
In addition to these basic functions, there are additional functions that can be used to draw something outside the actual plot rectangle.
|
|
These are used to e.g. add color-scales to the side of the graph:
|
|
- JKQTPPlotElement::getOutsideSize() returns the amount of space required outside the plot rectangle
|
|
- JKQTPPlotElement::drawOutside() draws the elements outside the plot rectangle
|
|
.
|
|
|
|
Usually if writing a new graph, one would not directly
|
|
derive from JKQTPPlotElement, but from a cass in it's hirarchy of children. These children already provide certain facilities for certain types of graphs.
|
|
|
|
\dot
|
|
digraph
|
|
{
|
|
// LATEX_PDF_SIZE
|
|
bgcolor="transparent";
|
|
edge [fontname="FreeSans",fontsize="12",labelfontname="FreeSans",labelfontsize="12"];
|
|
node [fontname="FreeSans",fontsize="12"];
|
|
rankdir="LR";
|
|
|
|
{
|
|
rank=same;
|
|
JKQTPPlotElement [URL="\link JKQTPPlotElement"];
|
|
noteJKQTPPlotElement [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nelements drawn\nonto a plot"];
|
|
JKQTPPlotElement -> noteJKQTPPlotElement [style=dashed,arrowhead=none];
|
|
}
|
|
|
|
{
|
|
rank=same;
|
|
JKQTPGraph [URL="\link JKQTPPlotElement"];
|
|
noteJKQTPGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nactual graphs"];
|
|
JKQTPGraph -> noteJKQTPGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPGeometricPlotElement [URL="\link JKQTPGeometricPlotElement"];
|
|
noteJKQTPGeometricPlotElement [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nnon-graph elements,\ne.g. geometric elements"];
|
|
JKQTPGeometricPlotElement -> noteJKQTPGeometricPlotElement [style=dashed,arrowhead=none];
|
|
|
|
JKQTPPlotAnnotationElement [URL="\link JKQTPPlotAnnotationElement"];
|
|
noteJKQTPPlotAnnotationElement [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraph annotation elements,\ne.g. text, symbols, ranges ..."];
|
|
JKQTPPlotAnnotationElement -> noteJKQTPPlotAnnotationElement [style=dashed,arrowhead=none];
|
|
}
|
|
|
|
|
|
{
|
|
rank=same;
|
|
|
|
JKQTPXYGraph [URL="\link JKQTPXYGraph"]
|
|
noteJKQTPXYGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs based on\n (x,y) data pairs"];
|
|
JKQTPXYGraph -> noteJKQTPXYGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPSingleColumnGraph [URL="\link JKQTPSingleColumnGraph"]
|
|
noteJKQTPSingleColumnGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs based on only\n a single column of data"];
|
|
JKQTPSingleColumnGraph -> noteJKQTPSingleColumnGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPImageBase [URL="\link JKQTPImageBase"]
|
|
noteJKQTPImageBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs that represent \n2D images/matrices"];
|
|
JKQTPImageBase -> noteJKQTPImageBase [style=dashed,arrowhead=none];
|
|
}
|
|
|
|
{
|
|
rank=same;
|
|
|
|
JKQTPXYYGraph [URL="\link JKQTPXYYGraph"]
|
|
noteJKQTPXYYGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs based on\n (x, y1, y2) data tripels"];
|
|
JKQTPXYYGraph -> noteJKQTPXYYGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPXXYGraph [URL="\link JKQTPXXYGraph"]
|
|
noteJKQTPXXYGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs based on\n (x1, x2, y) data tripels"];
|
|
JKQTPXXYGraph -> noteJKQTPXXYGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPXYBaselineGraph [URL="\link JKQTPXYBaselineGraph"]
|
|
noteJJKQTPXYBaselineGraph [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs based on\n (x,y) data pairs and a baseline"];
|
|
JKQTPXYBaselineGraph -> noteJJKQTPXYBaselineGraph [style=dashed,arrowhead=none];
|
|
|
|
JKQTPEvaluatedFunctionGraphBase [URL="\link JKQTPEvaluatedFunctionGraphBase"]
|
|
noteJKQTPEvaluatedFunctionGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs that represent \ndynamically evaluated functions"];
|
|
JKQTPEvaluatedFunctionGraphBase -> noteJKQTPEvaluatedFunctionGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPMathImageBase [URL="\link JKQTPMathImageBase"]
|
|
noteJKQTPMathImageBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ndata-based images"];
|
|
JKQTPMathImageBase -> noteJKQTPMathImageBase [style=dashed,arrowhead=none];
|
|
}
|
|
|
|
{
|
|
rank=same;
|
|
|
|
JKQTPBarGraphBase [URL="\link JKQTPBarGraphBase"]
|
|
noteJKQTPBarGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nbarcharts"];
|
|
JKQTPBarGraphBase -> noteJKQTPBarGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPFilledCurveGraphBase [URL="\link JKQTPFilledCurveGraphBase"]
|
|
noteJKQTPFilledCurveGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nfilled graphs"];
|
|
JKQTPFilledCurveGraphBase -> noteJKQTPFilledCurveGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPImpulsesGraphBase [URL="\link JKQTPImpulsesGraphBase"]
|
|
noteJKQTPImpulsesGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nimpulse graphs"];
|
|
JKQTPImpulsesGraphBase -> noteJKQTPImpulsesGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPSpecialLineGraphBase [URL="\link JKQTPSpecialLineGraphBase"]
|
|
noteJKQTPSpecialLineGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nspecial line graphs"];
|
|
JKQTPSpecialLineGraphBase -> noteJKQTPSpecialLineGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPBoxplotGraphBase [URL="\link JKQTPBoxplotGraphBase"]
|
|
noteJKQTPBoxplotGraphBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs that represent \na set of boxplots"];
|
|
JKQTPBoxplotGraphBase -> noteJKQTPBoxplotGraphBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPRangeBase [URL="\link JKQTPRangeBase"];
|
|
noteJKQTPRangeBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\nrange annotations"];
|
|
JKQTPRangeBase -> noteJKQTPRangeBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPBoxplotElementBase [URL="\link JKQTPBoxplotElementBase"]
|
|
noteJKQTPBoxplotElementBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs that represent \na single boxplot"];
|
|
JKQTPBoxplotElementBase -> noteJKQTPBoxplotElementBase [style=dashed,arrowhead=none];
|
|
|
|
JKQTPViolinplotElementBase [URL="\link JKQTPViolinplotElementBase"]
|
|
noteJKQTPViolinplotElementBase [shape="note", color="lightyellow",style=filled,fontsize=8,label="base class for all\ngraphs that represent \na single violin plot"];
|
|
JKQTPViolinplotElementBase -> noteJKQTPViolinplotElementBase [style=dashed,arrowhead=none];
|
|
}
|
|
|
|
JKQTPPlotElement -> JKQTPGraph
|
|
JKQTPPlotElement -> JKQTPGeometricPlotElement
|
|
JKQTPPlotElement -> JKQTPPlotAnnotationElement
|
|
JKQTPPlotElement -> JKQTPRangeBase
|
|
JKQTPPlotElement -> JKQTPBoxplotElementBase
|
|
JKQTPPlotElement -> JKQTPViolinplotElementBase
|
|
|
|
JKQTPGraph -> JKQTPXYGraph
|
|
JKQTPGraph -> JKQTPSingleColumnGraph
|
|
JKQTPGraph -> JKQTPImageBase -> JKQTPMathImageBase
|
|
JKQTPGraph -> JKQTPEvaluatedFunctionGraphBase
|
|
JKQTPGraph -> JKQTPBoxplotGraphBase
|
|
|
|
JKQTPXYGraph -> JKQTPXYYGraph
|
|
JKQTPXYGraph -> JKQTPXXYGraph
|
|
JKQTPXYGraph -> JKQTPXYBaselineGraph
|
|
|
|
JKQTPXYBaselineGraph -> JKQTPBarGraphBase
|
|
JKQTPXYBaselineGraph -> JKQTPFilledCurveGraphBase
|
|
JKQTPXYBaselineGraph -> JKQTPImpulsesGraphBase
|
|
JKQTPXYBaselineGraph -> JKQTPSpecialLineGraphBase
|
|
|
|
}
|
|
|
|
\enddot
|
|
|
|
\subsection jkqtplotter_graphsgroup_classstructure_mixins Mix-In Classes for Graphs
|
|
|
|
In addition there are mix-in classes that are used via multiple inheritance
|
|
that add additional features and properties to a graph. A prominent example are the classes for \ref jkqtplotter_basegraphserrors "error indicators".
|
|
With these there are usually two variants of one type of graph: One without error indicators and one with error indicators, e.g.:
|
|
- JKQTPXYLineGraph shows lines+symbols graphs made up from x/y-value pairs for each data point.
|
|
- JKQTPXYLineErrorGraph extends JKQTPXYLineGraph with error indicator drawing/properties provided by JKQTPXYGraphErrors
|
|
.
|
|
This approach allows to keep interfaces and appearance recognizeable over different graph classes and locates the source code
|
|
for a feature like error indicators in a single/in few class(es).
|
|
|
|
Another example of such a class is JKQTPColorPaletteStyleAndToolsMixin, which provides functions that allow to use color palettes. It is
|
|
mainly used for the \ref jkqtplotter_imagelots "Image/Matrix graphs", but also by e.g. JKQTPXYParametrizedScatterGraph.
|
|
|
|
|
|
|
|
\defgroup jkqtplotter_basegraphs Baseclasses for Graphs
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
\defgroup jkqtplotter_basegraphserrors Mix-In Classes for Error Indicators
|
|
\ingroup jkqtplotter_basegraphs
|
|
|
|
\defgroup jkqtplotter_basegraphs_stylemixins Mix-In Classes for Plot Styling
|
|
\ingroup jkqtplotter_basegraphs
|
|
|
|
\defgroup jkqtplotter_linesymbolgraphs Line/Symbol Graphs
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
This group assembles graphs that show their data with symbols and optionally with connecting lines in diferent styles:
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html beeswarmplot_small.png
|
|
<td> JKQTPSingleColumnSymbolsGraph
|
|
<tr>
|
|
<td>\image html symbols_and_styles_small.png
|
|
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
|
|
<tr>
|
|
<td>\image html paramscatterplot_small.png
|
|
<td> JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph
|
|
<tr>
|
|
<td>\image html stepplots_small.png
|
|
<td> JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_linesymbolgraphs_simple Basic Line/Scatter Graphs
|
|
\ingroup jkqtplotter_linesymbolgraphs
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html beeswarmplot_small.png
|
|
<td> JKQTPSingleColumnSymbolsGraph
|
|
<tr>
|
|
<td>\image html symbols_and_styles_small.png
|
|
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
|
|
<tr>
|
|
<td>\image html stepplots_small.png
|
|
<td> JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph
|
|
</table>
|
|
|
|
|
|
\defgroup jkqtplotter_linesymbolgraphs_param Parametrized Line/Scatter Graphs
|
|
\ingroup jkqtplotter_linesymbolgraphs
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html paramscatterplot_small.png
|
|
<td> JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_filledgraphs Filled Polygon/Area Graphs
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html filledgraphs_small.png
|
|
<td> JKQTPFilledCurveXGraph, JKQTPFilledCurveYGraph
|
|
<tr>
|
|
<td>\image html plot_filledcurvexerrorplots_small.png
|
|
<td> JKQTPFilledCurveXErrorGraph, JKQTPFilledCurveYErrorGraph
|
|
<tr>
|
|
<td>\image html JKQTPfilledVerticalRangeGraph_WithLines_small.png
|
|
<td> JKQTPFilledVerticalRangeGraph, JKQTPFilledHorizontalRangeGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_functiongraphs Function Graphs
|
|
\ingroup jkqtplotter_linesymbolgraphs
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html functionplot_small.png
|
|
<td> JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph
|
|
<tr>
|
|
<td>\image html evalcurve_small.png
|
|
<td> JKQTPXYFunctionLineGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_parsedFgraphs Parsed Function Graphs
|
|
\ingroup jkqtplotter_linesymbolgraphs
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html functionplot_small.png
|
|
<td> JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_barssticks Barcharts, Impulse-Charts, ...
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html barchart_small.png
|
|
<td> JKQTPBarVerticalGraph, JKQTPBarHorizontalGraph
|
|
<tr>
|
|
<td>\image html barchart_error_small.png
|
|
<td> JKQTPBarVerticalErrorGraph, JKQTPBarHorizontalErrorGraph
|
|
<tr>
|
|
<td>\image html JKQTPbarVerticalGraphStacked_small.png
|
|
<td> JKQTPBarVerticalStackableGraph, JKQTPBarHorizontalStackableGraph
|
|
<tr>
|
|
<td>\image html impulsesplot_small.png
|
|
<td> JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph
|
|
<tr>
|
|
<td>\image html impulses_errors_small.png
|
|
<td> JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_statgraphs Statistical Graphs (e.g. Boxplots ...)
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html boxplot_small.png
|
|
<td> JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph
|
|
<tr>
|
|
<td>\image html JKQTPViolinplotVerticalElement_small.png
|
|
<td> JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement
|
|
</table>
|
|
|
|
\see \ref jkqtptools_math_statistics_adaptors for shortcuts to calculate statistical properties of data and then adding a plot with the results.
|
|
|
|
\defgroup jkqtplotter_geoplots Geometric Elements (Lines, Rectangles, ...)
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html symbol_filled_diamond.png
|
|
<td> JKQTPGeoSymbol
|
|
<tr>
|
|
<td>\image html geo_text_small.png
|
|
<td> JKQTPGeoText
|
|
<tr>
|
|
<td>\image html geo_line_small.png
|
|
<td> JKQTPGeoLine, JKQTPGeoInfiniteLine, JKQTPGeoPolyLines
|
|
<tr>
|
|
<td>\image html geo_arrows_small.png
|
|
<td> JKQTPGeoArrow
|
|
<tr>
|
|
<td>\image html geo_rect_small.png
|
|
<td> JKQTPGeoRectangle
|
|
<tr>
|
|
<td>\image html geo_polygon_small.png
|
|
<td> JKQTPGeoPolygon
|
|
<tr>
|
|
<td>\image html geo_ellipse_small.png
|
|
<td> JKQTPGeoEllipse
|
|
<tr>
|
|
<td>\image html geo_arc_small.png
|
|
<td> JKQTPGeoArc
|
|
<tr>
|
|
<td>\image html geo_pie_small.png
|
|
<td> JKQTPGeoPie
|
|
<tr>
|
|
<td>\image html geo_chords_small.png
|
|
<td> JKQTPGeoChord
|
|
</table>
|
|
|
|
Examples:
|
|
- \ref JKQTPlotterGeometricGraphs
|
|
.
|
|
|
|
\defgroup jkqtplotter_annotations Graph Annotations
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html symbol_filled_diamond.png
|
|
<td> JKQTPGeoSymbol
|
|
<tr>
|
|
<td>\image html geo_text_small.png
|
|
<td> JKQTPGeoText
|
|
<tr>
|
|
<td>\image html JKQTPHorizontalRange_small.png
|
|
<td> JKQTPHorizontalRange, JKQTPVerticalRange
|
|
</table>
|
|
|
|
Examples:
|
|
- \ref JKQTPlotterGeometricGraphs
|
|
.
|
|
|
|
\defgroup jkqtplotter_diverse Diverse Other Graphs (Ranges, ...)
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html JKQTPPeakStreamGraphY_small.png
|
|
<td> JKQTPPeakStreamGraph
|
|
<tr>
|
|
<td>\image html geo_boxplot_small.png
|
|
<td> JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement
|
|
<tr>
|
|
<td>\image html JKQTPViolinplotVerticalElement_small.png
|
|
<td> JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_imagelots Matrix/Image Plotting
|
|
\ingroup jkqtplotter_graphsgroup
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html rgbimageplot_qt_small.png
|
|
<td> JKQTPImage
|
|
<tr>
|
|
<td>\image html JKQTPMathImageBaseModifyNone_small.png
|
|
<td> JKQTPMathImage, JKQTPColumnMathImage
|
|
<tr>
|
|
<td>\image html rgbimageplots_small.png
|
|
<td> JKQTPRGBMathImage, JKQTPColumnRGBMathImage
|
|
<tr>
|
|
<td>\image html overlayimage_small.png
|
|
<td> JKQTPOverlayImage
|
|
<tr>
|
|
<td>\image html overlayimageenhanced_small.png
|
|
<td> JKQTPOverlayImageEnhanced, JKQTPColumnOverlayImageEnhanced
|
|
<tr>
|
|
<td>\image html JKQTPContour_small.png
|
|
<td> JKQTPContourPlot, JKQTPColumnContourPlot
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_imagelots_elements Image Graphs
|
|
\ingroup jkqtplotter_imagelots
|
|
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html rgbimageplot_qt_small.png
|
|
<td> JKQTPImage
|
|
<tr>
|
|
<td>\image html JKQTPMathImageBaseModifyNone_small.png
|
|
<td> JKQTPMathImage, JKQTPColumnMathImage
|
|
<tr>
|
|
<td>\image html rgbimageplot_cimg_small.png
|
|
<td> JKQTPRGBMathImage, JKQTPColumnRGBMathImage
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_imagelots_overlays Image/Matrix Overlay Graphs
|
|
\ingroup jkqtplotter_imagelots
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html overlayimage_small.png
|
|
<td> JKQTPOverlayImage
|
|
<tr>
|
|
<td>\image html overlayimageenhanced_small.png
|
|
<td> JKQTPOverlayImageEnhanced, JKQTPColumnOverlayImageEnhanced
|
|
</table>
|
|
|
|
\defgroup jkqtplotter_imagelots_tools Tool Functions & Classes for Image Drawing
|
|
\ingroup jkqtplotter_imagelots
|
|
|
|
\defgroup jkqtplotter_imagelots_tools_LUTS Tool Functions to Build Lookup-Tables for Palettes
|
|
\ingroup jkqtplotter_imagelots_tools
|
|
|
|
\defgroup jkqtplotter_imagelots_contour Contour Graphs (based on Image Data)
|
|
\ingroup jkqtplotter_imagelots
|
|
|
|
<table>
|
|
<tr>
|
|
<th> Screenshot
|
|
<th> Classes
|
|
<tr>
|
|
<td>\image html JKQTPContour_small.png
|
|
<td> JKQTPContourPlot, JKQTPColumnContourPlot
|
|
</table>
|
|
|
|
|
|
|
|
\defgroup jkqtpplotter_styling JKQTPlotter Styling System
|
|
\ingroup jkqtplotter
|
|
|
|
\image html stylesbanner.png
|
|
|
|
JKQTPlotter (and JKQTBasePlotter) offer a styling system, which allows to easily define and transfer plot styling from one object to another.
|
|
The system is based on a hirarchy of structs, which summarize properties, describing how a plot looks in general. The classes contained in this system are:
|
|
- JKQTPlotterStyle for JKQTPlotter: Defines e.g. basic user-interactions, the display options of the toolbar
|
|
- JKQTBasePlotterStyle for JKQTBasePlotter defines the appearance of the plot itself (colors, axis properties, key properties, default graph colors/styles, ...), contains JKQTPCoordinateAxisStyle instances to configrue the plot's coordinate axes
|
|
- JKQTPCoordinateAxisStyle for JKQTPCoordinateAxis defines the appearance of a coordinate axis (colors, axis properties, ...)
|
|
- JKQTPKeyStyle for the style of the key/legend in a JKQTBasePlotterStyle
|
|
.
|
|
|
|
In addition there are static methods that allow to manage a system-wide (actually program-instance wide) style that is applied to any new instance of JKQTPlotter and JKQTBasePlotter on construction:
|
|
- JKQTPGetSystemDefaultStyle() / JKQTPSetSystemDefaultStyle() allows to access the central instace of JKQTPlotterStyle (mainly properties/style of the GUI-parts and user-action bindings)
|
|
- JKQTPGetSystemDefaultBaseStyle() / JKQTPSetSystemDefaultBaseStyle() accesses the central instance of JKQTBasePlotterStyle (styles the actual plot/graphs with colors, axes styles, ...)
|
|
.
|
|
|
|
You can e.g. use these general methods to alter the styles for all JKQTPlotter instances, created in the future:
|
|
\code{.cpp}
|
|
// load the system-wide default settings from an INI-file:
|
|
QSettings plotSettings("JKQTPlotterSettings.ini", QSettings::IniFormat);;
|
|
JKQTPGetSystemDefaultStyle().loadSettings(plotSettings);
|
|
JKQTPGetSystemDefaultBaseStyle().loadSettings(plotSettings);
|
|
|
|
// alter a system-wide default setting by hand (here: set color of zooming rect to red)
|
|
JKQTPGetSystemDefaultStyle().userActionColor=QColor("red");
|
|
\endcode
|
|
|
|
Several pre-made styles are available in the JKQTPlotter repository (<a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/">https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/</a>).
|
|
These are also linked into the JKQTPlotter library as Qt ressource into the subdirectory \c :/JKQTPlotter/styles/ . You can use them as follows:
|
|
|
|
\code{.cpp}
|
|
QSettings plotSettings(":/JKQTPlotter/styles/blackandwhite.ini", QSettings::IniFormat);;
|
|
JKQTPGetSystemDefaultStyle().loadSettings(plotSettings);
|
|
JKQTPGetSystemDefaultBaseStyle().loadSettings(plotSettings);
|
|
\endcode
|
|
|
|
Here is a table with all available ready-made styles:
|
|
<table>
|
|
<tr>
|
|
<th> Style-file
|
|
<th> Screenshot
|
|
<tr>
|
|
<td> <b> The Default Style </b>
|
|
<td> \image html default.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/blackandwhite.ini"> \c :/JKQTPlotter/styles/blackandwhite.ini</a>
|
|
<td> \image html blackandwhite.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/blueprint.ini"> \c :/JKQTPlotter/styles/blueprint.ini</a>
|
|
<td> \image html blueprint.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/dark.ini"> \c :/JKQTPlotter/styles/dark.ini</a>
|
|
<td> \image html dark.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/seaborn.ini"> \c :/JKQTPlotter/styles/seaborn.ini</a>
|
|
<td> \image html seaborn.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/simple_gridandticks.ini"> \c :/JKQTPlotter/styles/simple_gridandticks.ini</a>
|
|
<td> \image html simple_gridandticks.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/simple_axesoffset.ini"> \c :/JKQTPlotter/styles/simple_axesoffset.ini</a>
|
|
<td> \image html simple_axesoffset.ini.png
|
|
<tr>
|
|
<td> <a href="https://github.com/jkriege2/JKQtPlotter/tree/master/lib/jkqtplotter/resources/styles/simple_axesoffset_plotbox.ini"> \c :/JKQTPlotter/styles/simple_axesoffset_plotbox.ini</a>
|
|
<td> \image html simple_axesoffset_plotbox.ini.png
|
|
</table>
|
|
|
|
\see For a detailed example, see \ref JKQTPlotterStyling
|
|
|
|
|
|
|
|
\defgroup jkqtpqtwidgetsttools Qt Widgets/Tools to work with JKQTPlotter
|
|
\ingroup jkqtplotter
|
|
|
|
This group assembles several Qt widgets and tool classes that are linked to JKQTPlotter/JKQTBasePlotter and allow to build advanced GUIs for these (e.g. model/view access to internal data ...)
|
|
|
|
\defgroup jkqtpgraphsmodel Qt Data Models to Access Graphs in a JKQTBasePlotter/JKQTPlotter
|
|
\ingroup jkqtpqtwidgetsttools
|
|
|
|
Data models in this group allow to access different internal data from a JKQTBasePlotter/JKQTPlotter and in part to manipulate these.
|
|
|
|
\defgroup jkqtpcomboboxes Comboboxes for Properties of JKQTBasePlotter/JKQTPlotter
|
|
\ingroup jkqtpqtwidgetsttools
|
|
|
|
This group contains several QComboBox-derived classes that can be used to select different enum-values (e.g. with JKQTPMathImageColorPaletteComboBox you can select a color-palette from JKQTPMathImageColorPalette ).
|
|
|
|
|
|
|
|
*/ |