robowflex::IO::GNUPlotHelper Class Reference

Helper class to open a pipe to a GNUPlot instance for live visualization of data. More...

#include <gnuplot.h>

Classes
struct	BoxPlotOptions
	Box plotting options. More...
class	Instance
struct	PlottingOptions
struct	TimeSeriesOptions
	Time series plotting options. More...

Public Types
using	Point = std::pair< double, double >
using	Series = std::vector< Point >
using	Values = std::vector< double >

Public Member Functions
	GNUPlotHelper ()=default
	GNUPlotHelper (GNUPlotHelper const &)=delete
void	operator= (GNUPlotHelper const &)=delete
Plotting
void	configurePlot (const PlottingOptions &options)
	Configure a plot using common options. More...
void	timeseries (const TimeSeriesOptions &options)
	Plot timeseries data. More...
void	boxplot (const BoxPlotOptions &options)
	Plot box data. More...

Private Member Functions
std::shared_ptr< Instance >	getInstance (const std::string &name)
	Get the named GNUPlot instance. More...

Private Attributes
std::map< std::string, std::shared_ptr< Instance > >	instances_
	Map of open GNUPlot instances. More...

Detailed Description

Helper class to open a pipe to a GNUPlot instance for live visualization of data.

Definition at line 20 of file gnuplot.h.

Member Typedef Documentation

Point

using robowflex::IO::GNUPlotHelper::Point = std::pair<double, double>

Definition at line 23 of file gnuplot.h.

Series

using robowflex::IO::GNUPlotHelper::Series = std::vector<Point>

Definition at line 24 of file gnuplot.h.

Values

using robowflex::IO::GNUPlotHelper::Values = std::vector<double>

Definition at line 25 of file gnuplot.h.

Constructor & Destructor Documentation

GNUPlotHelper() [1/2]

robowflex::IO::GNUPlotHelper::GNUPlotHelper ( )

default

GNUPlotHelper() [2/2]

robowflex::IO::GNUPlotHelper::GNUPlotHelper ( GNUPlotHelper const &  )

delete

Member Function Documentation

boxplot()

void GNUPlotHelper::boxplot

(

const BoxPlotOptions &

options

)

Plot box data.

Parameters

[in]

options

Plotting options.

Definition at line 112 of file gnuplot.cpp.

{
    configurePlot(options);
    auto in = getInstance(options.instance);
 
    in->writeline("set datafile separator \",\"");
 
    in->writeline("set style data boxplot");
    in->writeline("set style fill solid 0.5 border -1");
    in->writeline("unset key");
 
    if (options.sorted)
        in->writeline("set style boxplot sorted");
 
    if (options.outliers)
        in->writeline("set style boxplot outliers pointtype 7");
    else
        in->writeline("set style boxplot nooutliers");
 
    auto n = options.values.size();
 
    in->write("set xtics (");
    auto it1 = options.values.begin();
    for (std::size_t i = 0; i < n; ++i, ++it1)
    {
        in->write(log::format("\"%1%\" %2%", it1->first, i + 1));
        if (i != n - 1)
            in->write(", ");
    }
    in->writeline(") scale 0.0");
 
    in->write("plot ");
    for (std::size_t i = 0; i < n; ++i)
    {
        in->write(log::format("'%1%' using (%2%):1",  //
                              (i == 0) ? "-" : "",    //
                              i + 1));
        if (i != n - 1)
            in->write(", ");
    }
 
    in->flush();
 
    auto it2 = options.values.begin();
    for (std::size_t i = 0; i < n; ++i, ++it2)
    {
        for (const auto &point : it2->second)
            in->writeline(log::format("%1%", point));
 
        in->writeline("e");
    }
}

configurePlot()

void GNUPlotHelper::configurePlot

(

const PlottingOptions &

options

)

Configure a plot using common options.

Definition at line 54 of file gnuplot.cpp.

{
    auto in = getInstance(options.instance);
 
    in->writeline(log::format("set term %1% noraise", options.mode));
    in->writeline(log::format("set title \"%1%\"", options.title));
 
    if (not options.x.label.empty())
        in->writeline(log::format("set xlabel \"%1%\"", options.x.label));
 
    if (std::isfinite(options.x.max))
        in->writeline(log::format("set xrange [:%1%]", options.x.max));
 
    if (std::isfinite(options.x.min))
        in->writeline(log::format("set xrange [%1%:]", options.x.min));
 
    if (not options.y.label.empty())
        in->writeline(log::format("set ylabel \"%1%\"", options.y.label));
 
    if (std::isfinite(options.y.max))
        in->writeline(log::format("set yrange [:%1%]", options.y.max));
 
    if (std::isfinite(options.y.min))
        in->writeline(log::format("set yrange [%1%:]", options.y.min));
}

getInstance()

std::shared_ptr< GNUPlotHelper::Instance > GNUPlotHelper::getInstance ( const std::string &  name )

private

Get the named GNUPlot instance.

Parameters

[in]

name

Name of instance.

Returns

The instance.

Definition at line 165 of file gnuplot.cpp.

{
    if (instances_.find(name) == instances_.end())
        instances_.emplace(name, std::make_shared<Instance>());
 
    return instances_.find(name)->second;
}

operator=()

void robowflex::IO::GNUPlotHelper::operator= ( GNUPlotHelper const &  )

delete

timeseries()

void GNUPlotHelper::timeseries

(

const TimeSeriesOptions &

options

)

Plot timeseries data.

Parameters

[in]

options

Plotting options.

Definition at line 80 of file gnuplot.cpp.

{
    configurePlot(options);
    auto in = getInstance(options.instance);
 
    in->writeline("set datafile separator \",\"");
    in->write("plot ");
 
    auto n = options.points.size();
 
    auto it1 = options.points.begin();
    for (std::size_t i = 0; i < n; ++i, ++it1)
    {
        in->write(log::format("'%1%' using 1:2 with lines lw 2 title \"%2%\"",  //
                              (i == 0) ? "-" : "",                              //
                              it1->first));
        if (i != n - 1)
            in->write(", ");
    }
 
    in->flush();
 
    auto it2 = options.points.begin();
    for (std::size_t i = 0; i < n; ++i, ++it2)
    {
        for (const auto &point : it2->second)
            in->writeline(log::format("%1%,%2%", point.first, point.second));
 
        in->writeline("e");
    }
}

Member Data Documentation

instances_

std::map<std::string, std::shared_ptr<Instance> > robowflex::IO::GNUPlotHelper::instances_

private

Map of open GNUPlot instances.

Definition at line 123 of file gnuplot.h.

---

The documentation for this class was generated from the following files:

• gnuplot.h
• gnuplot.cpp