2019-05-30 04:40:02 +08:00
/*
Copyright ( c ) 2008 - 2019 Jan W . Krieger ( < jan @ jkrieger . de > )
This software is free software : you can redistribute it and / or modify
it under the terms of the GNU Lesser General Public License ( LGPL ) as published by
the Free Software Foundation , either version 2.1 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU Lesser General Public License ( LGPL ) for more details .
You should have received a copy of the GNU Lesser General Public License ( LGPL )
along with this program . If not , see < http : //www.gnu.org/licenses/>.
*/
# include "jkqtcommon/jkqtp_imexport.h"
# include "jkqtcommon/jkqtpstatisticstools.h"
2019-06-02 21:38:09 +08:00
# include "jkqtcommon/jkqtpdebuggingtools.h"
2019-06-02 00:15:04 +08:00
# include "jkqtplotter/jkqtpgraphsbase.h"
# include "jkqtplotter/jkqtpgraphsbaseerrors.h"
2019-05-30 04:40:02 +08:00
# include "jkqtplotter/jkqtpgraphsboxplot.h"
# include "jkqtplotter/jkqtpgraphsscatter.h"
# include "jkqtplotter/jkqtpgraphssinglecolumnsymbols.h"
# include "jkqtplotter/jkqtpgraphsbarchart.h"
2019-06-02 00:15:04 +08:00
# include "jkqtplotter/jkqtpgraphsevaluatedfunction.h"
2019-05-30 04:40:02 +08:00
# ifndef 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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 boxposY y - coordinate of the boxplot
\ param quantile1Spec specifies which quantile to calculate for \ a qantile1 ( range : 0. .1 )
\ param quantile2Spec specifies which quantile to calculate for \ a qantile2 ( range : 0. .1 )
\ param minimumQuantile specifies a quantile for the return value minimum ( default is 0 for the real minimum , but you could e . g . use 0.05 for the 5 % quantile ! )
\ param maximumQuantile specifies a quantile for the return value maximum ( default is 1 for the real maximum , but you could e . g . use 0.95 for the 95 % quantile ! )
\ param [ out ] statOutput optionally returns the internally calculated statistics as a JKQTPStat5NumberStatistics
\ return a boxplot element with its values initialized from the given data range
Example :
\ code
jkqtpstatAddHBoxplot ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_boxplots_simple . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstat5NumberStatistics ( )
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBoxplotHorizontalElement * jkqtpstatAddHBoxplot ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double boxposY , double quantile1Spec = 0.25 , double quantile2Spec = 0.75 , double minimumQuantile = 0 , double maximumQuantile = 1.0 , JKQTPStat5NumberStatistics * statOutput = nullptr ) {
JKQTPStat5NumberStatistics stat = jkqtpstat5NumberStatistics ( first , last , quantile1Spec , quantile2Spec , minimumQuantile , maximumQuantile ) ;
if ( statOutput ) * statOutput = stat ;
JKQTPBoxplotHorizontalElement * res = new JKQTPBoxplotHorizontalElement ( plotter ) ;
res - > setMin ( stat . minimum ) ;
res - > setMax ( stat . maximum ) ;
res - > setMedian ( stat . median ) ;
res - > setMean ( jkqtpstatAverage ( first , last ) ) ;
res - > setPercentile25 ( stat . quantile1 ) ;
res - > setPercentile75 ( stat . quantile2 ) ;
res - > setMedianConfidenceIntervalWidth ( stat . IQRSignificanceEstimate ( ) ) ;
res - > setDrawMean ( true ) ;
res - > setDrawNotch ( true ) ;
res - > setDrawMedian ( true ) ;
res - > setDrawMinMax ( true ) ;
res - > setDrawBox ( true ) ;
res - > setPos ( boxposY ) ;
plotter - > addGraph ( res ) ;
return res ;
}
/*! \brief add a JKQTPBoxplotVerticalElement to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 boxposX x - coordinate of the boxplot
\ param quantile1Spec specifies which quantile to calculate for \ a qantile1 ( range : 0. .1 )
\ param quantile2Spec specifies which quantile to calculate for \ a qantile2 ( range : 0. .1 )
\ param minimumQuantile specifies a quantile for the return value minimum ( default is 0 for the real minimum , but you could e . g . use 0.05 for the 5 % quantile ! )
\ param maximumQuantile specifies a quantile for the return value maximum ( default is 1 for the real maximum , but you could e . g . use 0.95 for the 95 % quantile ! )
\ param [ out ] statOutput optionally returns the internally calculated statistics as a JKQTPStat5NumberStatistics
\ return a boxplot element with its values initialized from the given data range
Example :
\ code
jkqtpstatAddVBoxplot ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ) ;
\ endcode
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstat5NumberStatistics ( )
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBoxplotVerticalElement * jkqtpstatAddVBoxplot ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double boxposX , double quantile1Spec = 0.25 , double quantile2Spec = 0.75 , double minimumQuantile = 0 , double maximumQuantile = 1.0 , JKQTPStat5NumberStatistics * statOutput = nullptr ) {
JKQTPStat5NumberStatistics stat = jkqtpstat5NumberStatistics ( first , last , quantile1Spec , quantile2Spec , minimumQuantile , maximumQuantile ) ;
if ( statOutput ) * statOutput = stat ;
JKQTPBoxplotVerticalElement * res = new JKQTPBoxplotVerticalElement ( plotter ) ;
res - > setMin ( stat . minimum ) ;
res - > setMax ( stat . maximum ) ;
res - > setMedian ( stat . median ) ;
res - > setMean ( jkqtpstatAverage ( first , last ) ) ;
res - > setPercentile25 ( stat . quantile1 ) ;
res - > setPercentile75 ( stat . quantile2 ) ;
res - > setMedianConfidenceIntervalWidth ( stat . IQRSignificanceEstimate ( ) ) ;
res - > setDrawMean ( true ) ;
res - > setDrawNotch ( true ) ;
res - > setDrawMedian ( true ) ;
res - > setDrawMinMax ( true ) ;
res - > setDrawBox ( true ) ;
res - > setPos ( boxposX ) ;
plotter - > addGraph ( res ) ;
return res ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 boxposY y - coordinate of the outliers ( and the boxplot )
\ param quantile1Spec specifies which quantile to calculate for \ a qantile1 ( range : 0. .1 )
\ param quantile2Spec specifies which quantile to calculate for \ a qantile2 ( range : 0. .1 )
\ param minimumQuantile specifies a quantile for the return value minimum ( default is 0 for the real minimum , but you could e . g . use 0.05 for the 5 % quantile ! )
\ param maximumQuantile specifies a quantile for the return value maximum ( default is 1 for the real maximum , but you could e . g . use 0.95 for the 95 % quantile ! )
\ param outliercolumnBaseName this string is used in building the column names for the outlier columns
\ param [ out ] statOutput optionally returns the internally calculated statistics as a JKQTPStat5NumberStatistics
\ return a boxplot element with its values initialized from the given data range
Example :
\ code
jkqtpstatAddHBoxplotAndOutliers ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ) ;
jkqtpstatAddHBoxplotAndOutliers ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ,
0.25 , 0.75 , // 1. and 3. Quartile for the boxplot box
0.05 , 0.95 // Quantiles for the boxplot box whiskers' ends
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_boxplots_outliers . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstat5NumberStatistics ( )
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline std : : pair < JKQTPBoxplotHorizontalElement * , JKQTPSingleColumnSymbolsGraph * > jkqtpstatAddHBoxplotAndOutliers ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double boxposY , double quantile1Spec = 0.25 , double quantile2Spec = 0.75 , double minimumQuantile = 0.03 , double maximumQuantile = 0.97 , const QString & outliercolumnBaseName = QString ( " boxplot " ) , JKQTPStat5NumberStatistics * statOutput = nullptr ) {
JKQTPStat5NumberStatistics stat = jkqtpstat5NumberStatistics ( first , last , quantile1Spec , quantile2Spec , minimumQuantile , maximumQuantile ) ;
if ( statOutput ) * statOutput = stat ;
JKQTPBoxplotHorizontalElement * resB = new JKQTPBoxplotHorizontalElement ( plotter ) ;
resB - > setMin ( stat . minimum ) ;
resB - > setMax ( stat . maximum ) ;
resB - > setMedian ( stat . median ) ;
resB - > setMean ( jkqtpstatAverage ( first , last ) ) ;
resB - > setPercentile25 ( stat . quantile1 ) ;
resB - > setPercentile75 ( stat . quantile2 ) ;
resB - > setMedianConfidenceIntervalWidth ( stat . IQRSignificanceEstimate ( ) ) ;
resB - > setDrawMean ( true ) ;
resB - > setDrawNotch ( true ) ;
resB - > setDrawMedian ( true ) ;
resB - > setDrawMinMax ( true ) ;
resB - > setDrawBox ( true ) ;
resB - > setPos ( boxposY ) ;
JKQTPSingleColumnSymbolsGraph * resO = new JKQTPSingleColumnSymbolsGraph ( plotter ) ;
resO - > setDataColumn ( plotter - > getDatastore ( ) - > addCopiedColumn ( stat . outliers , outliercolumnBaseName ) ) ;
resO - > setPosition ( boxposY ) ;
resO - > setPositionScatterStyle ( JKQTPSingleColumnSymbolsGraph : : NoScatter ) ;
resO - > setDataDirection ( JKQTPSingleColumnSymbolsGraph : : DataDirection : : X ) ;
resO - > setColor ( resB - > getKeyLabelColor ( ) ) ;
resO - > setTitle ( " " ) ;
plotter - > addGraph ( resB ) ;
plotter - > addGraph ( resO ) ;
return std : : pair < JKQTPBoxplotHorizontalElement * , JKQTPSingleColumnSymbolsGraph * > ( resB , resO ) ;
}
/*! \brief add a JKQTPBoxplotVerticalElement and a JKQTPSingleColumnSymbolsGraph for outliers to the given plotter, where the boxplot values are calculated from the data range \a first ... \a last
2019-05-30 17:19:56 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 boxposX x - coordinate of the outliers ( and the boxplot )
\ param quantile1Spec specifies which quantile to calculate for \ a qantile1 ( range : 0. .1 )
\ param quantile2Spec specifies which quantile to calculate for \ a qantile2 ( range : 0. .1 )
\ param minimumQuantile specifies a quantile for the return value minimum ( default is 0.03 , i . e . the 3 % quantile ! )
\ param maximumQuantile specifies a quantile for the return value maximum ( default is 0.97 , i . e . the 97 % quantile ! )
\ param outliercolumnBaseName this string is used in building the column names for the outlier columns
\ param [ out ] statOutput optionally returns the internally calculated statistics as a JKQTPStat5NumberStatistics
\ return a boxplot element with its values initialized from the given data range
Example :
\ code
jkqtpstatAddVBoxplotAndOutliers ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ) ;
jkqtpstatAddVBoxplotAndOutliers ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , - 0.3 ,
0.25 , 0.75 , // 1. and 3. Quartile for the boxplot box
0.05 , 0.95 // Quantiles for the boxplot box whiskers' ends
2019-06-02 00:15:04 +08:00
\ endcode
2019-05-30 04:40:02 +08:00
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstat5NumberStatistics ( )
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline std : : pair < JKQTPBoxplotVerticalElement * , JKQTPSingleColumnSymbolsGraph * > jkqtpstatAddVBoxplotAndOutliers ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double boxposX , double quantile1Spec = 0.25 , double quantile2Spec = 0.75 , double minimumQuantile = 0.03 , double maximumQuantile = 0.97 , const QString & outliercolumnBaseName = QString ( " boxplot " ) , JKQTPStat5NumberStatistics * statOutput = nullptr ) {
JKQTPStat5NumberStatistics stat = jkqtpstat5NumberStatistics ( first , last , quantile1Spec , quantile2Spec , minimumQuantile , maximumQuantile ) ;
if ( statOutput ) * statOutput = stat ;
JKQTPBoxplotVerticalElement * resB = new JKQTPBoxplotVerticalElement ( plotter ) ;
resB - > setMin ( stat . minimum ) ;
resB - > setMax ( stat . maximum ) ;
resB - > setMedian ( stat . median ) ;
resB - > setMean ( jkqtpstatAverage ( first , last ) ) ;
resB - > setPercentile25 ( stat . quantile1 ) ;
resB - > setPercentile75 ( stat . quantile2 ) ;
resB - > setMedianConfidenceIntervalWidth ( stat . IQRSignificanceEstimate ( ) ) ;
resB - > setDrawMean ( true ) ;
resB - > setDrawNotch ( true ) ;
resB - > setDrawMedian ( true ) ;
resB - > setDrawMinMax ( true ) ;
resB - > setDrawBox ( true ) ;
resB - > setPos ( boxposX ) ;
JKQTPSingleColumnSymbolsGraph * resO = new JKQTPSingleColumnSymbolsGraph ( plotter ) ;
resO - > setDataColumn ( plotter - > getDatastore ( ) - > addCopiedColumn ( stat . outliers , outliercolumnBaseName ) ) ;
resO - > setPosition ( boxposX ) ;
resO - > setPositionScatterStyle ( JKQTPSingleColumnSymbolsGraph : : NoScatter ) ;
resO - > setDataDirection ( JKQTPSingleColumnSymbolsGraph : : DataDirection : : Y ) ;
resO - > setColor ( resB - > getKeyLabelColor ( ) ) ;
plotter - > addGraph ( resB ) ;
plotter - > addGraph ( resO ) ;
return std : : pair < JKQTPBoxplotVerticalElement * , JKQTPSingleColumnSymbolsGraph * > ( resB , resO ) ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 bins number of bins in the resulting histogram
\ param histogramcolumnBaseName this string is used in building the column names for the outlier columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
jkqtpstatAddHHistogram1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 11 ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_hist . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1DAutoranged ( ) , JKQTPBarVerticalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBarVerticalGraph * jkqtpstatAddHHistogram1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , int bins = 11 , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , bins , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarVerticalGraph * resO = new JKQTPBarVerticalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binWidth width of the bins
\ param histogramcolumnBaseName this string is used in building the column names for the histogram columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
jkqtpstatAddHHistogram1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 0.5 ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_hist . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1DAutoranged ( ) , JKQTPBarVerticalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBarVerticalGraph * jkqtpstatAddHHistogram1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double binWidth , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , binWidth , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarVerticalGraph * resO = new JKQTPBarVerticalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
\ tparam BinsInputIt standard iterator type of \ a binsFirst and \ a binsLast .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binsFirst iterator pointing to the first item in the set of histogram bins
\ param binsLast iterator pointing behind the last item in the set of histogram bins
\ param histogramcolumnBaseName this string is used in building the column names for the histogram columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
std : : vector < double > bins { - 2 , - 1.5 , - 1 , - 0.75 , - 0.5 , - 0.25 , 0 , 0.25 , 0.5 , 0.75 , 1 , 1.5 , 2 , 2.5 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ;
jkqtpstatAddHHistogram1D ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , bins . begin ( ) , bins . end ( ) ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_hist . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1D ( ) , JKQTPBarVerticalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt , class BinsInputIt >
inline JKQTPBarVerticalGraph * jkqtpstatAddHHistogram1D ( JKQTBasePlotter * plotter , InputIt first , InputIt last , BinsInputIt binsFirst , BinsInputIt binsLast , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1D ( first , last , binsFirst , binsLast , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarVerticalGraph * resO = new JKQTPBarVerticalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 bins number of bins in the resulting histogram
\ param histogramcolumnBaseName this string is used in building the column names for the histogram columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
jkqtpstatAddVHistogram1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 11 ) ;
\ endcode
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1DAutoranged ( ) , JKQTPBarHorizontalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBarHorizontalGraph * jkqtpstatAddVHistogram1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , int bins = 11 , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , bins , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarHorizontalGraph * resO = new JKQTPBarHorizontalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binWidth width of the bins
\ param histogramcolumnBaseName this string is used in building the column names for the histogram columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
jkqtpstatAddVHistogram1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 0.5 ) ;
\ endcode
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1DAutoranged ( ) , JKQTPBarHorizontalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPBarHorizontalGraph * jkqtpstatAddVHistogram1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double binWidth , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , binWidth , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarHorizontalGraph * resO = new JKQTPBarHorizontalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
\ tparam BinsInputIt standard iterator type of \ a binsFirst and \ a binsLast .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binsFirst iterator pointing to the first item in the set of histogram bins
\ param binsLast iterator pointing behind the last item in the set of histogram bins
\ param histogramcolumnBaseName this string is used in building the column names for the histogram columns
\ param normalized indicates whether the histogram has to be normalized
\ param cummulative if \ c true , a cummulative histogram is calculated
\ return a graph class pointer ( of type \ a GraphClass ) displaying the histogram data
Example :
\ code
std : : vector < double > bins { - 2 , - 1.5 , - 1 , - 0.75 , - 0.5 , - 0.25 , 0 , 0.25 , 0.5 , 0.75 , 1 , 1.5 , 2 , 2.5 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ;
jkqtpstatAddVHistogram1D ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , bins . begin ( ) , bins . end ( ) ) ;
\ endcode
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatHistogram1D ( ) , JKQTPBarHorizontalGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt , class BinsInputIt >
inline JKQTPBarHorizontalGraph * jkqtpstatAddVHistogram1D ( JKQTBasePlotter * plotter , InputIt first , InputIt last , BinsInputIt binsFirst , BinsInputIt binsLast , bool normalized = true , bool cummulative = false , const QString & histogramcolumnBaseName = QString ( " histogram " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( histogramcolumnBaseName + " , values " ) ;
jkqtpstatHistogram1D ( first , last , binsFirst , binsLast , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , normalized , cummulative , JKQTPStatHistogramBinXMode : : XIsMid ) ;
JKQTPBarHorizontalGraph * resO = new JKQTPBarHorizontalGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( histogramcolumnBaseName ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 Nout number of points in the resulting KDE
\ param kernel the kernel function to use ( e . g . jkqtpstatKernel1DGaussian ( ) )
\ param bandwidth bandwidth used for the KDE
\ param cummulative if \ c true , a cummulative KDE is calculated
\ param KDEcolumnBaseName this string is used in building the column names for the KDE data columns
\ return a graph class pointer ( of type \ a GraphClass ) displaying the KDE data
Example :
\ code
jkqtpstatAddHKDE1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 200 ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_kde . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatKDE1DAutoranged ( ) , JKQTPXYLineGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPXYLineGraph * jkqtpstatAddHKDE1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , int Nout = 100 , const std : : function < double ( double ) > & kernel = std : : function < double ( double ) > ( & jkqtpstatKernel1DGaussian ) , double bandwidth = 1.0 , bool cummulative = false , const QString & KDEcolumnBaseName = QString ( " KDE " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , positions " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , values " ) ;
jkqtpstatKDE1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , Nout , kernel , bandwidth , cummulative ) ;
JKQTPXYLineGraph * resO = new JKQTPXYLineGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( KDEcolumnBaseName ) ;
resO - > setDrawLine ( true ) ;
resO - > setSymbolType ( JKQTPNoSymbol ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binWidth width of the bins
\ param kernel the kernel function to use ( e . g . jkqtpstatKernel1DGaussian ( ) )
\ param bandwidth bandwidth used for the KDE
\ param cummulative if \ c true , a cummulative KDE is calculated
\ param KDEcolumnBaseName this string is used in building the column names for the KDE data columns
\ return a graph class pointer ( of type \ a GraphClass ) displaying the KDE data
Example :
\ code
jkqtpstatAddHKDE1DAutoranged ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , 0.01 ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_kde . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatKDE1DAutoranged ( ) , JKQTPXYLineGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPXYLineGraph * jkqtpstatAddHKDE1DAutoranged ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double binWidth , const std : : function < double ( double ) > & kernel = std : : function < double ( double ) > ( & jkqtpstatKernel1DGaussian ) , double bandwidth = 1.0 , bool cummulative = false , const QString & KDEcolumnBaseName = QString ( " KDE " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , values " ) ;
jkqtpstatKDE1DAutoranged ( first , last , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , binWidth , kernel , bandwidth , cummulative ) ;
JKQTPXYLineGraph * resO = new JKQTPXYLineGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( KDEcolumnBaseName ) ;
resO - > setDrawLine ( true ) ;
resO - > setSymbolType ( JKQTPNoSymbol ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
\ tparam BinsInputIt standard iterator type of \ a binsFirst and \ a binsLast .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binsFirst iterator pointing to the first item in the set of KDE bins
\ param binsLast iterator pointing behind the last item in the set of KDE bins
\ param kernel the kernel function to use ( e . g . jkqtpstatKernel1DGaussian ( ) )
\ param bandwidth bandwidth used for the KDE
\ param cummulative if \ c true , a cummulative KDE is calculated
\ param KDEcolumnBaseName this string is used in building the column names for the KDE data columns
\ return a graph class pointer ( of type \ a GraphClass ) displaying the KDE data
Example :
\ code
std : : vector < double > bins { - 2 , - 1.5 , - 1 , - 0.75 , - 0.5 , - 0.25 , 0 , 0.25 , 0.5 , 0.75 , 1 , 1.5 , 2 , 2.5 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ;
jkqtpstatAddHKDE1D ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , bins . begin ( ) , bins . end ( ) ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_kde . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatKDE1D ( ) , JKQTPXYLineGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt , class BinsInputIt >
inline JKQTPXYLineGraph * jkqtpstatAddHKDE1D ( JKQTBasePlotter * plotter , InputIt first , InputIt last , BinsInputIt binsFirst , BinsInputIt binsLast , const std : : function < double ( double ) > & kernel = std : : function < double ( double ) > ( & jkqtpstatKernel1DGaussian ) , double bandwidth = 1.0 , bool cummulative = false , const QString & KDEcolumnBaseName = QString ( " KDE " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , values " ) ;
jkqtpstatKDE1D ( first , last , binsFirst , binsLast , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , kernel , bandwidth , cummulative ) ;
JKQTPXYLineGraph * resO = new JKQTPXYLineGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( KDEcolumnBaseName ) ;
resO - > setDrawLine ( true ) ;
resO - > setSymbolType ( JKQTPNoSymbol ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
/*! \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 )
2019-05-30 17:52:48 +08:00
\ ingroup jkqtptools_math_statistics_adaptors
2019-05-30 17:19:56 +08:00
2019-05-30 04:40:02 +08:00
\ tparam InputIt standard iterator type of \ a first and \ a last .
2019-05-30 17:19:56 +08:00
\ param plotter the plotter to which to add the resulting graph
2019-05-30 04:40:02 +08:00
\ 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 binXLeft first x - position , where to evaluate the KDE
\ param binXDelta distance between two x - positions at which the KDE is evaluated
\ param binXRight last x - position , where to evaluate the KDE
\ param kernel the kernel function to use ( e . g . jkqtpstatKernel1DGaussian ( ) )
\ param bandwidth bandwidth used for the KDE
\ param cummulative if \ c true , a cummulative KDE is calculated
\ param KDEcolumnBaseName this string is used in building the column names for the KDE data columns
\ return a graph class pointer ( of type \ a GraphClass ) displaying the KDE data
Example :
\ code
std : : vector < double > bins { - 2 , - 1.5 , - 1 , - 0.75 , - 0.5 , - 0.25 , 0 , 0.25 , 0.5 , 0.75 , 1 , 1.5 , 2 , 2.5 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10 } ;
jkqtpstatAddHKDE1D ( plot1 - > getPlotter ( ) , datastore1 - > begin ( randomdatacol1 ) , datastore1 - > end ( randomdatacol1 ) , bins . begin ( ) , bins . end ( ) ) ;
\ endcode
2019-06-02 00:15:04 +08:00
\ image html jkqtplotter_simpletest_datastore_statistics_kde . png
2019-05-30 04:47:26 +08:00
\ see \ ref JKQTPlotterBasicJKQTPDatastoreStatistics , jkqtpstatKDE1D ( ) , JKQTPXYLineGraph
2019-05-30 04:40:02 +08:00
*/
template < class InputIt >
inline JKQTPXYLineGraph * jkqtpstatAddHKDE1D ( JKQTBasePlotter * plotter , InputIt first , InputIt last , double binXLeft , double binXDelta , double binXRight , const std : : function < double ( double ) > & kernel = std : : function < double ( double ) > ( & jkqtpstatKernel1DGaussian ) , double bandwidth = 1.0 , bool cummulative = false , const QString & KDEcolumnBaseName = QString ( " KDE " ) ) {
size_t histcolX = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , bins " ) ;
size_t histcolY = plotter - > getDatastore ( ) - > addColumn ( KDEcolumnBaseName + " , values " ) ;
jkqtpstatKDE1D ( first , last , binXLeft , binXDelta , binXRight , plotter - > getDatastore ( ) - > backInserter ( histcolX ) , plotter - > getDatastore ( ) - > backInserter ( histcolY ) , kernel , bandwidth , cummulative ) ;
JKQTPXYLineGraph * resO = new JKQTPXYLineGraph ( plotter ) ;
resO - > setXColumn ( histcolX ) ;
resO - > setYColumn ( histcolY ) ;
resO - > setTitle ( KDEcolumnBaseName ) ;
resO - > setDrawLine ( true ) ;
resO - > setSymbolType ( JKQTPNoSymbol ) ;
plotter - > addGraph ( resO ) ;
return resO ;
}
2019-06-02 00:15:04 +08:00
/*! \brief calculate the linear regression coefficients for a given data range \a firstX / \a firstY ... \a lastX / \a lastY where the model is \f$ f(x)=a+b\cdot x \f$
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
jkqtpstatAddLinearRegression ( plot1 - > getPlotter ( ) , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_lin . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatLinearRegression ( )
*/
template < class InputItX , class InputItY >
inline JKQTPXFunctionLineGraph * jkqtpstatAddLinearRegression ( JKQTBasePlotter * plotter , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatLinearRegression ( firstX , lastX , firstY , lastY , cA , cB , fixA , fixB ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setSpecialFunction ( JKQTPXFunctionLineGraph : : SpecialFunction : : Line ) ;
g - > setParamsV ( cA , cB ) ;
2019-06-02 20:08:04 +08:00
g - > setTitle ( QString ( " regression: $f(x) = %1%2{ \\ cdot}x, \\ chi^2=%4, R^2=%3$ " ) . arg ( jkqtp_floattolatexqstr ( cA , 2 , true , 1e-16 , 1e-2 , 1e4 , false ) ) . arg ( jkqtp_floattolatexqstr ( cB , 2 , true , 1e-16 , 1e-2 , 1e4 , true ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the linear regression coefficients for a given data data used to draw any `JKQTPXYGraph` \a datagraph where the model is \f$ f(x)=a+b\cdot x \f$
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
jkqtpstatAddLinearRegression ( graphD ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_lin . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatLinearRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddLinearRegression ( JKQTPXYGraph * datagraph , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) ;
/*! \brief calculate the (robust) iteratively reweighted least-squares (IRLS) estimate for the parameters of the model \f$ f(x)=a+b\cdot x \f$
for a given data range \ a firstX / \ a firstY . . . \ a lastX / \ a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param p regularization parameter , the optimization problem is formulated in the \ f $ L_p \ f $ norm , using this \ a p ( see image below for an example )
\ param iterations the number of iterations the IRLS algorithm performs
Example :
\ code
jkqtpstatAddRobustIRLSLinearRegression ( plot1 - > getPlotter ( ) , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linrobust . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRobustIRLSLinearRegression ( )
*/
template < class InputItX , class InputItY >
inline JKQTPXFunctionLineGraph * jkqtpstatAddRobustIRLSLinearRegression ( JKQTBasePlotter * plotter , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , double p = 1.1 , int iterations = 100 ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatRobustIRLSLinearRegression ( firstX , lastX , firstY , lastY , cA , cB , fixA , fixB , p , iterations ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setSpecialFunction ( JKQTPXFunctionLineGraph : : SpecialFunction : : Line ) ;
g - > setParamsV ( cA , cB ) ;
2019-06-02 20:08:04 +08:00
g - > setTitle ( QString ( " robust regression: $f(x) = %1%2{ \\ cdot}x, \\ chi^2=%4, R^2=%3$ " ) . arg ( jkqtp_floattolatexqstr ( cA , 2 , true , 1e-16 , 1e-2 , 1e4 , false ) ) . arg ( jkqtp_floattolatexqstr ( cB , 2 , true , 1e-16 , 1e-2 , 1e4 , true ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the (robust) iteratively reweighted least-squares (IRLS) estimate for the parameters of the model \f$ f(x)=a+b\cdot x \f$
for a given data range \ a firstX / \ a firstY . . . \ a lastX / \ a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param p regularization parameter , the optimization problem is formulated in the \ f $ L_p \ f $ norm , using this \ a p ( see image below for an example )
\ param iterations the number of iterations the IRLS algorithm performs
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
jkqtpstatAddRobustIRLSLinearRegression ( graphD ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linrobust . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRobustIRLSLinearRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddRobustIRLSLinearRegression ( JKQTPXYGraph * datagraph , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , double p = 1.1 , int iterations = 100 ) ;
/*! \brief calculate the weighted linear regression coefficients for a given for a given data range \a firstX / \a firstY / \a firstW ... \a lastX / \a lastY / \a lastW where the model is \f$ f(x)=a+b\cdot x \f$
\ ingroup jkqtptools_math_statistics_adaptors
\ tparam InputItX standard iterator type of \ a firstX and \ a lastX .
\ tparam InputItY standard iterator type of \ a firstY and \ a lastY .
\ tparam InputItW standard iterator type of \ a firstW and \ a lastW .
\ param plotter the plotter to which to add the resulting graph
\ 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param firstW iterator pointing to the first item in the weight - dataset to use \ f $ w_1 \ f $
\ param lastW iterator pointing behind the last item in the weight - dataset to use \ f $ w_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param fWeightDataToWi an optional function , which is applied to the data from \ a firstW . . . \ a lastW to convert them to weight , i . e . \ c wi = fWeightDataToWi ( * itW )
e . g . if you use data used to draw error bars , you can use jkqtp_inversePropSaveDefault ( ) . The default is jkqtp_identity ( ) , which just returns the values .
In the case of jkqtp_inversePropSaveDefault ( ) , a datapoint x , y , has a large weight , if it ' s error is small and in the case if jkqtp_identity ( ) it ' s weight
is directly proportional to the given value .
Example :
\ code
double coeffA = 0 , coeffB = 0 ;
jkqtpstatLinearWeightedRegression ( datastore1 - > begin ( colWLinX ) , datastore1 - > end ( colWLinX ) ,
datastore1 - > begin ( colWLinY ) , datastore1 - > end ( colWLinY ) ,
datastore1 - > begin ( colWLinE ) , datastore1 - > end ( colWLinE ) ,
coeffA , coeffB , false , false ,
& jkqtp_inversePropSaveDefault < double > ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linweight . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatLinearRegression ( )
*/
template < class InputItX , class InputItY , class InputItW >
inline JKQTPXFunctionLineGraph * jkqtpstatAddLinearWeightedRegression ( JKQTBasePlotter * plotter , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , InputItW firstW , InputItW lastW , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , std : : function < double ( double ) > fWeightDataToWi = & jkqtp_identity < double > ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatLinearWeightedRegression ( firstX , lastX , firstY , lastY , firstW , lastW , cA , cB , fixA , fixB , fWeightDataToWi ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setSpecialFunction ( JKQTPXFunctionLineGraph : : SpecialFunction : : Line ) ;
g - > setParamsV ( cA , cB ) ;
2019-06-02 21:38:09 +08:00
g - > setTitle ( QString ( " weighted regression: $f(x) = %1%2{ \\ cdot}x, \\ chi^2=%4, R^2=%3$ " ) . arg ( jkqtp_floattolatexqstr ( cA , 2 , true , 1e-16 , 1e-2 , 1e4 , false ) ) . arg ( jkqtp_floattolatexqstr ( cB , 2 , true , 1e-16 , 1e-2 , 1e4 , true ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatWeightedCoefficientOfDetermination ( firstX , lastX , firstY , lastY , firstW , lastW , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) , fWeightDataToWi ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatWeightedSumOfDeviations ( firstX , lastX , firstY , lastY , firstW , lastW , jkqtpStatGenerateRegressionModel ( JKQTPStatRegressionModelType : : Linear , cA , cB ) , fWeightDataToWi ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the linear weighted regression coefficients for a given data data used to draw any `JKQTPXYGraph` \a datagraph , which also implements JKQTPYGraphErrorData and where the model is \f$ f(x)=a+b\cdot x \f$
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y , error ) data triples to which to fit the regression line
The errors are used as iverse weights !
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
JKQTPXYLineErrorGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineErrorGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
graphD - > setYErrorColumn ( static_cast < int > ( colWLinE ) ) ;
jkqtpstatAddLinearWeightedRegression ( graphD ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linweight . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatLinearRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddLinearWeightedRegression ( JKQTPXYGraph * datagraph , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) ;
/*! \brief calculate the linear regression coefficients for a given data range \a firstX / \a firstY ... \a lastX / \a lastY where the model is defined by \a type
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
jkqtpstatRegression ( plot1 - > getPlotter ( ) , JKQTPStatRegressionModelType : : Exponential , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_nonlinreg . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRegression ( )
*/
template < class InputItX , class InputItY >
inline JKQTPXFunctionLineGraph * jkqtpstatAddRegression ( JKQTBasePlotter * plotter , JKQTPStatRegressionModelType type , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatRegression ( type , firstX , lastX , firstY , lastY , cA , cB , fixA , fixB ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setPlotFunctionFunctor ( jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) ;
2019-06-02 20:08:04 +08:00
g - > setTitle ( QString ( " regression: $%1, \\ chi^2=%3, R^2=%2$ " ) . arg ( jkqtpstatRegressionModel2Latex ( type , cA , cB ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the linear regression coefficients for a given data data used to draw any `JKQTPXYGraph` \a datagraph where the model is defined by \a type
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param type model to be fitted
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
jkqtpstatRegression ( graphD , JKQTPStatRegressionModelType : : Exponential ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_nonlinreg . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddRegression ( JKQTPXYGraph * datagraph , JKQTPStatRegressionModelType type , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) ;
/*! \brief calculate the (robust) iteratively reweighted least-squares (IRLS) estimate for the parameters where the model is defined by \a type
for a given data range \ a firstX / \ a firstY . . . \ a lastX / \ a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param p regularization parameter , the optimization problem is formulated in the \ f $ L_p \ f $ norm , using this \ a p ( see image below for an example )
\ param iterations the number of iterations the IRLS algorithm performs
Example :
\ code
jkqtpstatAddRobustIRLSRegression ( plot1 - > getPlotter ( ) , JKQTPStatRegressionModelType : : Exponential , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linrobust . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRobustIRLSRegression ( )
*/
template < class InputItX , class InputItY >
inline JKQTPXFunctionLineGraph * jkqtpstatAddRobustIRLSRegression ( JKQTBasePlotter * plotter , JKQTPStatRegressionModelType type , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , double p = 1.1 , int iterations = 100 ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatRobustIRLSRegression ( type , firstX , lastX , firstY , lastY , cA , cB , fixA , fixB , p , iterations ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setPlotFunctionFunctor ( jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) ;
2019-06-02 20:08:04 +08:00
g - > setTitle ( QString ( " robust regression: $%1, \\ chi^2=%3, R^2=%2$ " ) . arg ( jkqtpstatRegressionModel2Latex ( type , cA , cB ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the (robust) iteratively reweighted least-squares (IRLS) estimate for the parameters where the model is defined by \a type
for a given data range \ a firstX / \ a firstY . . . \ a lastX / \ a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param type model to be fitted
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param p regularization parameter , the optimization problem is formulated in the \ f $ L_p \ f $ norm , using this \ a p ( see image below for an example )
\ param iterations the number of iterations the IRLS algorithm performs
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
jkqtpstatAddRobustIRLSRegression ( graphD , JKQTPStatRegressionModelType : : Exponential ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linrobust . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatRobustIRLSRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddRobustIRLSRegression ( JKQTPXYGraph * datagraph , JKQTPStatRegressionModelType type , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , double p = 1.1 , int iterations = 100 ) ;
/*! \brief calculate the weighted linear regression coefficients for a given for a given data range \a firstX / \a firstY / \a firstW ... \a lastX / \a lastY / \a lastW where the model is defined by \a type
\ ingroup jkqtptools_math_statistics_adaptors
\ tparam InputItX standard iterator type of \ a firstX and \ a lastX .
\ tparam InputItY standard iterator type of \ a firstY and \ a lastY .
\ tparam InputItW standard iterator type of \ a firstW and \ a lastW .
\ 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param firstW iterator pointing to the first item in the weight - dataset to use \ f $ w_1 \ f $
\ param lastW iterator pointing behind the last item in the weight - dataset to use \ f $ w_N \ f $
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
\ param fWeightDataToWi an optional function , which is applied to the data from \ a firstW . . . \ a lastW to convert them to weight , i . e . \ c wi = fWeightDataToWi ( * itW )
e . g . if you use data used to draw error bars , you can use jkqtp_inversePropSaveDefault ( ) . The default is jkqtp_identity ( ) , which just returns the values .
In the case of jkqtp_inversePropSaveDefault ( ) , a datapoint x , y , has a large weight , if it ' s error is small and in the case if jkqtp_identity ( ) it ' s weight
is directly proportional to the given value .
Example :
\ code
double coeffA = 0 , coeffB = 0 ;
jkqtpstatAddWeightedRegression ( plotter , JKQTPStatRegressionModelType : : Exponential ,
datastore1 - > begin ( colWLinX ) , datastore1 - > end ( colWLinX ) ,
datastore1 - > begin ( colWLinY ) , datastore1 - > end ( colWLinY ) ,
datastore1 - > begin ( colWLinE ) , datastore1 - > end ( colWLinE ) ,
coeffA , coeffB , false , false ,
& jkqtp_inversePropSaveDefault < double > ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linweight . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatWeightedRegression ( )
*/
template < class InputItX , class InputItY , class InputItW >
inline JKQTPXFunctionLineGraph * jkqtpstatAddWeightedRegression ( JKQTBasePlotter * plotter , JKQTPStatRegressionModelType type , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , InputItW firstW , InputItW lastW , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false , std : : function < double ( double ) > fWeightDataToWi = & jkqtp_identity < double > ) {
double cA ;
if ( coeffA ) cA = * coeffA ;
double cB ;
if ( coeffB ) cB = * coeffB ;
JKQTPASSERT_M ( ! fixA | | ( fixA & & coeffA ! = nullptr ) , " if fixA=true, coeffA needs to be provided " ) ;
JKQTPASSERT_M ( ! fixB | | ( fixB & & coeffB ! = nullptr ) , " if fixB=true, coeffB needs to be provided " ) ;
jkqtpstatWeightedRegression ( type , firstX , lastX , firstY , lastY , firstW , lastW , cA , cB , fixA , fixB , fWeightDataToWi ) ;
JKQTPXFunctionLineGraph * g = new JKQTPXFunctionLineGraph ( plotter ) ;
g - > setPlotFunctionFunctor ( jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) ;
2019-06-02 20:08:04 +08:00
g - > setTitle ( QString ( " weighted regression: $%1, \\ chi^2=%3, R^2=%2$ " ) . arg ( jkqtpstatRegressionModel2Latex ( type , cA , cB ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtpStatGenerateRegressionModel ( type , cA , cB ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
plotter - > addGraph ( g ) ;
if ( coeffA ) * coeffA = cA ;
if ( coeffB ) * coeffB = cB ;
return g ;
}
/*! \brief calculate the linear weighted regression coefficients for a given data data used to draw any `JKQTPXYGraph` \a datagraph , which also implements JKQTPYGraphErrorData and where the model is defined by \a type
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y , error ) data triples to which to fit the regression line
The errors are used as iverse weights !
\ param type model to be fitted
\ param [ in , out ] coeffA returns the offset of the linear model
\ param [ in , out ] coeffB returns the slope of the linear model
\ param fixA if \ c true , the offset coefficient \ f $ a \ f $ is not determined by the fit , but the value provided in \ a coeffA is used \ note If \ a fixA \ c = = true , You need to provide a value for A in \ a coeffA
\ param fixB if \ c true , the slope coefficient \ f $ b \ f $ is not determined by the fit , but the value provided in \ a coeffB is used \ note If \ a fixB \ c = = true , You need to provide a value for B in \ a coeffB
Example :
\ code
JKQTPXYLineErrorGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineErrorGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
graphD - > setYErrorColumn ( static_cast < int > ( colWLinE ) ) ;
jkqtpstatAddWeightedRegression ( graphD , JKQTPStatRegressionModelType : : Exponential ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_linweight . png
\ note The line graph is added to the same plotter that is the parent of \ a datagraph !
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatWeightedRegression ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddWeightedRegression ( JKQTPXYGraph * datagraph , JKQTPStatRegressionModelType type , double * coeffA = nullptr , double * coeffB = nullptr , bool fixA = false , bool fixB = false ) ;
/*! \brief fits (in a least-squares sense) a polynomial \f$ f(x)=\sum\limits_{i=0}^Pp_ix^i \f$ of order P to a set of N data pairs \f$ (x_i,y_i) \f$ from a given data range \a firstX / \a firstY ... \a lastX / \a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param P degree of the polynomial ( P > = N ! ! ! )
\ param [ out ] firstRes Iterator ( of type \ a OutputItP ) , which receives the ( P + 1 ) - entry vector with the polynomial coefficients \ f $ p_i \ f $
Example :
\ code
std : : vector < double > pFit ;
jkqtpstatAddPolyFit ( plot1 - > getPlotter ( ) , JKQTPStatRegressionModelType : : Exponential , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) , 3 , std : : back_inserter ( pFit ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_polynom . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatPolyFit ( )
*/
template < class InputItX , class InputItY , class OutputItP >
inline JKQTPXFunctionLineGraph * jkqtpstatAddPolyFit ( JKQTBasePlotter * plotter , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , size_t P , OutputItP firstRes ) {
std : : vector < double > pFit ;
JKQTPXFunctionLineGraph * gPoly = new JKQTPXFunctionLineGraph ( plotter ) ;
jkqtpstatPolyFit ( firstX , lastX , firstY , lastY , P , std : : back_inserter ( pFit ) ) ;
2019-06-02 21:38:09 +08:00
gPoly - > setPlotFunctionFunctor ( jkqtp_generatePolynomialModel ( pFit . begin ( ) , pFit . end ( ) ) ) ;
gPoly - > setTitle ( QString ( " regression: $%1, \\ chi^2=%3, R^2=%2$ " ) . arg ( jkqtp_polynomialModel2Latex ( pFit . begin ( ) , pFit . end ( ) ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatCoefficientOfDetermination ( firstX , lastX , firstY , lastY , jkqtp_generatePolynomialModel ( pFit . begin ( ) , pFit . end ( ) ) ) , 3 ) ) . arg ( jkqtp_floattolatexqstr ( jkqtpstatSumOfDeviations ( firstX , lastX , firstY , lastY , jkqtp_generatePolynomialModel ( pFit . begin ( ) , pFit . end ( ) ) ) , 3 ) ) ) ;
2019-06-02 00:15:04 +08:00
std : : copy ( pFit . begin ( ) , pFit . end ( ) , firstRes ) ;
plotter - > addGraph ( gPoly ) ;
return gPoly ;
}
/*! \brief fits (in a least-squares sense) a polynomial \f$ f(x)=\sum\limits_{i=0}^Pp_ix^i \f$ of order P to a set of N data pairs \f$ (x_i,y_i) \f$ from a given data range \a firstX / \a firstY ... \a lastX / \a lastY
\ ingroup jkqtptools_math_statistics_adaptors
\ 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 $
\ param lastY iterator pointing behind the last item in the y - dataset to use \ f $ y_N \ f $
\ param P degree of the polynomial ( P > = N ! ! ! )
Example :
\ code
jkqtpstatAddPolyFit ( plot1 - > getPlotter ( ) , JKQTPStatRegressionModelType : : Exponential , datastore1 - > begin ( colLinX ) , datastore1 - > end ( colLinX ) , datastore1 - > begin ( colLinY ) , datastore1 - > end ( colLinY ) , 3 ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_polynom . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatPolyFit ( )
*/
template < class InputItX , class InputItY >
inline JKQTPXFunctionLineGraph * jkqtpstatAddPolyFit ( JKQTBasePlotter * plotter , InputItX firstX , InputItX lastX , InputItY firstY , InputItY lastY , size_t P ) {
std : : vector < double > pFit ;
return jkqtpstatAddPolyFit ( plotter , firstX , lastX , firstY , lastY , P , std : : back_inserter ( pFit ) ) ;
}
/*! \brief fits (in a least-squares sense) a polynomial \f$ f(x)=\sum\limits_{i=0}^Pp_ix^i \f$ of order P to a set of N data pairs \f$ (x_i,y_i) \f$ from a given JKQTPXYGraph \a datagraph
\ ingroup jkqtptools_math_statistics_adaptors
\ tparam OutputItP output iterator for the polynomial coefficients
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param P degree of the polynomial ( P > = N ! ! ! )
\ param [ out ] firstRes Iterator ( of type \ a OutputItP ) , which receives the ( P + 1 ) - entry vector with the polynomial coefficients \ f $ p_i \ f $
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
std : : vector < double > pFit ;
jkqtpstatAddPolyFit ( graphD , 3 , std : : back_inserter ( pFit ) ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_polynom . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatPolyFit ( )
*/
template < class OutputItP >
inline JKQTPXFunctionLineGraph * jkqtpstatAddPolyFit ( JKQTPXYGraph * datagraph , size_t P , OutputItP firstRes ) {
JKQTBasePlotter * plt = datagraph - > getParent ( ) ;
JKQTPDatastore * ds = plt - > getDatastore ( ) ;
return jkqtpstatAddPolyFit ( plt , ds - > begin ( datagraph - > getXColumn ( ) ) , ds - > end ( datagraph - > getXColumn ( ) ) , ds - > begin ( datagraph - > getYColumn ( ) ) , ds - > end ( datagraph - > getYColumn ( ) ) , P , firstRes ) ;
}
/*! \brief fits (in a least-squares sense) a polynomial \f$ f(x)=\sum\limits_{i=0}^Pp_ix^i \f$ of order P to a set of N data pairs \f$ (x_i,y_i) \f$ from a given JKQTPXYGraph \a datagraph
\ ingroup jkqtptools_math_statistics_adaptors
\ param datagraph graph representing the ( x , y ) datapairs to which to fit the regression line
\ param P degree of the polynomial ( P > = N ! ! ! )
Example :
\ code
JKQTPXYLineGraph * graphD ;
plot1 - > addGraph ( graphD = new JKQTPXYLineGraph ( plot1 ) ) ;
graphD - > setXYColumns ( colLinX , colLinY ) ;
jkqtpstatAddPolyFit ( graphD , 3 ) ;
\ endcode
\ image html jkqtplotter_simpletest_datastore_regression_polynom . png
\ see \ ref JKQTPlotterBasicJKQTPDatastoreRegression , jkqtpstatPolyFit ( )
*/
JKQTP_LIB_EXPORT JKQTPXFunctionLineGraph * jkqtpstatAddPolyFit ( JKQTPXYGraph * datagraph , size_t P ) ;
2019-05-30 04:40:02 +08:00
# endif // JKQTPGRAPHSSTATISTICSADAPTORS_H_INCLUDED