Plotter.h

/* Copyright 2017 Kristofer Björnson
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */


#ifndef COM_DAFER45_TBTK_PLOT_PLOTTER
#define COM_DAFER45_TBTK_PLOT_PLOTTER

#include "TBTK/Array.h"
#include "TBTK/Plot/PlotCanvas.h"
#include "TBTK/Plot/Decoration.h"
#include "TBTK/Plot/Path.h"
#include "TBTK/Plot/Point.h"
#include "TBTK/Property/DOS.h"
#include "TBTK/Property/EigenValues.h"
#include "TBTK/Streams.h"
#include "TBTK/TBTKMacros.h"

#include <string>
#include <tuple>
#include <vector>

#include <opencv2/core/core.hpp>
#include <opencv2/highgui/highgui.hpp>

namespace TBTK{
namespace Plot{

class Plotter{
public:
    Plotter();

    ~Plotter();

    void setWidth(unsigned int width);

    void setHeight(unsigned int height);

    void setPadding(
        double paddingLeft,
        double paddingRight,
        double paddingBottom,
        double paddingTop
    );

    void setBoundsX(double minX, double maxX);

    void setBoundsY(double minY, double maxY);

    void setBounds(double minX, double maxX, double minY, double maxY);

    void setAutoScaleX(bool autoScaleX);

    void setAutoScaleY(bool autoScaleY);

    void setAutoScale(bool autoScale);

    void setLabelX(const std::string &labelX);

    void setLabelY(const std::string &labelY);

    void setCanvas(cv::Mat &canvas);

    const cv::Mat& getCanvas();

    void plot(
        double x,
        double y,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Point
        )
    );

    void plot(
        const std::vector<double> &axis,
        const std::vector<double> &data,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Line
        )
    );

    void plot(
        const std::vector<double> &data,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Line
        )
    );

    void plot(
        const Property::DOS &dos,
        double sigma = 0,
        unsigned int windowSize = 51
    );

    void plot(const Property::EigenValues &eigenValues);

    void plot(
        const std::vector<std::vector<double>> &data
    );

    void plot(
        const Array<double> &data,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Line
        )
    );

    void plot(
        const std::vector<std::vector<double>> &data,
        const std::vector<std::vector<double>> &intensity,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Point
        )
    );

    void plot(
        const Array<double> &data,
        const Array<double> &intensity,
        const Decoration &decoration = Decoration(
            {0, 0, 0}, Decoration::LineStyle::Point
        )
    );

    void setHold(bool hold);

    void clear();

    void save(std::string filename);
private:
    PlotCanvas canvas;

    bool autoScaleX, autoScaleY;

    bool hold;

    std::vector<Drawable*> dataStorage;

    void drawDataStorage();

    void clearDataStorage();
};

inline void Plotter::setWidth(unsigned int width){
    canvas.setWidth(width);
}

inline void Plotter::setHeight(unsigned int height){
    canvas.setHeight(height);
}

inline void Plotter::setPadding(
    double paddingLeft,
    double paddingRight,
    double paddingBottom,
    double paddingTop
){
    canvas.setPadding(
        paddingLeft,
        paddingRight,
        paddingBottom,
        paddingTop
    );
}

inline void Plotter::setBoundsX(
    double minX,
    double maxX
){
    TBTKAssert(
        minX < maxX,
        "Plotter::setBoundsX()",
        "minX has to be smaller than maxX",
        ""
    );
    this->autoScaleX = false;
    canvas.setBoundsX(minX, maxX);
}

inline void Plotter::setBoundsY(
    double minY,
    double maxY
){
    TBTKAssert(
        minY < maxY,
        "Plotter::setBoundsY()",
        "minY has to be smaller than maxY",
        ""
    );
    this->autoScaleY = false;
    canvas.setBoundsY(minY, maxY);
}

inline void Plotter::setBounds(
    double minX,
    double maxX,
    double minY,
    double maxY
){
    setBoundsX(minX, maxX);
    setBoundsY(minY, maxY);
}

inline void Plotter::setAutoScaleX(bool autoScaleX){
    this->autoScaleX = autoScaleX;
}

inline void Plotter::setAutoScaleY(bool autoScaleY){
    this->autoScaleY = autoScaleY;
}

inline void Plotter::setAutoScale(bool autoScale){
    setAutoScaleX(autoScale);
    setAutoScaleY(autoScale);
}

inline void Plotter::setLabelX(const std::string &labelX){
    canvas.setLabelX(labelX);
}

inline void Plotter::setLabelY(const std::string &labelY){
    canvas.setLabelY(labelY);
}

inline void Plotter::setCanvas(cv::Mat &canvas){
    this->canvas.setCanvas(canvas);
}

inline const cv::Mat& Plotter::getCanvas(){
    if(dataStorage.size() != 0){
        drawDataStorage();
        canvas.drawAxes();
    }

    return canvas.getCanvas();
}

inline void Plotter::setHold(bool hold){
    this->hold = hold;
}

inline void Plotter::clear(){
    clearDataStorage();
    canvas.clear();
}

inline void Plotter::save(std::string filename){
    if(dataStorage.size() != 0){
        drawDataStorage();
        canvas.drawAxes();
    }

    canvas.save(filename);
}

inline void Plotter::clearDataStorage(){
    for(unsigned int n = 0; n < dataStorage.size(); n++)
        delete dataStorage[n];
    dataStorage.clear();
}

};  //End namespace Plot
};  //End namespace TBTK

#endif