mirrors/JKQtPlotter
1
0
Fork 0
mirror of https://github.com/jkriege2/JKQtPlotter.git synced 2024-12-26 02:21:43 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

improvements to documentation structure

Browse Source
This commit is contained in:
jkriege2 2019-05-30 11:52:48 +02:00
parent fdc4a1deb9
commit c56b02998f
4 changed files with 33 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/dox/jkqtplotter.dox
View File

@ -72,9 +72,15 @@ All statistics functions use all values in the given range and convert each valu
\defgroup jkqtptools_math_statistics_1dhist 1-dimensional Histograms \defgroup jkqtptools_math_statistics_1dhist 1-dimensional Histograms
\ingroup jkqtptools_math_statistics \ingroup jkqtptools_math_statistics
\defgroup jkqtptools_math_statistics_1dhist_kernels Kernels for 1-dimensional Histograms
\ingroup jkqtptools_math_statistics_1dhist
\defgroup jkqtptools_math_statistics_2dhist 2-dimensional Histograms \defgroup jkqtptools_math_statistics_2dhist 2-dimensional Histograms
\ingroup jkqtptools_math_statistics \ingroup jkqtptools_math_statistics
\defgroup jkqtptools_math_statistics_2dhist_kernels Kernels for 2-dimensional Histograms
\ingroup jkqtptools_math_statistics_2dhist
\defgroup jkqtptools_math_statistics_1dkde 1-dimensional Kernel Density Estimates \defgroup jkqtptools_math_statistics_1dkde 1-dimensional Kernel Density Estimates
\ingroup jkqtptools_math_statistics \ingroup jkqtptools_math_statistics

2
examples/simpletest_imageplot_modifier/README.md
View File

