Plot.hpp

// sciplot - a modern C++ scientific plotting library powered by gnuplot
// https://github.com/sciplot/sciplot
//
// Licensed under the MIT License <http://opensource.org/licenses/MIT>.
//
// Copyright (c) 2018-2022 Allan Leal, Bim Overbohm
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
// C++ includes
#include <sstream>
#include <vector>
 
// sciplot includes
#include <sciplot/Constants.hpp>
#include <sciplot/Default.hpp>
#include <sciplot/Enums.hpp>
#include <sciplot/Palettes.hpp>
#include <sciplot/StringOrDouble.hpp>
#include <sciplot/Utils.hpp>
#include <sciplot/specs/AxisLabelSpecs.hpp>
#include <sciplot/specs/BorderSpecs.hpp>
#include <sciplot/specs/DrawSpecs.hpp>
#include <sciplot/specs/FillStyleSpecs.hpp>
#include <sciplot/specs/FontSpecsOf.hpp>
#include <sciplot/specs/GridSpecs.hpp>
#include <sciplot/specs/HistogramStyleSpecs.hpp>
#include <sciplot/specs/LegendSpecs.hpp>
#include <sciplot/specs/LineSpecsOf.hpp>
#include <sciplot/specs/TicsSpecs.hpp>
#include <sciplot/specs/TicsSpecsMajor.hpp>
#include <sciplot/specs/TicsSpecsMinor.hpp>
 
namespace sciplot
{
 
class Plot
{
  public:
    Plot();
 
    virtual ~Plot() = default;
 
    auto palette(const std::string& name) -> Plot&;
 
    auto size(std::size_t width, std::size_t height) -> Plot&;
 
    auto fontName(const std::string& name) -> Plot&;
 
    auto fontSize(std::size_t size) -> Plot&;
 
    auto border() -> BorderSpecs& { return m_border; }
 
    auto grid() -> GridSpecs& { return m_grid; }
 
    auto xlabel(const std::string& label) -> AxisLabelSpecs&;
 
    auto ylabel(const std::string& label) -> AxisLabelSpecs&;
 
    auto xrange(const StringOrDouble& min, const StringOrDouble& max) -> Plot&;
 
    auto yrange(const StringOrDouble& min, const StringOrDouble& max) -> Plot&;
 
    auto boxWidthAbsolute(double val) -> Plot&;
 
    auto boxWidthRelative(double val) -> Plot&;
 
    //======================================================================
    // METHODS FOR CUSTOMIZATION OF TICS
    //======================================================================
 
    auto tics() -> TicsSpecs& { return m_tics; }
 
    auto xtics() -> TicsSpecsMajor& { return xticsMajorBottom(); }
 
    auto ytics() -> TicsSpecsMajor& { return yticsMajorLeft(); }
 
    auto ztics() -> TicsSpecsMajor& { return zticsMajor(); }
 
    auto rtics() -> TicsSpecsMajor& { return rticsMajor(); }
 
    auto xticsMajorBottom() -> TicsSpecsMajor& { return m_xtics_major_bottom; }
 
    auto xticsMajorTop() -> TicsSpecsMajor& { return m_xtics_major_top; }
 
    auto xticsMinorBottom() -> TicsSpecsMinor& { return m_xtics_minor_bottom; }
 
    auto xticsMinorTop() -> TicsSpecsMinor& { return m_xtics_minor_top; }
 
    auto yticsMajorLeft() -> TicsSpecsMajor& { return m_ytics_major_left; }
 
    auto yticsMajorRight() -> TicsSpecsMajor& { return m_ytics_major_right; }
 
    auto yticsMinorLeft() -> TicsSpecsMinor& { return m_ytics_minor_left; }
 
    auto yticsMinorRight() -> TicsSpecsMinor& { return m_ytics_minor_right; }
 
    auto zticsMajor() -> TicsSpecsMajor& { return m_ztics_major; }
 
    auto zticsMinor() -> TicsSpecsMinor& { return m_ztics_minor; }
 
    auto rticsMajor() -> TicsSpecsMajor& { return m_rtics_major; }
 
    auto rticsMinor() -> TicsSpecsMinor& { return m_rtics_minor; }
 
    //======================================================================
    // METHODS FOR CUSTOMIZATION OF STYLES
    //======================================================================
 
    auto styleFill() -> FillStyleSpecs& { return m_style_fill; }
 
    auto styleHistogram() -> HistogramStyleSpecs& { return m_style_histogram; }
 
    //======================================================================
    // METHODS FOR DRAWING PLOT ELEMENTS
    //======================================================================
 
    auto draw(const std::string& what, const std::string& use, const std::string& with) -> DrawSpecs&;
 
    //======================================================================
    // MISCElLANEOUS METHODS
    //======================================================================
 
    auto legend() -> LegendSpecs&;
 
    auto samples(std::size_t value) -> void;
 
    auto gnuplot(const std::string& command) -> void;
 
    auto savePlotData() const -> void;
 
    auto autoclean(bool enable = true) -> void;
 
    auto cleanup() const -> void;
 
    auto clear() -> void;
 
    virtual auto repr() const -> std::string = 0;
 
