Ichthyostega
806db414dd
* Lumiera source code always was copyrighted by individual contributors * there is no entity "Lumiera.org" which holds any copyrights * Lumiera source code is provided under the GPL Version 2+ == Explanations == Lumiera as a whole is distributed under Copyleft, GNU General Public License Version 2 or above. For this to become legally effective, the ''File COPYING in the root directory is sufficient.'' The licensing header in each file is not strictly necessary, yet considered good practice; attaching a licence notice increases the likeliness that this information is retained in case someone extracts individual code files. However, it is not by the presence of some text, that legally binding licensing terms become effective; rather the fact matters that a given piece of code was provably copyrighted and published under a license. Even reformatting the code, renaming some variables or deleting parts of the code will not alter this legal situation, but rather creates a derivative work, which is likewise covered by the GPL! The most relevant information in the file header is the notice regarding the time of the first individual copyright claim. By virtue of this initial copyright, the first author is entitled to choose the terms of licensing. All further modifications are permitted and covered by the License. The specific wording or format of the copyright header is not legally relevant, as long as the intention to publish under the GPL remains clear. The extended wording was based on a recommendation by the FSF. It can be shortened, because the full terms of the license are provided alongside the distribution, in the file COPYING.
106 lines
3.2 KiB
C++
106 lines
3.2 KiB
C++
/*
|
||
GNUPLOT-GEN.hpp - setup for simplified data visualisation via Gnuplot
|
||
|
||
Copyright (C)
|
||
2024, Hermann Vosseler <Ichthyostega@web.de>
|
||
|
||
**Lumiera** is free software; you can redistribute it and/or modify it
|
||
under the terms of the GNU General Public License as published by the
|
||
Free Software Foundation; either version 2 of the License, or (at your
|
||
option) any later version. See the file COPYING for further details.
|
||
|
||
*/
|
||
|
||
/** @file gnuplot-gen.hpp
|
||
** Preconfigured setup for data visualisation with Gnuplot.
|
||
** The visualisation tool [gnuplot] allows for simple data visualisation
|
||
** in various formats, integrated into a *NIX commandline work environment.
|
||
**
|
||
** The namespace lib::gnuplot_gen allows to generate diagrams relying on
|
||
** some common layout schemes, which can be customised. Data is passed in
|
||
** as CSV string; the generated Gnuplot script adapts dynamically to the
|
||
** number of data columns given, where the first column always holds
|
||
** the common x-axis values. Additional parameters can be added to
|
||
** the _data binding_ used for script generation; this binding
|
||
** is comprised of key = value settings in a `Rec<GenNode>`
|
||
** (Lumiera's »ETD« format for structural data)
|
||
**
|
||
** @todo 3/2024 this is an initial draft, shaped by the immediate need to visualise
|
||
** [measurement data](\ref vault::gear::test::SchedulerStress_test) collected
|
||
** while testing the new [Scheduler](\ref scheduler.hpp) implementation.
|
||
**
|
||
** @see GnuplotGen_test
|
||
** @see SchedulerStress_test
|
||
** @see text-template.hpp
|
||
** [gnuplot]: http://gnuplot.info/documentation.html
|
||
*/
|
||
|
||
|
||
#ifndef LIB_GNUPLOT_GEN_H
|
||
#define LIB_GNUPLOT_GEN_H
|
||
|
||
|
||
#include "lib/stat/csv.hpp"
|
||
#include "lib/format-util.hpp"
|
||
#include "lib/diff/gen-node.hpp"
|
||
|
||
#include <string>
|
||
#include <vector>
|
||
#include <tuple>
|
||
|
||
using std::string;
|
||
|
||
namespace lib {
|
||
namespace gnuplot_gen { ///< preconfigured setup for Gnuplot data visualisation
|
||
|
||
|
||
|
||
using ParamRecord = diff::Rec::Mutator;
|
||
|
||
const string KEY_CSVData = "CSVData";
|
||
const string KEY_DiagramKind = "DiagramKind";
|
||
|
||
const string KEY_Term = "Term";
|
||
const string KEY_TermSize = "TermSize";
|
||
|
||
const string KEY_Xtics = "Xtics";
|
||
const string KEY_Xrange = "Xrange";
|
||
const string KEY_Yrange = "Yrange";
|
||
const string KEY_Y2range = "Y2range";
|
||
const string KEY_Y3range = "Y3range";
|
||
const string KEY_Xlabel = "Xlabel";
|
||
const string KEY_Ylabel = "Ylabel";
|
||
const string KEY_Y2label = "Y2label";
|
||
const string KEY_Y3label = "Y3label";
|
||
|
||
const string KEY_RegrSocket = "RegrSocket";
|
||
const string KEY_RegrSlope = "RegrSlope";
|
||
|
||
|
||
|
||
/**
|
||
* Generate a Gnuplot diagram to visualise the given data points.
|
||
*/
|
||
string dataPlot (ParamRecord);
|
||
|
||
inline string
|
||
dataPlot (string csvData)
|
||
{
|
||
return dataPlot (ParamRecord().set (KEY_CSVData, csvData));
|
||
}
|
||
|
||
|
||
/**
|
||
* Generate a (X,Y)-scatter plot with regression line
|
||
*/
|
||
string scatterRegression (ParamRecord);
|
||
|
||
inline string
|
||
scatterRegression (string csvData)
|
||
{
|
||
return scatterRegression (ParamRecord().set (KEY_CSVData, csvData));
|
||
}
|
||
|
||
|
||
}} // namespace lib::gnuplot_gen
|
||
#endif /*LIB_GNUPLOT_GEN_H*/
|