mirror of
https://github.com/jkriege2/JKQtPlotter.git
synced 2024-12-25 10:01:38 +08:00
99 lines
6.4 KiB
Markdown
99 lines
6.4 KiB
Markdown
# JKQTPlotter - A Qt Plotting Library
|
|
This is an extensive library of function/data plotter classes for Qt (>= 5.0, tested with Qt up to 5.12).
|
|
|
|
This software is licensed under the term of the [GNU Lesser General Public License 2.1
|
|
(LGPL 2.1)](./LICENSE) or above.
|
|
|
|
[![Lates Release](https://img.shields.io/github/v/release/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/releases)
|
|
|
|
![Language](https://img.shields.io/github/languages/top/jkriege2/JKQtPlotter)
|
|
[![Qt5](https://img.shields.io/badge/Qt-5-brightgreen)](https://doc.qt.io/qt-5/)
|
|
[![Qt6](https://img.shields.io/badge/Qt-6-brightgreen)](https://doc.qt.io/qt-6/)
|
|
|
|
[![Documentation](https://img.shields.io/badge/documentation-online-blue)](http://jkriege2.github.io/JKQtPlotter/index.html)
|
|
|
|
[![Build status](https://ci.appveyor.com/api/projects/status/vq2o9pfi97isxm2a?svg=true)](https://ci.appveyor.com/project/jkriege2/jkqtplotter)
|
|
|
|
[![Commit Activity](https://img.shields.io/github/commit-activity/m/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/pulse)
|
|
[![Last Commit](https://img.shields.io/github/last-commit/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/pulse)
|
|
[![Contributors](https://img.shields.io/github/contributors/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/graphs/contributors)
|
|
|
|
[![Open Issues](https://img.shields.io/github/issues/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/issues)
|
|
[![Closed Issues](https://img.shields.io/github/issues-closed/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/issues?q=is%3Aissue+is%3Aclosed)
|
|
|
|
[![Open PRs](https://img.shields.io/github/issues-pr/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/pulls)
|
|
[![Closed PRs](https://img.shields.io/github/issues-pr-closed/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/pulls?q=is%3Apr+is%3Aclosed)
|
|
|
|
[![CodeQL](https://github.com/jkriege2/JKQtPlotter/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/jkriege2/JKQtPlotter/actions/workflows/codeql-analysis.yml)
|
|
|
|
![EXAMPLES-Page](./screenshots/examplesbanner.png)
|
|
|
|
## Main Features
|
|
- 2D Plotter widget class ([JKQTPlotter](http://jkriege2.github.io/JKQtPlotter/group__jkqtplotter.html)
|
|
- high-quality plotting
|
|
- no other dependencies than Qt >= 5.0 ([CImg](https://cimg.eu/) and [OpenCV](https://opencv.org/) are optional dependencies)
|
|
- highly customizable axes/grids (linear/log, date/time, custom ticks ...)
|
|
- [JKQTMathText:](http://jkriege2.github.io/JKQtPlotter/group__jkqtmathtext.html) integrated LaTeX parser (pure C++, no dependencies) to render mathematical equations in axis labels, ticks, ...
|
|
- extensive user-interactions pre-programmed (several zooming modes, selecting regions, custom context menus, switch graph visibility, ...)
|
|
- full print and export (PDF,PNG,...) support with preview and parametrization out-the-box
|
|
- highly customizable look and feel
|
|
- supports the Qt layout system for graphs and allows to symchronize several graphs with each other
|
|
- centralized data management in an internal datastore:
|
|
- data organized by columns, can also represent image data (ropw-major)
|
|
- allows to reuse a column in several graphs
|
|
- access via Qt's model view framework
|
|
- external or internal datasets
|
|
- complete with GUI (table view)
|
|
- export capabilities (e.g. to CSV, SYLK, ...)
|
|
- C++ standard iterator interface
|
|
- statistics library (basic statistics, boxplots, histograms, kernel density estimates, regression analysis, polynomial fitting)
|
|
- large variety of graphs that can be added to a plot, e.g.:
|
|
- scatter-plots (also parametrized color/size/symbol by a third data-column)
|
|
- line graphs, step graphs, impulses
|
|
- filled curves
|
|
- barcharts (also stacked)
|
|
- extensive support for different styles of error indicators
|
|
- integrated mathematical function parser for function plots (with intelligent rendering algorithm)
|
|
- line/scatter graphs can also be based on C/C++ functions instead of data series (C++11 support!)
|
|
- statistical plots (e.g. boxplots)
|
|
- extensive library of image plots (inclusing different color-scale modes, RGBA-plots, overlays/masks)
|
|
- contour plots
|
|
- geometric forms/annotations
|
|
- can be easily extended by deriving a new graph from JKQTPPlotElement, JKQTPPlotAnnotationElement, JKQTPGeometricPlotElement, JKQTPGraph
|
|
- optional: OpenCV, CImg interfaces
|
|
- CMake-based build system
|
|
- extensive set of [Examples/Tutorials](./examples/README.md)
|
|
- extensive doxygen-generated [Documentation](http://jkriege2.github.io/JKQtPlotter/index.html)
|
|
|
|
## [Documentation](http://jkriege2.github.io/JKQtPlotter/index.html)
|
|
A Documentation (auto-)generated with [doxygen](http://www.doxygen.nl/) from the trunk source code can be found here:
|
|
**[http://jkriege2.github.io/JKQTPlotter/index.html](http://jkriege2.github.io/JKQtPlotter/index.html)**
|
|
|
|
There are also some subpage of general intetest:
|
|
- [TODO List](http://jkriege2.github.io/JKQtPlotter/page_todo.html)
|
|
- [Release Notes & Version Overview](http://jkriege2.github.io/JKQtPlotter/page_whatsnew.html)
|
|
|
|
## [Examples](./examples/)
|
|
There is a [large set of usage examples (with explanations for each) and tutorials](./examples/) in the folder [`./examples/`](./examples).
|
|
All test-projects are Qt-projects that use qmake to build. You can load them into QtCreator easily.
|
|
|
|
## [Screenshots](./screenshots/)
|
|
The [Screenshots-page](./screenshots/) contains several screenshots, partly taken from the provided examples, but also from other software using this libarary (e.g. [QuickFit 3.0](https://github.com/jkriege2/QuickFit3))
|
|
|
|
[![EXAMPLES-Page](./screenshots/screenshotsbanner.png)](./screenshots/README.md)
|
|
|
|
## Building
|
|
|
|
[![Lates Release](https://img.shields.io/github/v/release/jkriege2/JKQtPlotter)](https://github.com/jkriege2/JKQtPlotter/releases)
|
|
|
|
JKQTPlotter contains two different build systems: A modern [CMake](https://cmake.org/)-based build and an older (and deprecated!) QMake-based build (which works out of the box with Qt 5.x and QT 6.x). Both systems are explained in detail in http://jkriege2.github.io/JKQtPlotter/page_buildinstructions.html.
|
|
|
|
|
|
With [CMake](https://cmake.org/) you can easily build JKQTPlotter and all its examples, by calling something like:
|
|
```
|
|
$ mkdir build; cd build
|
|
$ cmake .. -G "<cmake_generator>" "-DCMAKE_PREFIX_PATH=<path_to_your_qt_sources>"
|
|
$ cmake --build . --config "Debug"
|
|
```
|
|
|