  protected:
    static std::size_t m_counter; 
    std::size_t m_id = 0; 
    bool m_autoclean = true; 
    std::string m_palette; 
    std::size_t m_width = 0; 
    std::size_t m_height = 0; 
    std::string m_datafilename; 
    std::string m_data; 
    std::size_t m_numdatasets = 0; 
    FontSpecs m_font; 
    BorderSpecs m_border; 
    GridSpecs m_grid; 
    std::string m_xrange; 
    std::string m_yrange; 
    HistogramStyleSpecs m_style_histogram; 
    TicsSpecs m_tics; 
    TicsSpecsMajor m_xtics_major_bottom; 
    TicsSpecsMajor m_xtics_major_top; 
    TicsSpecsMinor m_xtics_minor_bottom; 
    TicsSpecsMinor m_xtics_minor_top; 
    TicsSpecsMajor m_ytics_major_left; 
    TicsSpecsMajor m_ytics_major_right; 
    TicsSpecsMinor m_ytics_minor_left; 
    TicsSpecsMinor m_ytics_minor_right; 
    TicsSpecsMajor m_ztics_major; 
    TicsSpecsMinor m_ztics_minor; 
    TicsSpecsMajor m_rtics_major; 
    TicsSpecsMinor m_rtics_minor; 
    AxisLabelSpecs m_xlabel; 
    AxisLabelSpecs m_ylabel; 
    AxisLabelSpecs m_rlabel; 
    std::string m_boxwidth; 
    FillStyleSpecs m_style_fill; 
    std::string m_samples; 
    LegendSpecs m_legend; 
    std::vector<DrawSpecs> m_drawspecs; 
    std::vector<std::string> m_customcmds; 
};
 
// Initialize the counter of plot objects
inline std::size_t Plot::m_counter = 0;
 
inline Plot::Plot()
    : m_id(m_counter++), m_datafilename("plot" + internal::str(m_id) + ".dat"), m_xlabel("x"), m_ylabel("y"), m_rlabel("r"), m_xtics_major_bottom("x"), m_xtics_major_top("x2"), m_xtics_minor_bottom("x"), m_xtics_minor_top("x2"), m_ytics_major_left("y"), m_ytics_major_right("y2"), m_ytics_minor_left("y"), m_ytics_minor_right("y2"), m_ztics_major("z"), m_ztics_minor("z"), m_rtics_major("r"), m_rtics_minor("r")
{
    // Show only major and minor xtics and ytics
    xticsMajorBottom().show();
    xticsMinorBottom().show();
    yticsMajorLeft().show();
    yticsMinorLeft().show();
    // Hide all other tics
    xticsMajorTop().hide();
    xticsMinorTop().hide();
    yticsMajorRight().hide();
    yticsMinorRight().hide();
    zticsMajor().hide();
    zticsMinor().hide();
    rticsMajor().hide();
    rticsMinor().hide();
    // Default options for fill style
    styleFill().solid();
    styleFill().borderHide();
    // Set all other default options
    boxWidthRelative(internal::DEFAULT_FIGURE_BOXWIDTH_RELATIVE);
    // This is needed because of how drawHistogram works. Using `with histograms` don't work as well.
    gnuplot("set style data histogram");
}
 
inline auto Plot::palette(const std::string& name) -> Plot&
{
    m_palette = name;
    return *this;
}
 
inline auto Plot::size(std::size_t width, std::size_t height) -> Plot&
{
    m_width = width;
    m_height = height;
    return *this;
}
 
inline auto Plot::fontName(const std::string& name) -> Plot&
{
    m_font.fontName(name);
    m_legend.fontName(name);
    return *this;
}
 
inline auto Plot::fontSize(std::size_t size) -> Plot&
{
    m_font.fontSize(size);
    m_legend.fontSize(size);
    return *this;
}
 
inline auto Plot::xlabel(const std::string& label) -> AxisLabelSpecs&
{
    m_xlabel.text(label);
    return m_xlabel;
}
 
inline auto Plot::ylabel(const std::string& label) -> AxisLabelSpecs&
{
    m_ylabel.text(label);
    return m_ylabel;
}
 
inline auto Plot::xrange(const StringOrDouble& min, const StringOrDouble& max) -> Plot&
{
    m_xrange = "[" + min.value + ":" + max.value + "]";
    return *this;
}
 
inline auto Plot::yrange(const StringOrDouble& min, const StringOrDouble& max) -> Plot&
{
    m_yrange = "[" + min.value + ":" + max.value + "]";
    return *this;
}
 
inline auto Plot::boxWidthAbsolute(double val) -> Plot&
{
    m_boxwidth = internal::str(val) + " absolute";
    return *this;
}
 
inline auto Plot::boxWidthRelative(double val) -> Plot&
{
    m_boxwidth = internal::str(val) + " relative";
    return *this;
}
 
//======================================================================
// METHODS FOR DRAWING PLOT ELEMENTS
//======================================================================
 
inline auto Plot::draw(const std::string& what, const std::string& use, const std::string& with) -> DrawSpecs&
{
    // Save the draw arguments for this x,y data
    m_drawspecs.emplace_back(what, use, with);
    // Return the just created drawing object in case the user wants to customize it
    return m_drawspecs.back();
}
 
//======================================================================
// MISCELLANEOUS METHODS
//======================================================================
 
inline auto Plot::legend() -> LegendSpecs&
{
    return m_legend;
}
 
inline auto Plot::samples(std::size_t value) -> void
{
    m_samples = internal::str(value);
}
 
inline auto Plot::gnuplot(const std::string& command) -> void
{
    m_customcmds.push_back(command);
}
 
inline auto Plot::savePlotData() const -> void
{
    // Open data file, truncate it and write all current plot data to it
    if (!m_data.empty())
    {
        std::ofstream data(m_datafilename);
        data << m_data;
    }
}
 
inline auto Plot::autoclean(bool enable) -> void
{
    m_autoclean = enable;
}
 
inline auto Plot::cleanup() const -> void
{
    std::remove(m_datafilename.c_str());
}
 
inline auto Plot::clear() -> void
{
    m_drawspecs.clear();
    m_customcmds.clear();
}
 
} // namespace sciplot