---

Plot::MatrixImage< PixelType, PixelMatrix > Class Template Reference

#include <matriximage.h>

Inheritance diagram for Plot::MatrixImage< PixelType, PixelMatrix >:

[legend]Collaboration diagram for Plot::MatrixImage< PixelType, PixelMatrix >:

[legend]List of all members.

---

Detailed Description

template<class PixelType = RGBPixel<>, class PixelMatrix = typename MatrixType<PixelType>::rectangular>
class Plot::MatrixImage< PixelType, PixelMatrix >

Image based on a rectangular matrix with an optional border.

Member functions take coordinates in the original matrix rather than (scaled and offset) pixel coordinates.

The border was deliberately included in this class rather than simply having an operation that takes an existing image and adds a border. The reason is that certain outlining operations supported by this class will deliberately overwrite part of the border so that they enclose the precise area included in the outline, without losing any enclosed area to the nonzero width of the outline itself.

Definition at line 37 of file matriximage.h.

Public Methods
void	draw_bar_on_matrix_element (const MatrixSubscript row, const MatrixSubscript col, double angle, double length, double width=1, PixelType p=default_fg)
	Calls AARImage<>::draw_bar for a line centered on the given matrix element.
template<class BoundingBoxType> void	outline_boundary (const BoundingBoxType &bb, unsigned thickness, PixelType p=default_fg, bool infinite_outline=false)
	Draws a line of the indicated thickness around the matrix area enclosed by the given BoundingBox.
Constructors and Destructors
	MatrixImage ()
	Empty image constructor.
template<class Matrix>	MatrixImage (const Matrix &A, double scale=1.0, int borderwidth=0, const ColorLookup< PixelType > &L=RYWColorLookup< PixelType >(), PixelType bordercolor=default_border)
	Constructor taking a single matrix, to plot one dimension.
template<class Matrix>	MatrixImage (const Matrix &H, const Matrix &S, const Matrix &V, double scale=1.0, int borderwidth=0, PixelType bordercolor=default_border)
	Constructor taking matrices for Hue, Saturation, and Value.

---

Constructor & Destructor Documentation

template<class PixelType, class PixelMatrix> template<class Matrix> Plot::MatrixImage< PixelType, PixelMatrix >::MatrixImage (  const Matrix &    A, double    scale = 1.0, int    borderwidth = 0, const ColorLookup< PixelType > &    L = RYWColorLookup<PixelType>(), PixelType    bordercolor = default_border )

Constructor taking a single matrix, to plot one dimension. L determines the mapping from a magnitude to a color Definition at line 142 of file matriximage.h. References mat::elem(), Plot::AARImage< PixelType, PixelMatrix >::ncols(), and Plot::AARImage< PixelType, PixelMatrix >::nrows().

---

Member Function Documentation

template<class PixelType, class PixelMatrix> template<class BoundingBoxType> void Plot::MatrixImage< PixelType, PixelMatrix >::outline_boundary (  const BoundingBoxType &    bb, unsigned    thickness, PixelType    p = default_fg, bool    infinite_outline = false )  [inline]

Draws a line of the indicated thickness around the matrix area enclosed by the given BoundingBox. If infinite_outline is true, all points not enclosed by the given box are drawn, not just those nearest the outline border. Definition at line 181 of file matriximage.h. References Plot::contrasting_color().

---

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

• matriximage.h

---