@ -1,4 +1,4 @@
# Example (JKQTPlotter): Simple math image plot {#JKQTPlotterImagePlotModifier} # Example (JKQTPlotter): Simple math image plot with modifier datat {#JKQTPlotterImagePlotModifier}
This project (see `./examples/simpletest_imageplot_modifier/`) creates a JKQTPlotter widget (as a new window) and adds a color-coded image plot of a mathematical function (here `sin(r)`). Then a second image (linearly scaling from 1 in the center to 0 at the borders) is used to modify the first image. The modification can alter several properties of the original image, like its saturation, its transparency (alpha) ... This project (see `./examples/simpletest_imageplot_modifier/`) creates a JKQTPlotter widget (as a new window) and adds a color-coded image plot of a mathematical function (here `sin(r)`). Then a second image (linearly scaling from 1 in the center to 0 at the borders) is used to modify the first image. The modification can alter several properties of the original image, like its saturation, its transparency (alpha) ...
The source code of the main application is (see [`jkqtplotter_simpletest_imageplot_modifier.cpp`](https://github.com/jkriege2/JKQtPlotter/tree/master/examples/simpletest_imageplot_modifier/jkqtplotter_simpletest_imageplot_modifier.cpp): The source code of the main application is (see [`jkqtplotter_simpletest_imageplot_modifier.cpp`](https://github.com/jkriege2/JKQtPlotter/tree/master/examples/simpletest_imageplot_modifier/jkqtplotter_simpletest_imageplot_modifier.cpp):

28
lib/jkqtcommon/jkqtpstatisticstools.h
View File

@ -1433,64 +1433,64 @@ inline void jkqtpstatHistogram1D(InputIt first, InputIt last, BinsInputIt binsFi
/*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t):=\frac{1}{\sqrt{2\pi}}\exp \left(-\frac{1}{2}t^2\right) \f] \f[ k(t):=\frac{1}{\sqrt{2\pi}}\exp \left(-\frac{1}{2}t^2\right) \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DGaussian(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DGaussian(double t);
/*! \brief a 1D Cauchy kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Cauchy kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t):=\frac{1}{\pi(1+t^2)} \f] \f[ k(t):=\frac{1}{\pi(1+t^2)} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DCauchy(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DCauchy(double t);
/*! \brief a 1D Picard kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Picard kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t):=\frac{1}{2}\exp(-|t|) \f] \f[ k(t):=\frac{1}{2}\exp(-|t|) \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DPicard(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DPicard(double t);
/*! \brief a 1D Epanechnikov kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Epanechnikov kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}\frac{3}{4} ( 1- t^2 ), & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}\frac{3}{4} ( 1- t^2 ), & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DEpanechnikov(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DEpanechnikov(double t);
/*! \brief a 1D uniform kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D uniform kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}1, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}0.5, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DUniform(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DUniform(double t);
/*! \brief a 1D Epanechnikov kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Epanechnikov kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}1-|t|, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}1-|t|, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DTriangle(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DTriangle(double t);
/*! \brief a 1D quartic kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D quartic kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}\frac{15}{16}(1-t^2)^2, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}\frac{15}{16}(1-t^2)^2, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DQuartic(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DQuartic(double t);
/*! \brief a 1D triweight kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D triweight kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}\frac{35}{32}(1-t^2)^3, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}\frac{35}{32}(1-t^2)^3, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DTriweight(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DTriweight(double t);
/*! \brief a 1D tricube kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D tricube kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}\frac{70}{81}(1-|t|^3)^3, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}\frac{70}{81}(1-|t|^3)^3, & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel1DTricube(double t); JKQTP_LIB_EXPORT double jkqtpstatKernel1DTricube(double t);
/*! \brief a 1D cosine kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D cosine kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_1dkde \ingroup jkqtptools_math_statistics_1dkde_kernels
\f[ k(t) :=\begin{cases}\frac{\pi}{4}\cos\left(\frac{\pi}{2}t\right), & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t) :=\begin{cases}\frac{\pi}{4}\cos\left(\frac{\pi}{2}t\right), & \text{if }t\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
@ -1509,14 +1509,14 @@ JKQTP_LIB_EXPORT double jkqtpstatKernel1DCosine(double t);
/*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_2dkde \ingroup jkqtptools_math_statistics_2dkde_kernels
\f[ k(t_x, t_y):=\frac{1}{2\pi}\exp \left(-\frac{t_x^2+t_y^2}{2}\right) \f] \f[ k(t_x, t_y):=\frac{1}{2\pi}\exp \left(-\frac{t_x^2+t_y^2}{2}\right) \f]
*/ */
JKQTP_LIB_EXPORT double jkqtpstatKernel2DGaussian(double tx, double ty); JKQTP_LIB_EXPORT double jkqtpstatKernel2DGaussian(double tx, double ty);
/*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation /*! \brief a 1D Gaussian kernel function, e.g. for Kernel Density Estimation
\ingroup jkqtptools_math_statistics_2dkde \ingroup jkqtptools_math_statistics_2dkde_kernels
\f[ k(t_x, t_y):=\begin{cases}\frac{1}{4}, & \text{if }t_x,t_y\in [-1;1]\\0, & \text{else}\end{cases} \f] \f[ k(t_x, t_y):=\begin{cases}\frac{1}{4}, & \text{if }t_x,t_y\in [-1;1]\\0, & \text{else}\end{cases} \f]
*/ */
@ -1801,8 +1801,6 @@ inline void jkqtpstatKDE1D(InputIt first, InputIt last, double binXLeft, double
#endif // JKQTPSTATISTICSTOOLS_H_INCLUDED #endif // JKQTPSTATISTICSTOOLS_H_INCLUDED

26
lib/jkqtplotter/jkqtpgraphsstatisticsadaptors.h
View File

@ -29,7 +29,7 @@
#define JKQTPGRAPHSSTATISTICSADAPTORS_H_INCLUDED #define JKQTPGRAPHSSTATISTICSADAPTORS_H_INCLUDED
/*! \brief add a JKQTPBoxplotHorizontalElement to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last /*! \brief add a JKQTPBoxplotHorizontalElement to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last
\ingroup jkqtptools_math_statistics_adaptors_adaptors \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
\param plotter the plotter to which to add the resulting graph \param plotter the plotter to which to add the resulting graph
@ -74,7 +74,7 @@ inline JKQTPBoxplotHorizontalElement* jkqtpstatAddHBoxplot(JKQTBasePlotter* plot
/*! \brief add a JKQTPBoxplotVerticalElement to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last /*! \brief add a JKQTPBoxplotVerticalElement to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last
\ingroup jkqtptools_math_statistics_adaptors_adaptors \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
\param plotter the plotter to which to add the resulting graph \param plotter the plotter to which to add the resulting graph
@ -120,7 +120,7 @@ inline JKQTPBoxplotVerticalElement* jkqtpstatAddVBoxplot(JKQTBasePlotter* plotte
/*! \brief add a JKQTPBoxplotHorizontalElement and a JKQTPSingleColumnSymbolsGraph for outliers to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last /*! \brief add a JKQTPBoxplotHorizontalElement and a JKQTPSingleColumnSymbolsGraph for outliers to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last
\ingroup jkqtptools_math_statistics_adaptors_adaptors \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
\param plotter the plotter to which to add the resulting graph \param plotter the plotter to which to add the resulting graph
@ -239,7 +239,7 @@ inline std::pair<JKQTPBoxplotVerticalElement*,JKQTPSingleColumnSymbolsGraph*> jk
/*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their number /*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their number
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -275,7 +275,7 @@ inline JKQTPBarVerticalGraph* jkqtpstatAddHHistogram1DAutoranged(JKQTBasePlotter
/*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -310,7 +310,7 @@ inline JKQTPBarVerticalGraph* jkqtpstatAddHHistogram1DAutoranged(JKQTBasePlotter
/*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged histogram and add a JKQTPBarVerticalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -348,7 +348,7 @@ inline JKQTPBarVerticalGraph* jkqtpstatAddHHistogram1D(JKQTBasePlotter* plotter,
/*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their number /*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their number
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -384,7 +384,7 @@ inline JKQTPBarHorizontalGraph* jkqtpstatAddVHistogram1DAutoranged(JKQTBasePlott
/*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -419,7 +419,7 @@ inline JKQTPBarHorizontalGraph* jkqtpstatAddVHistogram1DAutoranged(JKQTBasePlott
/*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged histogram and add a JKQTPBarHorizontalGraph to the given plotter, where the histogram is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -467,7 +467,7 @@ inline JKQTPBarHorizontalGraph* jkqtpstatAddVHistogram1D(JKQTBasePlotter* plotte
/*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their number /*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their number
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -506,7 +506,7 @@ inline JKQTPXYLineGraph* jkqtpstatAddHKDE1DAutoranged(JKQTBasePlotter* plotter,
/*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -544,7 +544,7 @@ inline JKQTPXYLineGraph* jkqtpstatAddHKDE1DAutoranged(JKQTBasePlotter* plotter,
/*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their width /*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, bins defined by their width
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.
@ -584,7 +584,7 @@ inline JKQTPXYLineGraph* jkqtpstatAddHKDE1D(JKQTBasePlotter* plotter, InputIt fi
} }
/*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, evaluation positions are given by the range \a binXLeft ... \a binXRight (in steps of \a binxDelta ) /*! \brief calculate an autoranged KDE and add a JKQTPXYLineGraph to the given plotter, where the KDE is calculated from the data range \a first ... \a last, evaluation positions are given by the range \a binXLeft ... \a binXRight (in steps of \a binxDelta )
\ingroup jkqtptools_math_statistics_adaptors_1dhist \ingroup jkqtptools_math_statistics_adaptors
\tparam InputIt standard iterator type of \a first and \a last. \tparam InputIt standard iterator type of \a first and \a last.