mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-25 01:51:49 +08:00
improved/bugfixed doxygen documentation
This commit is contained in:
jkriege2
parent
333b7ac967
commit
b8088ccc69
2
.github/workflows/doxygen_build_deploy.yml
vendored
2
.github/workflows/doxygen_build_deploy.yml
vendored
@ -30,7 +30,7 @@ jobs:
|
||||
sudo apt-get update
|
||||
sudo apt-get update --fix-missing
|
||||
sudo apt-get install -f
|
||||
sudo apt -y install build-essential doxygen graphviz doxygen-latex clang-9 libclang-9-dev libclang-cpp9
|
||||
sudo apt -y install build-essential doxygen graphviz doxygen-latex clang-9 libclang-9-dev libclang-cpp9 fonts-freefont-ttf
|
||||
|
||||
- name: Update Doxygen to 1.9.3
|
||||
run: |
|
||||
|
||||
11
Doxyfile
11
Doxyfile
@ -990,7 +990,10 @@ EXCLUDE_SYMLINKS = NO
|
||||
# exclude all test directories for example use the pattern */test/*
|
||||
|
||||
EXCLUDE_PATTERNS = */build-* \
|
||||
*/html/*
|
||||
*/html/* \
|
||||
*examples/*.cpp \
|
||||
*examples/*.h \
|
||||
*/doc/html/*
|
||||
|
||||
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
|
||||
# (namespaces, classes, functions, etc.) that should be excluded from the
|
||||
@ -2601,7 +2604,7 @@ DIR_GRAPH_MAX_DEPTH = 1
|
||||
# The default value is: png.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOT_IMAGE_FORMAT = png
|
||||
DOT_IMAGE_FORMAT = svg
|
||||
|
||||
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
|
||||
# enable generation of interactive SVG images that allow zooming and panning.
|
||||
@ -2613,7 +2616,7 @@ DOT_IMAGE_FORMAT = png
|
||||
# The default value is: NO.
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
INTERACTIVE_SVG = NO
|
||||
INTERACTIVE_SVG = YES
|
||||
|
||||
# The DOT_PATH tag can be used to specify the path where the dot tool can be
|
||||
# found. If left blank, it is assumed the dot tool can be found in the path.
|
||||
@ -2626,7 +2629,7 @@ DOT_PATH =
|
||||
# command).
|
||||
# This tag requires that the tag HAVE_DOT is set to YES.
|
||||
|
||||
DOTFILE_DIRS = ./doc/dot/
|
||||
DOTFILE_DIRS = doc/dot/
|
||||
|
||||
# The MSCFILE_DIRS tag can be used to specify one or more directories that
|
||||
# contain msc files that are included in the documentation (see the \mscfile
|
||||
|
||||
@ -6,6 +6,6 @@
|
||||
output quality. It lacks several of the advanced features of JKQTPlotter, but can be used in cases, where fast
|
||||
update of plots or real-time plotting is required.
|
||||
|
||||
An example for the usage of this class can be found here: \link ../../examples/jkqtfastplotter_test \endlink
|
||||
An example for the usage of this class can be found here: \subpage JKQTFastPlotterTest
|
||||
|
||||
*/
|
||||
@ -623,7 +623,7 @@ Here is a table with all available ready-made styles:
|
||||
<th> Screenshot
|
||||
<tr>
|
||||
<td> <b> The Default Style </b>
|
||||
<td> \image html default.png
|
||||
<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
|
||||
|
||||
@ -116,10 +116,14 @@ enum JKQTPMathImageColorPalette {
|
||||
JKQTPMathImageAutumn, /*!< \image html palettes/palette_autumn.png */
|
||||
JKQTPMathImageSeismic, /*!< \image html palettes/palette_seismic.png */
|
||||
JKQTPMathImageTerrain, /*!< \image html palettes/palette_terrain.png */
|
||||
JKQTPMathImageViridis, /*!< \image html palettes/palette_viridis.png \see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImageMagma, /*!< \image html palettes/palette_magma.png \see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImageInferno, /*!< \image html palettes/palette_inferno.png \see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImagePlasma, /*!< \image html palettes/palette_plasma.png \see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImageViridis, /*!< \image html palettes/palette_viridis.png
|
||||
\see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImageMagma, /*!< \image html palettes/palette_magma.png
|
||||
\see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImageInferno, /*!< \image html palettes/palette_inferno.png
|
||||
\see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
JKQTPMathImagePlasma, /*!< \image html palettes/palette_plasma.png
|
||||
\see from https://github.com/BIDS/colormap/blob/master/colormaps.py https://github.com/BIDS/colormap/blob/master/colormaps.py */
|
||||
|
||||
|
||||
JKQTPMathImageBLUEMAGENTAYELLOW, /*!< \image html palettes/palette_BlMaYe.png */
|
||||
@ -245,7 +249,7 @@ struct JKQTPImageTools {
|
||||
...
|
||||
</ColorMap>
|
||||
\endverbatim
|
||||
optionally several \c <ColorMap>...</ColorMap> definitions may be put below an arbitrarily named
|
||||
optionally several \code <ColorMap>...</ColorMap> \endcode definitions may be put below an arbitrarily named
|
||||
document node, e.g.:
|
||||
\verbatim
|
||||
<ColorMaps>
|
||||
|
||||
@ -50,28 +50,28 @@ public:
|
||||
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param fx function \f$ f_x(t) \f$
|
||||
* \param fy function \f$ f_y(t) \f$
|
||||
* \param minSamples the minimum number of points to evaluate the function at
|
||||
* \param maxRefinementDegree the maximum number of recursive refinement steps
|
||||
* \param fx_ function \f$ f_x(t) \f$
|
||||
* \param fy_ function \f$ f_y(t) \f$
|
||||
* \param minSamples_ the minimum number of points to evaluate the function at
|
||||
* \param maxRefinementDegree_ the maximum number of recursive refinement steps
|
||||
* each step bisects the interval \f$ [a, b] \f$ into two halfes. So the maximum number
|
||||
* of points plotted at all are thus:
|
||||
* \f[ \mbox{minSamples} \cdot 2^{\mbox{maxRefinementDegree}} \f]
|
||||
* \param slopeTolerance the tolerance for the difference of two subsequent slopes
|
||||
* \param minPixelPerSample create one sample at least every \a minPixelPerSample pixels
|
||||
* \param slopeTolerance_ the tolerance for the difference of two subsequent slopes
|
||||
* \param minPixelPerSample_ create one sample at least every \a minPixelPerSample pixels
|
||||
*/
|
||||
JKQTPAdaptiveFunctionGraphEvaluator(const std::function<double(double)>& fx_, const std::function<double(double)>& fy_, unsigned int minSamples_=10, unsigned int maxRefinementDegree_=5, double slopeTolerance_=0.005, double minPixelPerSample_=32);
|
||||
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param fxy function \f$ [x,y]=f_{xy}(t) \f$
|
||||
* \param minSamples the minimum number of points to evaluate the function at
|
||||
* \param maxRefinementDegree the maximum number of recursive refinement steps
|
||||
* \param fxy_ function \f$ [x,y]=f_{xy}(t) \f$
|
||||
* \param minSamples_ the minimum number of points to evaluate the function at
|
||||
* \param maxRefinementDegree_ the maximum number of recursive refinement steps
|
||||
* each step bisects the interval \f$ [a, b] \f$ into two halfes. So the maximum number
|
||||
* of points plotted at all are thus:
|
||||
* \f[ \mbox{minSamples} \cdot 2^{\mbox{maxRefinementDegree}} \f]
|
||||
* \param slopeTolerance the tolerance for the difference of two subsequent slopes
|
||||
* \param minPixelPerSample create one sample at least every \a minPixelPerSample pixels
|
||||
* \param slopeTolerance_ the tolerance for the difference of two subsequent slopes
|
||||
* \param minPixelPerSample_ create one sample at least every \a minPixelPerSample pixels
|
||||
*/
|
||||
JKQTPAdaptiveFunctionGraphEvaluator(const std::function<QPointF(double)>& fxy_, unsigned int minSamples_=10, unsigned int maxRefinementDegree_=5, double slopeTolerance_=0.005, double minPixelPerSample_=32);
|
||||
|
||||
|
||||
@ -71,19 +71,6 @@
|
||||
* - then you can query the time difference to the last call of start() by using getTime().
|
||||
* .
|
||||
*
|
||||
* This is the result of a test on a WinXP system, Athlon64 X2 3800+ (2GHz):
|
||||
* \image html highrestimer.png
|
||||
* Note that this histogram tells you more about how your system works than about the timer itself.
|
||||
* What we can find out about the timer is that it really provides a resolution in the microsecond region. This can
|
||||
* be seen, as there is a non-zero minimal measured interval (1.67619 usec). This basically tells us the run-time of
|
||||
* the measurement loop. There are also bigger run-times which are produced, as this program ran on a multi-process
|
||||
* (not process<b>or</b> !!!) OS, which means that the current process may be stalled to allow othe rprocesses to
|
||||
* execute. If this would run on a single-process system we should only get one run-time, if we assume that all
|
||||
* methods need a fixed amount of time. So we can use this method to test whether our system provides a sufficiently
|
||||
* accurate time. The 1.68 usec give an upper bound for the timer interval and thus the resolution they do <b>not</b>
|
||||
* represent the timer resolution. To get this nominal resolution in a windows system you could use the WinAPI method
|
||||
* \c QueryPerformanceFrequency() which is used in the method getTime(). On my system the timer frequency is 3.57955 MHz
|
||||
* which corresponds to a resolution of 0.2794 usec.
|
||||
*
|
||||
* \par win32 implementation issues:
|
||||
* To implement this timer on windows systems I use two API calls from the windows kernel. They are:
|
||||
@ -97,24 +84,6 @@
|
||||
* from the counter value difference using:
|
||||
* \f[ \Delta t=\frac{N_{\mbox{now}}-N_{\mbox{start}}}{\mbox{\texttt{QueryPerformanceFrequency()}}}\cdot 10^{6} \f]
|
||||
*
|
||||
* \par why not standard POSIX?
|
||||
* The standard POSIX time functions available in a MinGW environment have a resolution that is in the range of
|
||||
* some 10 milliseconds. This may be enough for many purposes, but for exact time measurement, as you will want
|
||||
* to do it on measurement and control systems this is not sufficient. So I tried to find a possibility to
|
||||
* implement a system-independent high-resolution timer. As most timer stuff depends on very low-level kernel
|
||||
* calls on every operating system this seems to be nearly impossible. So I implemented this timer for win32 only,
|
||||
* as this is the system we use in the lab.
|
||||
*
|
||||
* \par linux implementation possibility:
|
||||
* This class does not implement a timer for Linux/Unix systems but I
|
||||
* will provide you with a small hint how you could implement one here:
|
||||
* The <a href="http://www.gnu.org/software/libc/manual/html_node/High_002dResolution-Calendar.html">\c gettimeofday()
|
||||
* method</a> from the libc seems to have enough tim resolution for our pourposes, so try to use this for the high-
|
||||
* resolution timer. As mentioned above this method is not available for MinGW in win32 which is the main development
|
||||
* platform for this project.
|
||||
*
|
||||
* \test you can find an example application in the file \link test_hrestimer.cpp \endlink.
|
||||
*
|
||||
*/
|
||||
class JKQTCOMMON_LIB_EXPORT JKQTPHighResTimer {
|
||||
protected:
|
||||
|
||||
@ -780,7 +780,6 @@ inline bool jkqtplinalgLinSolve(const T* A, const T* b, long N, T* result_out) {
|
||||
|
||||
\param A an NxN matrix of coefficients
|
||||
\param[in,out] b an N-entry vector (also receives the result)
|
||||
\param N number of equations
|
||||
\param N number of rows and columns in \a A
|
||||
\return \c true on success
|
||||
|
||||
|
||||
@ -386,9 +386,10 @@ inline double jkqtpstatSumSqr(InputIt first, InputIt last, size_t* Noutput=nullp
|
||||
\param first iterator pointing to the first item in the dataset to use \f$ X_1 \f$
|
||||
\param last iterator pointing behind the last item in the dataset to use \f$ X_N \f$
|
||||
\param[out] output This iterator is used to store the results, use e.g. a std::back_inserter
|
||||
\return vector of cummulative (or partial) sums returned between \a first and \a last (excluding invalid doubles).
|
||||
For invalid values, the last sum is re-inserted, so the returned vector has the same number of entries
|
||||
as the range \a first ... \a last
|
||||
Output is then a vector of cummulative (or partial) sums returned between
|
||||
\a first and \a last (excluding invalid doubles).
|
||||
For invalid values, the last sum is re-inserted, so the returned vector has
|
||||
the same number of entries as the range \a first ... \a last
|
||||
|
||||
This function implements:
|
||||
\f[ \sum(X)_j=\cdot\sum\limits_{i=1}^{j}X_i \f]
|
||||
|
||||
@ -447,7 +447,6 @@ inline void jkqtpstatKDE1D(InputIt first, InputIt last, double binXLeft, double
|
||||
\param firstY iterator pointing to the first y-position item in the dataset to use \f$ Y_1 \f$
|
||||
\param lastY iterator pointing behind the last y-position item in the dataset to use \f$ Y_N \f$
|
||||
\param kernel the kernel function to use (e.g. jkqtpstatKernel1DGaussian() )
|
||||
\param kernel the kernel function to use (e.g. jkqtpstatKernel2DGaussian() )
|
||||
\param bandwidthX x-bandwidth used for the KDE
|
||||
\param bandwidthY y-bandwidth used for the KDE
|
||||
|
||||
|
||||
@ -50,7 +50,6 @@
|
||||
\tparam InputItX standard iterator type of \a firstX and \a lastX.
|
||||
\tparam InputItY standard iterator type of \a firstY and \a lastY.
|
||||
\tparam OutputItP output iterator for the polynomial coefficients
|
||||
\param type model to be fitted
|
||||
\param firstX iterator pointing to the first item in the x-dataset to use \f$ x_1 \f$
|
||||
\param lastX iterator pointing behind the last item in the x-dataset to use \f$ x_N \f$
|
||||
\param firstY iterator pointing to the first item in the y-dataset to use \f$ y_1 \f$
|
||||
|
||||
@ -137,7 +137,7 @@ JKQTMATHTEXT_LIB_EXPORT void initJKQTMathTextResources();
|
||||
font!). Best coverage should be given by Unicode font encoding with a good
|
||||
unicode font installed!<br>\image html jkqtmathtext_symbols.png
|
||||
- <code>\\vec{x} \\dot{x} \\ddot{x} \\overline{x} \\underline{x} \\hat{x} \\tilde{x} \\uul{x} \\ool{x} \\bar{x} \\arrow{x} </code>: Decorations over/under symbols \image html jkqtmathtext_mathdeco.png
|
||||
- <code>\\verb{don't parse this _aaa\LaTeX} </code>: interpret enclosed text as verbose \image html jkqtmathtext_verb.png
|
||||
- <code>\\verb{don't parse this _aaa\\LaTeX} </code>: interpret enclosed text as verbose \image html jkqtmathtext_verb.png
|
||||
.
|
||||
|
||||
\subsection JKQTMathTextSuppoertedLaTeXBraces Braces ...
|
||||
@ -151,31 +151,31 @@ JKQTMATHTEXT_LIB_EXPORT void initJKQTMathTextResources();
|
||||
- \c \c \\left\\lfloor \c \\right\\rfloor : floor braces , \image html jkqtmathtext_brace_floor.png
|
||||
- \c \\left~ \c \\right~ \c \\left\\lceil \c \\right\\rceil : ceil braces , \image html jkqtmathtext_brace_ceil.png
|
||||
- \c \\left| \c \\right| : absolute value braces | |, \image html jkqtmathtext_brace_oneline.png
|
||||
- \c \\left\| \c \\right\| : norm braces || ||, \image html jkqtmathtext_brace_dblline.png
|
||||
- \code \left\| \right\| \endcode : norm braces || ||, \image html jkqtmathtext_brace_dblline.png
|
||||
- You can use \c \\left. or \c \\right. to have only right or only left brace
|
||||
.
|
||||
|
||||
\subsection JKQTMathTextSuppoertedLaTeXUnderOver Undersetting, Oversetting, Underbraces, Overbraces ...
|
||||
There are also instructions that allow to under/overset braces, arrows, ...:
|
||||
- <code>$\underbrace{x+x+...+x}{k\ \mathrm{times}}$</code> \image html jkqtmathtext_brace_underbrace.png
|
||||
- <code>$\overbrace{x+x+...+x}{k\ \mathrm{times}}$</code> \image html jkqtmathtext_brace_overbrace.png
|
||||
- <code>$\overset{main}{over}$</code> \image html jkqtmathtext_brace_overset.png
|
||||
- <code>$\underset{main}{under}$</code> \image html jkqtmathtext_brace_underset.png
|
||||
- <code>$\\underbrace{x+x+...+x}{k\\ \\mathrm{times}}$</code> \image html jkqtmathtext_brace_underbrace.png
|
||||
- <code>$\\overbrace{x+x+...+x}{k\\ \\mathrm{times}}$</code> \image html jkqtmathtext_brace_overbrace.png
|
||||
- <code>$\\overset{main}{over}$</code> \image html jkqtmathtext_brace_overset.png
|
||||
- <code>$\\underset{main}{under}$</code> \image html jkqtmathtext_brace_underset.png
|
||||
.
|
||||
|
||||
\subsection JKQTMathTextSuppoertedLaTeXMatrix Matrix/Array Type Instructions
|
||||
Several Matrix/Array-typed LaTeX instructions are supported:
|
||||
- <code>$\frac{...}{...}$</code>, <code>$\tfrac{...}{...}$</code> (70% smaller font), <code>$\dfrac{...}{...}$</code> \image html jkqtmathtext_brace_frac.png
|
||||
- <code>$\sfrac{...}{...}$</code> \image html mathparser/MTFMsfrac.png
|
||||
- <code>$\stfrac{...}{...}$</code> (70% smaller font) \image html mathparser/MTFMstfrac.png
|
||||
- <code>$\stackrel{...}{...}$ $\binom{...}{...}$</code> \image html jkqtmathtext_brace_stackrel.png
|
||||
- <code>$\begin{cases} ... & ... \\ ... & ... \end{cases}$</code> \image html jkqtmathtext_brace_begincases.png
|
||||
- <code>$\begin{array} a & b & ...\\ c & d & ...\end{array}$</code> <code>$\begin{matrix} a & b & ...\\ c & d & ...\end{matrix}$</code> \image html jkqtmathtext_array.png
|
||||
- <code>$\begin{pmatrix} a & b & ...\\ c & d & ...\end{pmatrix}$</code> \image html jkqtmathtext_pmatrix.png
|
||||
- <code>$\begin{bmatrix} a & b & ...\\ c & d & ...\end{bmatrix}$</code> \image html jkqtmathtext_bmatrix.png
|
||||
- <code>$\begin{Bmatrix} a & b & ...\\ c & d & ...\end{Bmatrix}$</code> \image html jkqtmathtext_bbmatrix.png
|
||||
- <code>$\begin{vmatrix} a & b & ...\\ c & d & ...\end{vmatrix}$</code> \image html jkqtmathtext_vmatrix.png
|
||||
- <code>$\begin{Vmatrix} a & b & ...\\ c & d & ...\end{Vmatrix}$</code> \image html jkqtmathtext_vvmatrix.png
|
||||
- <code>$\\frac{...}{...}$</code>, <code>$\\tfrac{...}{...}$</code> (70% smaller font), <code>$\\dfrac{...}{...}$</code> \image html jkqtmathtext_brace_frac.png
|
||||
- <code>$\\sfrac{...}{...}$</code> \image html mathparser/MTFMsfrac.png
|
||||
- <code>$\\stfrac{...}{...}$</code> (70% smaller font) \image html mathparser/MTFMstfrac.png
|
||||
- <code>$\\stackrel{...}{...}$ $\\binom{...}{...}$</code> \image html jkqtmathtext_brace_stackrel.png
|
||||
- <code>$\\begin{cases} ... & ... \\\\ ... & ... \\end{cases}$</code> \image html jkqtmathtext_brace_begincases.png
|
||||
- <code>$\\begin{array} a & b & ...\\\\ c & d & ...\\end{array}$</code> <code>$\\begin{matrix} a & b & ...\\\\ c & d & ...\\end{matrix}$</code> \image html jkqtmathtext_array.png
|
||||
- <code>$\\begin{pmatrix} a & b & ...\\\\ c & d & ...\\end{pmatrix}$</code> \image html jkqtmathtext_pmatrix.png
|
||||
- <code>$\\begin{bmatrix} a & b & ...\\\\ c & d & ...\\end{bmatrix}$</code> \image html jkqtmathtext_bmatrix.png
|
||||
- <code>$\\begin{Bmatrix} a & b & ...\\\\ c & d & ...\\end{Bmatrix}$</code> \image html jkqtmathtext_bbmatrix.png
|
||||
- <code>$\\begin{vmatrix} a & b & ...\\\\ c & d & ...\\end{vmatrix}$</code> \image html jkqtmathtext_vmatrix.png
|
||||
- <code>$\\begin{Vmatrix} a & b & ...\\\\ c & d & ...\\end{Vmatrix}$</code> \image html jkqtmathtext_vvmatrix.png
|
||||
.
|
||||
|
||||
\section JKQTMathTextSuppoertedFonts Font Handling
|
||||
@ -189,7 +189,7 @@ JKQTMATHTEXT_LIB_EXPORT void initJKQTMathTextResources();
|
||||
- A symbol font used to display special (math) symbols. ( setSymbolfontSymbol() )
|
||||
- A "roman" font used as the standard font in math mode ( setFontMathRoman() )
|
||||
- A "sans-serif" used as sans serif font in math mode ( setFontMathSans() )
|
||||
- A "blackboard" font used to display double stroked characters (setFontBlackboard() )
|
||||
- A "blackboard" font used to display double stroked characters ( setFontBlackboard() )
|
||||
- A "caligraphic" font used to display caligraphic characters ( setFontCaligraphic() )
|
||||
.
|
||||
|
||||
|
||||
@ -49,8 +49,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement,
|
||||
\param y y-coordinate of symbol center
|
||||
\param symbol symbol type
|
||||
\param symbolSize size of the symbol in pt
|
||||
\param color color of drawing
|
||||
\param fillColor fill color of the symbol (if filled)
|
||||
*/
|
||||
JKQTPGeoSymbol(JKQTBasePlotter* parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize);
|
||||
/*! \brief class contructor
|
||||
@ -60,8 +58,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoSymbol: public JKQTPPlotAnnotationElement,
|
||||
\param y y-coordinate of symbol center
|
||||
\param symbol symbol type
|
||||
\param symbolSize size of the symbol in pt
|
||||
\param color color of drawing
|
||||
\param fillColor fill color of the symbol (if filled)
|
||||
*/
|
||||
JKQTPGeoSymbol(JKQTPlotter* parent, double x, double y, JKQTPGraphSymbols symbol, double symbolSize);
|
||||
/*! \brief class contructor
|
||||
|
||||
@ -213,36 +213,43 @@ public:
|
||||
*/
|
||||
JKQTPGeoArrow(JKQTPlotter* parent, double x1, double y1, double x2, double y2, JKQTPLineDecoratorStyle headStyle=JKQTPDefaultLineDecorator, JKQTPLineDecoratorStyle tailStyle=JKQTPNoDecorator);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param p1 first point of line (tail)
|
||||
* \param p2 second point of line (head)
|
||||
*
|
||||
*/
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param p1 first point of line (tail)
|
||||
* \param p2 second point of line (head)
|
||||
* \param headStyle decorator/arrow style of the head
|
||||
* \param tailStyle decorator/arrow style of the tail
|
||||
*/
|
||||
JKQTPGeoArrow(JKQTBasePlotter* parent, const QPointF& p1, const QPointF& p2, JKQTPLineDecoratorStyle headStyle=JKQTPDefaultLineDecorator, JKQTPLineDecoratorStyle tailStyle=JKQTPNoDecorator);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param p1 first point of line (tail)
|
||||
* \param p2 second point of line (head)
|
||||
*/
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param p1 first point of line (tail)
|
||||
* \param p2 second point of line (head)
|
||||
* \param headStyle decorator/arrow style of the head
|
||||
* \param tailStyle decorator/arrow style of the tail
|
||||
*/
|
||||
JKQTPGeoArrow(JKQTPlotter* parent, const QPointF& p1, const QPointF& p2, JKQTPLineDecoratorStyle headStyle=JKQTPDefaultLineDecorator, JKQTPLineDecoratorStyle tailStyle=JKQTPNoDecorator);
|
||||
|
||||
|
||||
|
||||
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param line the line
|
||||
*
|
||||
*/
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param line the line
|
||||
* \param headStyle decorator/arrow style of the head
|
||||
* \param tailStyle decorator/arrow style of the tail
|
||||
*
|
||||
*/
|
||||
JKQTPGeoArrow(JKQTBasePlotter* parent, const QLineF& line, JKQTPLineDecoratorStyle headStyle=JKQTPDefaultLineDecorator, JKQTPLineDecoratorStyle tailStyle=JKQTPNoDecorator);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param line the line
|
||||
*/
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param line the line
|
||||
* \param headStyle decorator/arrow style of the head
|
||||
* \param tailStyle decorator/arrow style of the tail
|
||||
*/
|
||||
JKQTPGeoArrow(JKQTPlotter* parent, const QLineF& line, JKQTPLineDecoratorStyle headStyle=JKQTPDefaultLineDecorator, JKQTPLineDecoratorStyle tailStyle=JKQTPNoDecorator);
|
||||
};
|
||||
|
||||
@ -279,9 +286,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoInfiniteLine: public JKQTPGeoBaseDecoratedH
|
||||
* \param y y-coordinate of start point of line
|
||||
* \param dx x-direction of the line
|
||||
* \param dy y-direction of the line
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoInfiniteLine(JKQTBasePlotter* parent, double x, double y, double dx, double dy);
|
||||
/** \brief class constructor
|
||||
@ -291,9 +295,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoInfiniteLine: public JKQTPGeoBaseDecoratedH
|
||||
* \param y y-coordinate of start point of line
|
||||
* \param dx x-direction of the line
|
||||
* \param dy y-direction of the line
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoInfiniteLine(JKQTPlotter* parent, double x, double y, double dx, double dy);
|
||||
|
||||
@ -381,34 +382,22 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoPolyLines: public JKQTPGeoBaseDecoratedLine
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param points points on the polygon
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoPolyLines(JKQTBasePlotter* parent, const QVector<QPointF>& points);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param points points on the polygon
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoPolyLines(JKQTPlotter* parent, const QVector<QPointF>& points);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoPolyLines(JKQTBasePlotter* parent);
|
||||
/** \brief class constructor
|
||||
*
|
||||
* \param parent the parent plotter object
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
*/
|
||||
JKQTPGeoPolyLines(JKQTPlotter* parent);
|
||||
|
||||
@ -489,9 +478,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoArc: public JKQTPGeoBaseLine {
|
||||
* \param height of ellipse (2 * half axis)
|
||||
* \param angleStart if we only draw an arc, this is the starting angle in degrees
|
||||
* \param angleStop if we only draw an arc, this is the ending angle in degrees
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
|
||||
*/
|
||||
JKQTPGeoArc(JKQTBasePlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop);
|
||||
@ -504,9 +490,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPGeoArc: public JKQTPGeoBaseLine {
|
||||
* \param height of ellipse (2 * half axis)
|
||||
* \param angleStart if we only draw an arc, this is the starting angle in degrees
|
||||
* \param angleStop if we only draw an arc, this is the ending angle in degrees
|
||||
* \param color color of line
|
||||
* \param lineWidth width of line
|
||||
* \param style line style
|
||||
|
||||
*/
|
||||
JKQTPGeoArc(JKQTPlotter* parent, double x, double y, double width, double height, double angleStart, double angleStop);
|
||||
|
||||
@ -233,8 +233,6 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPMathImageBase: public JKQTPImageBase {
|
||||
virtual void setDatatypeModifier(JKQTPMathImageDataType __value);
|
||||
/** \copydoc datatypeModifier */
|
||||
virtual JKQTPMathImageDataType getDatatypeModifier() const;
|
||||
/** \copydoc modifierMode */
|
||||
|
||||
/** \brief sets dataModifier (\copybrief dataModifier ) and datatypeModifier (\copybrief datatypeModifier ) */
|
||||
virtual void setDataModifier(const void *data, JKQTPMathImageDataType datatype);
|
||||
/** \brief sets data (\copybrief data ) and datatype (\copybrief datatype ), as well as the size of data (Nx: \copybrief Nx and Ny: \copybrief Ny ) */
|
||||
|
||||
@ -2227,7 +2227,6 @@ JKQTPLOTTER_LIB_EXPORT JKQTPXFunctionLineGraph* jkqtpstatAddWeightedRegression(J
|
||||
\tparam InputItY standard iterator type of \a firstY and \a lastY.
|
||||
\tparam OutputItP output iterator for the polynomial coefficients
|
||||
\param plotter the plotter to which to add the resulting graph
|
||||
\param type model to be fitted
|
||||
\param firstX iterator pointing to the first item in the x-dataset to use \f$ x_1 \f$
|
||||
\param lastX iterator pointing behind the last item in the x-dataset to use \f$ x_N \f$
|
||||
\param firstY iterator pointing to the first item in the y-dataset to use \f$ y_1 \f$
|
||||
@ -2264,7 +2263,6 @@ inline JKQTPXFunctionLineGraph* jkqtpstatAddPolyFit(JKQTBasePlotter* plotter, In
|
||||
\tparam InputItX standard iterator type of \a firstX and \a lastX.
|
||||
\tparam InputItY standard iterator type of \a firstY and \a lastY.
|
||||
\param plotter the plotter to which to add the resulting graph
|
||||
\param type model to be fitted
|
||||
\param firstX iterator pointing to the first item in the x-dataset to use \f$ x_1 \f$
|
||||
\param lastX iterator pointing behind the last item in the x-dataset to use \f$ x_N \f$
|
||||
\param firstY iterator pointing to the first item in the y-dataset to use \f$ y_1 \f$
|
||||
|
||||
@ -670,7 +670,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject {
|
||||
double getAxisAspectRatio() const;
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForSystem */
|
||||
bool isUsingAntiAliasingForSystem() const;
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForGraphs */
|
||||
/** \copydoc JKQTGraphsBaseStyle::useAntiAliasingForGraphs */
|
||||
bool isUsingAntiAliasingForGraphs() const;
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForText */
|
||||
bool isUsingAntiAliasingForText() const;
|
||||
@ -1454,7 +1454,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject {
|
||||
void setAxisAspectRatio(double __value);
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForSystem */
|
||||
void setUseAntiAliasingForSystem(bool __value);
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForGraphs */
|
||||
/** \copydoc JKQTGraphsBaseStyle::useAntiAliasingForGraphs */
|
||||
void setUseAntiAliasingForGraphs(bool __value);
|
||||
/** \copydoc JKQTBasePlotterStyle::useAntiAliasingForText */
|
||||
void setUseAntiAliasingForText(bool __value);
|
||||
|
||||
@ -277,17 +277,17 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject {
|
||||
inline QColor getAxisColor() const { return this->axisStyle.axisColor; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::showZeroAxis */
|
||||
inline bool getShowZeroAxis() const { return this->axisStyle.showZeroAxis; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridColor */
|
||||
/** \copydoc JKQTPGridStyle::lineColor */
|
||||
inline QColor getGridColor() const { return this->axisStyle.majorGridStyle.lineColor; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridColor */
|
||||
/** \copydoc JKQTPGridStyle::lineColor */
|
||||
inline QColor getMinorGridColor() const { return this->axisStyle.minorGridStyle.lineColor; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridWidth */
|
||||
/** \copydoc JKQTPGridStyle::lineWidth */
|
||||
inline double getGridWidth() const { return this->axisStyle.majorGridStyle.lineWidth; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridStyle */
|
||||
/** \copydoc JKQTPGridStyle::lineStyle */
|
||||
inline Qt::PenStyle getGridStyle() const { return this->axisStyle.majorGridStyle.lineStyle; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */
|
||||
/** \copydoc JKQTPGridStyle::lineWidth */
|
||||
inline double getMinorGridWidth() const { return this->axisStyle.minorGridStyle.lineWidth; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */
|
||||
/** \copydoc JKQTPGridStyle::lineStyle */
|
||||
inline Qt::PenStyle getMinorGridStyle() const { return this->axisStyle.minorGridStyle.lineStyle; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::tickTimeFormat */
|
||||
inline QString getTickTimeFormat() const { return this->axisStyle.tickTimeFormat; }
|
||||
@ -314,9 +314,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject {
|
||||
inline double getTickLabelDistance() const { return this->axisStyle.tickLabelDistance; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::labelDistance */
|
||||
inline double getLabelDistance() const { return this->axisStyle.labelDistance; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::drawGrid */
|
||||
/** \copydoc JKQTPGridStyle::enabled */
|
||||
inline bool getDrawGrid() const { return this->axisStyle.majorGridStyle.enabled; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */
|
||||
/** \copydoc JKQTPGridStyle::enabled */
|
||||
inline bool getDrawMinorGrid() const { return this->axisStyle.minorGridStyle.enabled; }
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::autoLabelDigits */
|
||||
inline void setAutoLabelDigits(bool __value)
|
||||
@ -507,22 +507,22 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject {
|
||||
/** \copydoc inverted */
|
||||
void setInverted(bool __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridColor */
|
||||
/** \copydoc JKQTPGridStyle::lineColor */
|
||||
void setGridColor(const QColor& __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridColor */
|
||||
/** \copydoc JKQTPGridStyle::lineColor */
|
||||
void setMinorGridColor(const QColor& __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridWidth */
|
||||
/** \copydoc JKQTPGridStyle::lineWidth */
|
||||
void setGridWidth (double __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::gridStyle */
|
||||
/** \copydoc JKQTPGridStyle::lineStyle */
|
||||
void setGridStyle(Qt::PenStyle __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridWidth */
|
||||
/** \copydoc JKQTPGridStyle::lineWidth */
|
||||
void setMinorGridWidth(double __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::minorGridStyle */
|
||||
/** \copydoc JKQTPGridStyle::lineStyle */
|
||||
void setMinorGridStyle (Qt::PenStyle __value);
|
||||
|
||||
|
||||
@ -552,10 +552,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPCoordinateAxis: public QObject {
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::labelDigits */
|
||||
void setLabelDigits(int __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::drawGrid */
|
||||
/** \copydoc JKQTPGridStyle::enabled */
|
||||
void setDrawGrid(bool __value);
|
||||
|
||||
/** \copydoc JKQTPCoordinateAxisStyle::drawMinorGrid */
|
||||
/** \copydoc JKQTPGridStyle::enabled */
|
||||
void setDrawMinorGrid(bool __value);
|
||||
|
||||
|
||||
|
||||
@ -109,8 +109,8 @@ enum class JKQTPDatastoreItemFormat {
|
||||
* QVector<double> X, Y;
|
||||
* const int Ndata=100;
|
||||
* for (int i=0; i<Ndata; i++) {
|
||||
* * const double x=double(i)/double(Ndata)*8.0*JKQTPSTATISTICS_PI;
|
||||
* X<<x;
|
||||
* const double x=double(i)/double(Ndata)*8.0*JKQTPSTATISTICS_PI;
|
||||
* X<<x;
|
||||
* Y<<sin(x);
|
||||
* }
|
||||
* plot.addGraph(linegraph=new JKQTPXYLineGraph(&plot));
|
||||
|
||||
@ -786,9 +786,9 @@ public slots:
|
||||
void setXXYColumns(int xCol, int x2Col, int yCol);
|
||||
|
||||
|
||||
/** \copydoc yColumn2 */
|
||||
/** \copydoc xColumn2 */
|
||||
void setXColumn2(int __value);
|
||||
/** \copydoc yColumn2 */
|
||||
/** \copydoc xColumn2 */
|
||||
void setXColumn2(size_t __value);
|
||||
protected:
|
||||
|
||||
|
||||
@ -220,6 +220,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTGraphsBaseStyle {
|
||||
* \param group Group in the QSettings-object to read from
|
||||
* \param defaultStyle If a setting cannot be found in \a settings, default values are taken from this object
|
||||
* By default, this is a default-constructed object
|
||||
* \param parent parent JKQTBasePlotterStyle instance for inital values
|
||||
*/
|
||||
void loadSettings(const QSettings &settings, const QString& group, const JKQTGraphsBaseStyle &defaultStyle, const JKQTBasePlotterStyle& parent);
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user