TBTK
TBTK::Plot::Plotter Class Reference

Public Member Functions

 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)
 

Constructor & Destructor Documentation

◆ Plotter()

TBTK::Plot::Plotter::Plotter ( )

Constructor.

◆ ~Plotter()

TBTK::Plot::Plotter::~Plotter ( )

Destructor.

Member Function Documentation

◆ clear()

void TBTK::Plot::Plotter::clear ( )
inline

Clear plot.

◆ getCanvas()

const cv::Mat & TBTK::Plot::Plotter::getCanvas ( )
inline

Get canvas.

◆ plot() [1/9]

void TBTK::Plot::Plotter::plot ( double  x,
double  y,
const Decoration decoration = Decoration({0, 0, 0}, Decoration::LineStyle::Point) 
)

Plot point.

◆ plot() [2/9]

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

Plot data.

◆ plot() [3/9]

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

Plot data.

◆ plot() [4/9]

void TBTK::Plot::Plotter::plot ( const Property::DOS dos,
double  sigma = 0,
unsigned int  windowSize = 51 
)

Plot density of states.

◆ plot() [5/9]

void TBTK::Plot::Plotter::plot ( const Property::EigenValues eigenValues)

Plot eigenvalues.

◆ plot() [6/9]

void TBTK::Plot::Plotter::plot ( const std::vector< std::vector< double >> &  data)

Plot 2D data.

◆ plot() [7/9]

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

Plot data.

◆ plot() [8/9]

void TBTK::Plot::Plotter::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) 
)

Plot data with color coded intensity.

◆ plot() [9/9]

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

Plot data with color coded intensity.

◆ save()

void TBTK::Plot::Plotter::save ( std::string  filename)
inline

Save canvas to file.

◆ setAutoScale()

void TBTK::Plot::Plotter::setAutoScale ( bool  autoScale)
inline

Set auto scale.

◆ setAutoScaleX()

void TBTK::Plot::Plotter::setAutoScaleX ( bool  autoScaleX)
inline

Set auto scale.

◆ setAutoScaleY()

void TBTK::Plot::Plotter::setAutoScaleY ( bool  autoScaleY)
inline

Set auto scale.

◆ setBounds()

void TBTK::Plot::Plotter::setBounds ( double  minX,
double  maxX,
double  minY,
double  maxY 
)
inline

Set bounds.

◆ setBoundsX()

void TBTK::Plot::Plotter::setBoundsX ( double  minX,
double  maxX 
)
inline

Set bounds.

◆ setBoundsY()

void TBTK::Plot::Plotter::setBoundsY ( double  minY,
double  maxY 
)
inline

Set bounds.

◆ setCanvas()

void TBTK::Plot::Plotter::setCanvas ( cv::Mat &  canvas)
inline

Set canvas.

◆ setHeight()

void TBTK::Plot::Plotter::setHeight ( unsigned int  height)
inline

Set height.

◆ setHold()

void TBTK::Plot::Plotter::setHold ( bool  hold)
inline

Set whether ot not data is plotted on top of old data.

◆ setLabelX()

void TBTK::Plot::Plotter::setLabelX ( const std::string &  labelX)
inline

Set x-label.

◆ setLabelY()

void TBTK::Plot::Plotter::setLabelY ( const std::string &  labelY)
inline

Set y-label.

◆ setPadding()

void TBTK::Plot::Plotter::setPadding ( double  paddingLeft,
double  paddingRight,
double  paddingBottom,
double  paddingTop 
)
inline

Set padding.

◆ setWidth()

void TBTK::Plot::Plotter::setWidth ( unsigned int  width)
inline

Set width.


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