gnuplot.h

Go to the documentation of this file.

#pragma once
#include <cctype>
#include "interop/model/plot/flowcell_data.h"
#include "interop/model/plot/bar_point.h"
#include "interop/model/plot/candle_stick_point.h"
#include "interop/model/plot/plot_data.h"
#include "interop/io/table/csv_format.h"

namespace illumina { namespace interop { namespace io { namespace plot
{

    class gnuplot_writer
    {
    public:
        void write_flowcell(std::ostream &out,
                            const model::plot::flowcell_data &data,
                            const std::string &output_image_path = "")
        {
            write_output_format(out, output_image_path);
            write_title(out, data);
            out << "set view map\n";
            out << "unset key\n";
            out << "unset tics\n";
            out << "unset border\n";
            out << "set datafile missing \"nan\"\n";
            out << "set cbtics border in scale 0,0 mirror norotate autojustify\n";
            out << "set cbrange [" << data.saxis().min() << ":" << data.saxis().max() << "]\n";
            out <<
            "set palette defined (0 \"#8A2BE2\", 0.143 \"blue\", 0.286 \"cyan\", 0.429 \"light-green\", 0.572 \"#32CD32\", 0.715 \"#00FF00\", 0.858 \"yellow\", 1 \"orange\")\n";
            out << "set autoscale fix\n";
            out << "set size ratio 2\n";
            out << "set yrange[:] reverse\n";
            out << "set datafile separator \",\"\n";
            out << "plot \"-\" matrix with image" << "\n";
            const size_t swath_count = data.column_count() / data.tile_count();
            for (size_t y = 0; y < data.tile_count(); ++y) // Rows
            {
                for (size_t x = 0; x < data.row_count(); ++x) // Column groups
                {
                    for (size_t s = 0; s < swath_count; ++s) // Columns
                    {
                        if(x > 0 || s > 0) out << ",";
                        out << table::handle_nan(data(x, y + s * data.tile_count()));
                    }
                    out << ",nan";
                }
                out << "\n";
            }
        }

        void write_flowcell_tile_id(std::ostream &out,
                                    const model::plot::flowcell_data &data,
                                    const std::string &output_image_path = "")
        {
            write_output_format(out, output_image_path);
            write_title(out, data);
            out << "set view map\n";
            out << "unset key\n";
            out << "set cbrange [" << data.saxis().min() << ":" << data.saxis().max() << "]\n";
            out << "plot \"-\" matrix with image" << "\n";
            const size_t swath_count = data.column_count() / data.tile_count();
            for (size_t y = 0; y < data.tile_count(); ++y)
            {
                for (size_t x = 0; x < data.row_count(); ++x)
                {
                    for (size_t s = 0; s < swath_count; ++s)
                    {
                        out << " " << data.tile_id(x, y + s * data.tile_count());
                    }
                }
                out << "\n";
            }
        }

        void write_heatmap(std::ostream &out,
                           const model::plot::heatmap_data &data,
                           const std::string &output_image_path = "")
        {
            write_output_format(out, output_image_path);
            write_title(out, data);
            write_axes(out, data.xyaxes());
            out << "set view map\n";
            out << "set palette defined (0 \"white\", 0.333 \"green\", 0.667 \"yellow\", 1 \"red\")\n";
            out << "set datafile separator \",\"\n";
            out << "plot \"-\" matrix with image" << "\n";
            for (size_t y = 0; y < data.column_count(); ++y)
            {
                out << data(0, y);
                for (size_t x = 1; x < data.row_count(); ++x)
                {
                    out << "," << table::handle_nan(data(x, y));
                }
                out << "\n";
            }
        }

        template<typename Point>
        void write_chart(std::ostream &out,
                         const model::plot::plot_data<Point> &data,
                         const std::string &output_image_path = "")
        {
            write_output_format(out, output_image_path);
            write_title(out, data);
            write_axes(out, data.xyaxes());
            write_plot_description(out, data);
            write_plot_data(out, data);
        }

    protected:
        template<typename Point>
        void write_plot_data(std::ostream &out, const model::plot::plot_data<Point> &data)
        {
            if (data.size() == 0) return;
            for (size_t series = 0; series < data.size(); ++series)
            {
                write_plot_series(out, data[series]);
                write_end_of_series(out); // Marker for the end of the series so GNUPlot knows when the next line starts
            }
        }

        template<typename Point>
        void write_plot_description(std::ostream &out, const model::plot::plot_data<Point> &data)
        {
            if (data.size() == 0) return;

            out << "set datafile separator \",\"\n";
            switch (data[0].series_type())
            {
                case model::plot::series<Point>::Bar:
                    out << "set style fill solid border -1\n";
                    out << "unset key\n";
                    break;
                case model::plot::series<Point>::Candlestick:
                    out << "set boxwidth 0.3\n";
                    break;
                default:
                    break;
            };

            out << "plot ";
            for (size_t series = 0; series < data.size(); ++series)
            {
                out << "\"-\" ";
                write_type(out, data[series]);
                write_label(out, data[series]);
                write_color(out, data[series]);
                write_additional(out, data[series]);
                if ((series + 1) < data.size()) out << ",";
            }
            out << "\n";
        }

