---

Plot::MatrixImageFactory< BaseMatrixType, T, ScaleT, Rectangle, PixelType, PixelMatrix > Class Template Reference

#include <matriximagefactory.h>

Collaboration diagram for Plot::MatrixImageFactory< BaseMatrixType, T, ScaleT, Rectangle, PixelType, PixelMatrix >:

[legend]List of all members.

---

Detailed Description

template<class BaseMatrixType = mat::MatrixInterface<double>, class T = typename BaseMatrixType::value_type, class ScaleT = Scale::Linear<T>, class Rectangle = Boundary::AAArbitraryRectangle<double,int>, class PixelType = RGBPixel<>, class PixelMatrix = typename MatrixType<PixelType>::rectangular>
class Plot::MatrixImageFactory< BaseMatrixType, T, ScaleT, Rectangle, PixelType, PixelMatrix >

Generalization of the MatrixImage<> constructors that allows up to three matrices to be combined into an overlaid plot.

A single strength dimension can have its colors specified by a ColorLookup<> object.

Multiple dimensions are combined into the different dimensions of an HSV colormap in a way that provides a natural representation of a strength, a color plot visible mainly where the strength plot is active, and a confidence on the color plot that constrains how much of the color plot is visible.

To make the implementation tractable, matrix argument types are required to be derived from the mat::MatrixInterface<> specified in BaseMatrixType, rather than using a function template parameter for all Matrix arguments as would ordinarily be done. This was required because of the temporary matrices of different types that must be allocated; combining matrices of arbitrarily different types in the same function calls can be problematic. Although this limitation is a pain, generality is not reduced by it, since any matrix type can be wrapped in a MatrixInterfaceAdapter object so that it will support the MatrixInterface.

Definition at line 57 of file matriximagefactory.h.

Public Methods
	MatrixImageFactory (bool paper_based_colors=false, double size_scale_i=1.0, int border_i=1, Rectangle plot_subregion=Rectangle(), const ColorLookup< PixelType > *strength_colorlookup=0, PixelType bordercolor_=PixelType())
	Constructor.
MatrixImage< PixelType, PixelMatrix > *	operator() (const BaseMatrixType *const strength=0, ScaleT strengthscale=ScaleT(), const BaseMatrixType *const color=0, ScaleT colorscale=ScaleT(), const BaseMatrixType *const confidence=0, ScaleT confidencescale=ScaleT()) const
	Returns an image with a strength dimension and/or a color dimension, plus an optional confidence on the color dimension.

---

Constructor & Destructor Documentation

template<class BaseMatrixType = mat::MatrixInterface<double>, class T = typename BaseMatrixType::value_type, class ScaleT = Scale::Linear<T>, class Rectangle = Boundary::AAArbitraryRectangle<double,int>, class PixelType = RGBPixel<>, class PixelMatrix = typename MatrixType<PixelType>::rectangular> Plot::MatrixImageFactory< BaseMatrixType, T, ScaleT, Rectangle, PixelType, PixelMatrix >::MatrixImageFactory (  bool    paper_based_colors = false, double    size_scale_i = 1.0, int    border_i = 1, Rectangle    plot_subregion = Rectangle(), const ColorLookup< PixelType > *    strength_colorlookup = 0, PixelType    bordercolor_ = PixelType() )  [inline]

Constructor. The bordercolor default is handled in a complicated way to avoid odd compiler errors from GCC (all tested version up to 2.95) when MatrixImage's default_border is supplied directly as the default argument value. Definition at line 72 of file matriximagefactory.h.

---

Member Function Documentation

template<class BaseMatrixType = mat::MatrixInterface<double>, class T = typename BaseMatrixType::value_type, class ScaleT = Scale::Linear<T>, class Rectangle = Boundary::AAArbitraryRectangle<double,int>, class PixelType = RGBPixel<>, class PixelMatrix = typename MatrixType<PixelType>::rectangular> MatrixImage<PixelType,PixelMatrix>* Plot::MatrixImageFactory< BaseMatrixType, T, ScaleT, Rectangle, PixelType, PixelMatrix >::operator() (  const BaseMatrixType *const    strength = 0, ScaleT    strengthscale = ScaleT(), const BaseMatrixType *const    color = 0, ScaleT    colorscale = ScaleT(), const BaseMatrixType *const    confidence = 0, ScaleT    confidencescale = ScaleT() )  const [inline]

Returns an image with a strength dimension and/or a color dimension, plus an optional confidence on the color dimension. Returns zero if an image could not be constructed, e.g. if the new operator fails. Definition at line 87 of file matriximagefactory.h. References Plot::AARImage< PixelType, PixelMatrix >::ncols(), and Plot::AARImage< PixelType, PixelMatrix >::nrows().

---

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

• matriximagefactory.h

---