mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-25 10:01:38 +08:00
docfix
This commit is contained in:
parent
c6ac8a8cc4
commit
d59f5e6692
@ -41,6 +41,21 @@ These classes are used by JKQTPlotterBase to output the plot.
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
This group assembles graphs that show their data with symbols and optionally with connecting lines in diferent styles:
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<td>\image html symbols_and_styles_small.png
|
||||
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
|
||||
<tr>
|
||||
<td>\image html stepplots_small.png
|
||||
<td> JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_linesymbolgraphs_scatter Scatter Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
@ -51,27 +66,16 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
<tr>
|
||||
<td>\image html JKQTPXYScatterGraph_small.png
|
||||
<td> JKQTPXYScatterGraph, JKQTPXYScatterErrorGraph
|
||||
<tr>
|
||||
<td>\image html symbols_and_styles_small.png
|
||||
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
|
||||
<tr>
|
||||
<td>\image html paramscatterplot_small.png
|
||||
<td> JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph
|
||||
<tr>
|
||||
<td>\image html stepplots_small.png
|
||||
<td> JKQTPSpecialLineHorizontalGraph, JKQTPSpecialLineVerticalGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_linesymbolgraphs_simple Basic Line/Scatter Graphs
|
||||
|
||||
\defgroup jkqtplotter_linesymbolgraphs_line Line Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<td>\image html beeswarmplot_small.png
|
||||
<td> JKQTPSingleColumnSymbolsGraph
|
||||
<tr>
|
||||
<td>\image html symbols_and_styles_small.png
|
||||
<td> JKQTPXYLineGraph, JKQTPXYLineErrorGraph
|
||||
@ -81,7 +85,7 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
</table>
|
||||
|
||||
|
||||
\defgroup jkqtplotter_linesymbolgraphs_param Parametrized Line/Scatter Graphs
|
||||
\defgroup jkqtplotter_linesymbolgraphs_param Bubble Charts / Parametrized Scatter Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
@ -93,6 +97,25 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
<td> JKQTPXYParametrizedScatterGraph, JKQTPXYParametrizedErrorScatterGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_functiongraphs Function Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<td>\image html functionplot_small.png
|
||||
<td> JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph
|
||||
<tr>
|
||||
<td>\image html functionplot_small.png
|
||||
<td> JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
|
||||
<tr>
|
||||
<td>\image html evalcurve_small.png
|
||||
<td> JKQTPXYFunctionLineGraph
|
||||
</table>
|
||||
|
||||
|
||||
\defgroup jkqtplotter_filledgraphs Filled Polygon/Area Graphs
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
@ -111,34 +134,7 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
<td> JKQTPFilledVerticalRangeGraph, JKQTPFilledHorizontalRangeGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_functiongraphs Function Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<td>\image html functionplot_small.png
|
||||
<td> JKQTPXFunctionLineGraph, JKQTPYFunctionLineGraph
|
||||
<tr>
|
||||
<td>\image html evalcurve_small.png
|
||||
<td> JKQTPXYFunctionLineGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_parsedFgraphs Parsed Function Graphs
|
||||
\ingroup jkqtplotter_linesymbolgraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<td>\image html functionplot_small.png
|
||||
<td> JKQTPXParsedFunctionLineGraph, JKQTPYParsedFunctionLineGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_barssticks Barcharts, Impulse-Charts, ...
|
||||
\defgroup jkqtplotter_barcharts Barcharts
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
<table>
|
||||
@ -162,6 +158,22 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
<td> JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_sticks Impulse-Charts
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th> Screenshot
|
||||
<th> Classes
|
||||
<tr>
|
||||
<tr>
|
||||
<td>\image html JKQTPImpulsesVerticalGraph_Symbols_small.png
|
||||
<td> JKQTPImpulsesHorizontalGraph, JKQTPImpulsesVerticalGraph
|
||||
<tr>
|
||||
<td>\image html JKQTPImpulsesVerticalErrorGraph_small.png
|
||||
<td> JKQTPImpulsesHorizontalErrorGraph, JKQTPImpulsesVerticalErrorGraph
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_statgraphs Statistical Graphs (e.g. Boxplots ...)
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
@ -172,10 +184,13 @@ This group assembles graphs that show their data with symbols and optionally wit
|
||||
<tr>
|
||||
<td>\image html boxplot_small.png
|
||||
<td> JKQTPBoxplotVerticalGraph, JKQTPBoxplotHorizontalGraph
|
||||
<tr>
|
||||
<td>\image html geo_boxplot_small.png
|
||||
<td> JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement
|
||||
<tr>
|
||||
<td>\image html JKQTPViolinplotVerticalElement_small.png
|
||||
<td> JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement
|
||||
</table>
|
||||
/table>
|
||||
|
||||
\see \ref jkqtptools_math_statistics_adaptors for shortcuts to calculate statistical properties of data and then adding a plot with the results.
|
||||
|
||||
@ -244,7 +259,7 @@ Examples:
|
||||
- \ref JKQTPlotterGeometricGraphs
|
||||
.
|
||||
|
||||
\defgroup jkqtplotter_diverse Diverse Other Graphs (Ranges, ...)
|
||||
\defgroup jkqtplotter_eventgraphs Event Graphs
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
<table>
|
||||
@ -254,12 +269,6 @@ Examples:
|
||||
<tr>
|
||||
<td>\image html JKQTPPeakStreamGraphY_small.png
|
||||
<td> JKQTPPeakStreamGraph
|
||||
<tr>
|
||||
<td>\image html geo_boxplot_small.png
|
||||
<td> JKQTPBoxplotVerticalElement, JKQTPBoxplotHorizontalElement
|
||||
<tr>
|
||||
<td>\image html JKQTPViolinplotVerticalElement_small.png
|
||||
<td> JKQTPViolinplotVerticalElement, JKQTPViolinplotHorizontalElement
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_imagelots Matrix/Image Plotting
|
||||
@ -284,9 +293,6 @@ Examples:
|
||||
<tr>
|
||||
<td>\image html overlayimageenhanced_small.png
|
||||
<td> JKQTPOverlayImageEnhanced, JKQTPColumnOverlayImageEnhanced
|
||||
<tr>
|
||||
<td>\image html JKQTPColumnContourPlot_small.png
|
||||
<td> JKQTPContourPlot, JKQTPColumnContourPlot
|
||||
</table>
|
||||
|
||||
\defgroup jkqtplotter_imagelots_elements Image Graphs
|
||||
@ -330,7 +336,7 @@ Examples:
|
||||
\ingroup jkqtplotter_imagelots_tools
|
||||
|
||||
\defgroup jkqtplotter_imagelots_contour Contour Graphs (based on Image Data)
|
||||
\ingroup jkqtplotter_imagelots
|
||||
\ingroup jkqtplotter_concretegraphs
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
|
@ -33,7 +33,7 @@
|
||||
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ yoverride \f$ to \f$ y=f(x) \f$
|
||||
\ingroup jkqtplotter_barssticks
|
||||
\ingroup jkqtplotter_barcharts
|
||||
|
||||
This class plots a bargraph. This image explains the parameters:
|
||||
|
||||
@ -57,10 +57,21 @@
|
||||
|
||||
\image html JKQTPBarVerticalGraphTwoColorFilling.png
|
||||
|
||||
You can use JKQTPlotter::addHorizontalBargraph() to add a series of bargraphs, where the width and shift are determined
|
||||
automatically. The y-columns are given as a QVector<int> to this function.
|
||||
If you use JKQTPBarGraphBase::FillMode::FunctorFilling you can specify the fill style by a functor, e.g.
|
||||
\code
|
||||
graph->setFillMode(JKQTPBarGraphBase::FillMode::FunctorFilling);
|
||||
graph->setFillBrushFunctor(
|
||||
[](double key, double value) {
|
||||
return QBrush(QColor::fromHsvF(key/12.0, 1.0, 1.0));
|
||||
}
|
||||
);
|
||||
\endcode
|
||||
|
||||
\see JKQTPBarHorizontalGraph, \ref JKQTPlotterBarcharts, jkqtpstatAddHHistogram1D(), jkqtpstatAddHHistogram1DAutoranged()
|
||||
The result may look like this:
|
||||
|
||||
\image html JKQTPBarVerticalGraphFunctorFilling.png
|
||||
|
||||
\see JKQTPBarHorizontalGraph, \ref JKQTPlotterBarcharts, jkqtpstatAddHHistogram1D(), jkqtpstatAddHHistogram1DAutoranged()
|
||||
*/
|
||||
class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalGraph: public JKQTPBarGraphBase {
|
||||
Q_OBJECT
|
||||
@ -96,7 +107,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalGraph: public JKQTPBarGraphBase {
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ yoverride \f$ to \f$ y=f(x) \f$
|
||||
* and error indicator
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_barcharts
|
||||
*
|
||||
* This works much the same as JKQTPBarHorizontalGraph. Here is an example output:
|
||||
* \image html JKQTPBarVerticalErrorGraph.png
|
||||
@ -154,7 +165,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalErrorGraph: public JKQTPBarVertical
|
||||
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ xoverride \f$ to \f$ x=f(y) \f$
|
||||
\ingroup jkqtplotter_barssticks
|
||||
\ingroup jkqtplotter_barcharts
|
||||
|
||||
This works much the same as JKQTPBarHorizontalGraph. Here is an example output:
|
||||
|
||||
@ -165,6 +176,21 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalErrorGraph: public JKQTPBarVertical
|
||||
|
||||
\image html JKQTPBarHorizontalGraphTwoColorFilling.png
|
||||
|
||||
If you use JKQTPBarGraphBase::FillMode::FunctorFilling you can specify the fill style by a functor, e.g.
|
||||
\code
|
||||
graph->setFillMode(JKQTPBarGraphBase::FillMode::FunctorFilling);
|
||||
graph->setFillBrushFunctor(
|
||||
[](double key, double value) {
|
||||
return QBrush(QColor::fromHsvF(key/12.0, 1.0, 1.0));
|
||||
}
|
||||
);
|
||||
\endcode
|
||||
|
||||
The result may look like this:
|
||||
|
||||
\image html JKQTPBarHorizontalGraphFunctorFilling.png
|
||||
|
||||
|
||||
\see \ref JKQTPlotterBarcharts, jkqtpstatAddVHistogram1D(), jkqtpstatAddVHistogram1DAutoranged()
|
||||
*/
|
||||
class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalGraph: public JKQTPBarGraphBase {
|
||||
@ -208,7 +234,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalGraph: public JKQTPBarGraphBase {
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ xoverride \f$ to \f$ x=f(y) \f$
|
||||
* and error indicator
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_barcharts
|
||||
*
|
||||
* This works much the same as JKQTPBarHorizontalGraph. Here is an example output:
|
||||
* \image html JKQTPBarHorizontalErrorGraph.png
|
||||
@ -277,9 +303,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarHorizontalErrorGraph: public JKQTPBarHorizo
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ yoverride \f$ to \f$ y=f(x) \f$
|
||||
* Optionally several graphs of this type may be stacked on top of each other
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_barcharts
|
||||
*
|
||||
* Draw stacked barcharts by connecting several plots by calling \c setStackedParent(belowPlot) for each plot
|
||||
*
|
||||
* \image html JKQTPBarVerticalGraphStacked.png
|
||||
*
|
||||
* \see JKQTPBarVerticalGraph, \ref JKQTPlotterStackedBarChart
|
||||
@ -325,9 +352,10 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBarVerticalStackableGraph: public JKQTPBarVert
|
||||
|
||||
/*! \brief This implements a bar graph with bars starting at \f$ yoverride \f$ to \f$ y=f(x) \f$
|
||||
* Optionally several graphs of this type may be stacked on top of each other
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_barcharts
|
||||
*
|
||||
* Draw stacked barcharts by connecting several plots by calling \c setStackedParent(belowPlot) for each plot
|
||||
*
|
||||
* \image html JKQTPBarHorizontalGraphStacked.png
|
||||
*
|
||||
*
|
||||
|
@ -31,7 +31,7 @@
|
||||
|
||||
|
||||
/** \brief This is a base-class for all bar graphs with vertical or horizontal orientation (the orientation is implemented in dervied classes!)
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_barcharts
|
||||
*
|
||||
* This class plots a bargraph. This image explains the parameters:
|
||||
*
|
||||
@ -49,12 +49,12 @@
|
||||
*
|
||||
* \image html JKQTPBarVerticalGraph.png
|
||||
*
|
||||
* You can also set FillMode::TwoColorFilling, which uses different fill styles for bars above and below
|
||||
* You can also set JKQTPBarGraphBase::FillMode::TwoColorFilling, which uses different fill styles for bars above and below
|
||||
* the baseline of the graph:
|
||||
*
|
||||
* \image html JKQTPBarVerticalGraphTwoColorFilling.png
|
||||
*
|
||||
* If you use FillMode::FunctorFilling you can specify the fill style by a functor, e.g.
|
||||
* If you use JKQTPBarGraphBase::FillMode::FunctorFilling you can specify the fill style by a functor, e.g.
|
||||
* \code
|
||||
* graph->setFillMode(JKQTPBarGraphBase::FillMode::FunctorFilling);
|
||||
* graph->setFillBrushFunctor(
|
||||
|
@ -178,7 +178,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotHorizontalGraph: public JKQTPBoxplotGra
|
||||
/*! \brief This implements a single vertical <a href="http://en.wikipedia.org/wiki/Box_plot">(notched) boxplot</a> as a "geometric element",
|
||||
where the data is directly given to the object and not stored in a column, as in JKQTPBoxplotVerticalGraph
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
\ingroup jkqtplotter_diverse
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
|
||||
|
||||
|
||||
@ -232,7 +232,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotVerticalElement: public JKQTPBoxplotEle
|
||||
/*! \brief This implements a horizontal <a href="http://en.wikipedia.org/wiki/Box_plot">(notched) boxplot</a> where the data is directly given to the
|
||||
object and not stored in a column, as in JKQTPBoxplotVerticalGraph
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
\ingroup jkqtplotter_diverse
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
|
||||
the x position is given in pos. All other data are given in the median, min, max,
|
||||
percentile25 and percentile75.
|
||||
|
@ -181,7 +181,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPBoxplotGraphBase: public JKQTPGraph, public JK
|
||||
/** \brief Tbaseclass for a single <a href="http://en.wikipedia.org/wiki/Box_plot">(notched) boxplot</a> as a "geometric element",
|
||||
* where the data is directly given to the object and not stored in a column, as in JKQTPBoxplotGraphBase
|
||||
* \ingroup jkqtplotter_statgraphs
|
||||
* \ingroup jkqtplotter_diverse
|
||||
* \ingroup jkqtplotter_statgraphs
|
||||
*
|
||||
* The different features of a boxplot are:
|
||||
*
|
||||
|
@ -31,7 +31,7 @@
|
||||
|
||||
|
||||
/** \brief a Base class for filled curve graphs like e.g. JKQTPFilledCurveXGraph
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_filledgraphs
|
||||
*
|
||||
* \image html filledgraphs.png
|
||||
*
|
||||
|
@ -28,7 +28,7 @@
|
||||
|
||||
|
||||
/** \brief This is a base class for all impulse graphs
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_sticks
|
||||
*
|
||||
* \image html JKQTPImpulsesVerticalGraph.png
|
||||
*
|
||||
@ -76,7 +76,7 @@ protected:
|
||||
|
||||
|
||||
/** \brief This implements an impulse plot with horizontal impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_sticks
|
||||
*
|
||||
* \image html JKQTPImpulsesHorizontalGraph.png
|
||||
*
|
||||
@ -117,7 +117,7 @@ protected:
|
||||
|
||||
|
||||
/** \brief This implements an impulse plot with horizontal impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
|
||||
* \ingroup jkqtplotter_barssticks
|
||||
* \ingroup jkqtplotter_sticks
|
||||
*
|
||||
* \image html JKQTPImpulsesHorizontalErrorGraph.png
|
||||
*
|
||||
@ -169,7 +169,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesHorizontalErrorGraph: public JKQTPImpu
|
||||
|
||||
|
||||
/*! \brief This implements an impulse plot with impulses in direction of the Y axis (i.e. from y=0 to y=f(x) )
|
||||
\ingroup jkqtplotter_barssticks
|
||||
\ingroup jkqtplotter_sticks
|
||||
|
||||
\image html JKQTPImpulsesVerticalGraph.png
|
||||
\image html JKQTPImpulsesVerticalGraph_Symbols.png "generated by setting setDrawSymbols(true)"
|
||||
@ -197,7 +197,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPImpulsesVerticalGraph: public JKQTPImpulsesGra
|
||||
|
||||
|
||||
/*! \brief This implements an impulse plot with impulses in direction of the X axis (i.e. from x=0 to x=f(y) )
|
||||
\ingroup jkqtplotter_barssticks
|
||||
\ingroup jkqtplotter_sticks
|
||||
|
||||
\image html JKQTPImpulsesVerticalErrorGraph.png
|
||||
|
||||
|
@ -47,7 +47,7 @@ class JKQTPDatastore;
|
||||
|
||||
|
||||
/*! \brief This implements xy line plots. This also alows to draw symbols at the data points.
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_line
|
||||
|
||||
\image html JKQTPXYLineGraph.png
|
||||
|
||||
@ -101,7 +101,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYLineGraph: public JKQTPXYGraph, public JKQTP
|
||||
|
||||
|
||||
/*! \brief This implements xy line plots with x and y error indicators.
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_line
|
||||
|
||||
\image html JKQTPXYLineErrorGraph_JKQTPErrorBars.png "setYErrorStyle(JKQTPErrorBars)"
|
||||
\image html JKQTPXYLineErrorGraph_JKQTPErrorLines.png "setYErrorStyle(JKQTPErrorLines)"
|
||||
|
@ -104,7 +104,7 @@ protected:
|
||||
|
||||
|
||||
/*! \brief This implements line plots where the data is taken from a user supplied function \f$ y=f(x) \f$ The function is defined as a string and parsed by JKMathParser
|
||||
\ingroup jkqtplotter_parsedFgraphs
|
||||
\ingroup jkqtplotter_functiongraphs
|
||||
|
||||
Additional function parameters may be given in the vector parameters. They are accessible in the function as \c p1 , \c p2 , \c p3 , ...
|
||||
Parameters may also be given from a data column. Then first the params from the column and the the parameters from the vector are numbered.
|
||||
@ -149,7 +149,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXParsedFunctionLineGraph: public JKQTPParsedFu
|
||||
|
||||
|
||||
/*! \brief This implements line plots where the data is taken from a user supplied function \f$ x=f(y) \f$ The function is defined as a string and parsed by JKMathParser
|
||||
\ingroup jkqtplotter_parsedFgraphs
|
||||
\ingroup jkqtplotter_functiongraphs
|
||||
|
||||
Additional function parameters may be given in the vector parameters. They are accessible in the function as \c p1 , \c p2 , \c p3 , ...
|
||||
Parameters may also be given from a data column. Then first the params from the column and the the parameters from the vector are numbered.
|
||||
|
@ -38,7 +38,7 @@ class JKQTPDatastore;
|
||||
/*! \brief interprets data as a stream of x- or y-positions \f$ p_i \f$ (depending in \a yPeaks ) ans plots a line on the height
|
||||
\a baseline and upright lines from baseline to baseline+peakHeight at each position \f$ p_i \f$. This can be used to
|
||||
display a stream of photons with given arrivaltimes \f$ p_i \f$.
|
||||
\ingroup jkqtplotter_diverse
|
||||
\ingroup jkqtplotter_eventgraphs
|
||||
|
||||
\image html JKQTPPeakStreamGraphY.png "yPeaks=true"
|
||||
\image html JKQTPPeakStreamGraphX.png "yPeaks=false"
|
||||
|
@ -46,7 +46,7 @@ class JKQTPDatastore;
|
||||
|
||||
|
||||
/*! \brief This implements xy scatter plots. This also alows to draw symbols at the data points.
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_scatter
|
||||
|
||||
\image html JKQTPXYScatterGraph.png
|
||||
|
||||
@ -87,7 +87,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPXYScatterGraph: public JKQTPXYGraph, public JK
|
||||
|
||||
|
||||
/*! \brief This implements xy scatter plots with x and y error indicators.
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_scatter
|
||||
|
||||
\image html JKQTPXYScatterErrorGraph.png
|
||||
|
||||
|
@ -32,7 +32,7 @@
|
||||
|
||||
/*! \brief plots a 1-column set of data-values with symbols onto a JKQtPlotter/JKQtBasePlotter. the data from the single column
|
||||
is either interpreted as x- or y-values and the missing coordinate is taken from a fixed value position.
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_scatter
|
||||
|
||||
The first coordinate of the data is taken from dataColumn i.e.
|
||||
- the x-values if dataDirection==DataDirection::X
|
||||
|
@ -44,7 +44,7 @@ class JKQTPDatastore;
|
||||
|
||||
|
||||
/** \brief a Base class for special line graphs (steps ...) like e.g. JKQTPSpecialLineHorizontalGraph
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_line
|
||||
*
|
||||
* \image html stepplots.png
|
||||
*
|
||||
@ -88,7 +88,7 @@ protected:
|
||||
|
||||
|
||||
/** \brief This implements a step plot with values \f$ \left(x, f(x) \right) \f$
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_line
|
||||
*
|
||||
* \image html stepplots.png
|
||||
*
|
||||
@ -112,7 +112,7 @@ protected:
|
||||
|
||||
|
||||
/*! \brief This implements a step plot with values \f$ \left(f(y), y \right) \f$
|
||||
\ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
\ingroup jkqtplotter_linesymbolgraphs_line
|
||||
|
||||
\image html stepplots_vertical.png
|
||||
|
||||
|
@ -35,7 +35,7 @@
|
||||
|
||||
/** \brief This implements a single vertical <a href="https://en.wikipedia.org/wiki/Violin_plot">Violin Plot</a> as a "geometric element"
|
||||
* \ingroup jkqtplotter_statgraphs
|
||||
* \ingroup jkqtplotter_diverse
|
||||
* \ingroup jkqtplotter_statgraphs
|
||||
*
|
||||
* Represents a violin plot in one of the following styles:
|
||||
*
|
||||
@ -138,7 +138,7 @@ protected:
|
||||
|
||||
/*! \brief This implements a single vertical <a href="https://en.wikipedia.org/wiki/Violin_plot">Violin Plot</a> as a "geometric element"
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
\ingroup jkqtplotter_diverse
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
|
||||
Draws a vertical violin plot in one of the following styles:
|
||||
|
||||
@ -195,7 +195,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPViolinplotVerticalElement: public JKQTPViolinp
|
||||
|
||||
/*! \brief This implements a single horizontal <a href="https://en.wikipedia.org/wiki/Violin_plot">Violin Plot</a> as a "geometric element"
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
\ingroup jkqtplotter_diverse
|
||||
\ingroup jkqtplotter_statgraphs
|
||||
|
||||
Draws a horizontal violin plot in one of the following styles:
|
||||
|
||||
|
@ -291,7 +291,7 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPaintDeviceAdapter {
|
||||
* \see See \ref JKQTPlotterMultiPlotLayout for an extensive example of the functionality.
|
||||
*
|
||||
*
|
||||
* \subsection JKQTBASEPLOTTER_SYNCMULTIPLOT_GRIDPRINT Grid Printing/Desclaring Relations between Plots
|
||||
* \subsection JKQTBASEPLOTTER_SYNCMULTIPLOT_GRIDPRINT Grid Printing/Declaring Relations between Plots
|
||||
*
|
||||
* Usually each JKQTPlotter/JKQTBasePlotter prints or exports only itself. But in many cases you might want to
|
||||
* add several plots that form a grid layout and also want to export them as one image/print them on one page.
|
||||
@ -334,9 +334,9 @@ class JKQTPLOTTER_LIB_EXPORT JKQTPPaintDeviceAdapter {
|
||||
* Most commonly this invisible plotter class is used as basis for the widget JKQTPlotter.
|
||||
* \see JKQTPlotter
|
||||
*
|
||||
* \subsection jkqtplotter_usage_baseplotter_standalone JKQTBasePlotter Standalone Usage
|
||||
* \subsection jkqtplotter_usage_baseplotter_standalone JKQTBasePlotter Standalone Usage (non-visible class)
|
||||
*
|
||||
* \copydetails jkqtplotter_general_usage_jkqtplotter
|
||||
* \copydetails jkqtplotter_general_usage_jkqtbaseplotter
|
||||
*
|
||||
*/
|
||||
class JKQTPLOTTER_LIB_EXPORT JKQTBasePlotter: public QObject {
|
||||
|
@ -73,7 +73,7 @@ JKQTPLOTTER_LIB_EXPORT void initJKQTPlotterResources();
|
||||
*
|
||||
* \section JKQTPLOTTER_BASICUSAGE Basic Usage of JKQTPlotter
|
||||
*
|
||||
* \copydetails jkqtplotter_general_usage_jkqtbaseplotter
|
||||
* \copydetails jkqtplotter_general_usage_jkqtplotter
|
||||
*
|
||||
*
|
||||
* \section JKQTPLOTTER_SYNCMULTIPLOT Synchronizing Several Plots
|
||||
|
@ -654,7 +654,7 @@ JKQTPLOTTER_LIB_EXPORT JKQTPErrorPlotstyle String2JKQTPErrorPlotstyle(const QStr
|
||||
|
||||
|
||||
/** \brief plot styles for the error information
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_line
|
||||
*
|
||||
* \see JKQTPSpecialLineTypeComboBox
|
||||
*/
|
||||
@ -668,12 +668,12 @@ enum JKQTPSpecialLineType {
|
||||
|
||||
|
||||
/** \brief converts a JKQTPSpecialLineType variable into a human-readable string
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_line
|
||||
*/
|
||||
JKQTPLOTTER_LIB_EXPORT QString JKQTPSpecialLineType2String(JKQTPSpecialLineType pos);
|
||||
|
||||
/** \brief converts a String into a JKQTPSpecialLineType
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_simple
|
||||
* \ingroup jkqtplotter_linesymbolgraphs_line
|
||||
*/
|
||||
JKQTPLOTTER_LIB_EXPORT JKQTPSpecialLineType String2JKQTPSpecialLineType(const QString& pos);
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user