        void write_axes(std::ostream &out, const model::plot::axes &axes)
        {
            write_axis(out, axes.y(), 'y');
            write_axis(out, axes.x(), 'x');
        }

        void write_axis(std::ostream &out, const model::plot::axis &axis, const char axis_label)
        {
            out << "set " << axis_label << "range ["
                << table::handle_nan(axis.min()) << " : " << table::handle_nan(axis.max()) << " ]\n";
            if (axis.label() != "") out << "set " << axis_label << "label \"" << axis.label() << "\"\n";
        }

        template<typename PlotData>
        void write_title(std::ostream &out, const PlotData &data)
        {
            if (data.title() != "") out << "set title \"" << data.title() << "\"\n";
        }

        void write_output_format(std::ostream &out, const std::string &output_image_path)
        {
            if (output_image_path == "") return;
            out << "set terminal png crop" << std::endl;
            out << "set output \'" << output_image_path << "\'" << std::endl;
            //out << "set style fill solid noborder" << std::endl;
        }

    protected:
        void write_plot_series(std::ostream &out, const model::plot::series<model::plot::candle_stick_point> &series)
        {
            if (series.series_type() == model::plot::series<model::plot::candle_stick_point>::Candlestick)
            {
                size_t max_num_outliers = 0;
                for (size_t i = 0; i < series.size(); ++i)
                {
                    const model::plot::candle_stick_point point = series[i];
                    const std::vector<float> outliers = point.outliers();
                    max_num_outliers = std::max(max_num_outliers, outliers.size());
                }

                for (size_t i = 0; i < series.size(); ++i)
                {
                    const model::plot::candle_stick_point point = series[i];
                    out << table::handle_nan(point.x()) << ",";
                    out << table::handle_nan(point.lower()) << ",";
                    out << table::handle_nan(point.p25()) << ",";
                    out << table::handle_nan(point.p50()) << ",";
                    out << table::handle_nan(point.p75()) << ",";
                    out << table::handle_nan(point.upper());
                    const std::vector<float> outliers = point.outliers();
                    size_t j=0;
                    for(;j<outliers.size();++j)
                        out << "," << table::handle_nan(outliers[j]);
                    for(;j<max_num_outliers;++j)
                        out << "," << table::handle_nan(std::numeric_limits<float>::quiet_NaN());
                    out << std::endl;
                }
            }
            else write_plot_line(out, series);
        }

        template<typename P>
        void write_plot_line(std::ostream &out, const model::plot::series<P> &series)
        {
            for (size_t i = 0; i < series.size(); ++i)
            {
                out << table::handle_nan(series[i].x()) << "," << table::handle_nan(series[i].y()) << std::endl;
            }
        }

        template<typename X, typename Y>
        void write_plot_series(std::ostream &out, const model::plot::series<model::plot::data_point<X, Y> > &series)
        {
            write_plot_line(out, series);
        }

        void write_plot_series(std::ostream &out, const model::plot::series<model::plot::bar_point> &series)
        {
            for (size_t i = 0; i < series.size(); ++i)
            {
                out << table::handle_nan(series[i].x()) << ","
                    << table::handle_nan(series[i].y()) << ","
                    << table::handle_nan(series[i].width()) << std::endl;
            }
        }

    protected:
        void write_end_of_series(std::ostream &out)
        {
            out << "e\n";
        }

        template<typename P>
        void write_type(std::ostream &out,
                        const model::plot::series<P> &series,
                        const char sep = ' ')
        {
            switch (series.series_type())
            {
                case model::plot::series<P>::Bar:
                    out << "using 1:2:3 with boxes" << sep;
                    break;
                case model::plot::series<P>::Candlestick:
                    out << "using 1:3:2:6:5 with candlesticks" << sep;
                    break;
                case model::plot::series<P>::Line:
                    out << "with lines" << sep;
                    break;
            }
        }

        template<typename P>
        void write_additional(std::ostream &out, const model::plot::series<P> &series, const char sep = ' ')
        {
            switch (series.series_type())
            {
                case model::plot::series<P>::Candlestick:
                    out << "whiskerbars" << sep;//, \'\' using 1:4:4:4:4 with candlesticks" << sep;
                    break;
                default:
                    break;
            }
        }

        template<typename P>
        void write_label(std::ostream &out, const model::plot::series<P> &series, const char sep = ' ')
        {
            if (series.title() == "") out << "notitle";
            else out << "title \"" << series.title() << "\"";
            out << sep;
        }

        template<typename P>
        void write_color(std::ostream &out, const model::plot::series<P> &series, const char sep = ' ')
        {
            if (series.color() == "") return;
            out << "lt rgb \"" << normalize_color(series.color()) << "\"";
            out << sep;
        }

        std::string normalize_color(const std::string &color)
        {
            std::string color_normalized;
            if(color.length() > 0 && color[0] == '#')
                return color;
            for (size_t i = 0; i < color.length(); ++i)
            {
                if (std::isupper(color[i]))
                {
                    if (i > 0) color_normalized += '-';
                    color_normalized += static_cast<char>(::tolower(color[i]));
                }
                else color_normalized += color[i];
            }
            return color_normalized;
        }
    };


}}}}