Workspace 6.21.5
Public Types | Public Member Functions | List of all members
GridPlot Class Reference

A GridPlot wraps an ND dataset for the purposes of plotting it as a grid.

#include <DataAnalysis/GridPlot/gridplot.h>

Public Types

enum  Dimension { XDimension , YDimension , XPanelDimension , YPanelDimension }
 

Public Member Functions

 GridPlot ()
 
 GridPlot (const GridPlot &other)
 
virtual ~GridPlot ()
 
bool addOverlay (ImageOverlay &overlay)
 
void clearOverlays ()
 
const ColorScalegetColorScale () const
 
const ArrayNdgetData () const
 
const NamedDimensionRangegetDimension (Dimension dim) const
 
const DataExecution::ObjectArraygetFixedDimensions () const
 
const QColor & getGridLineColor () const
 
const ImageOverlaygetOverlay (int index) const
 
const QString & getTitle () const
 
const NamedDimensionRangegetXDimension () const
 
const NamedDimensionRangegetXPanelDimension () const
 
const NamedDimensionRangegetYDimension () const
 
const NamedDimensionRangegetYPanelDimension () const
 
bool isGridLinesEnabled () const
 
bool isSmoothingEnabled () const
 
int numOverlays () const
 
GridPlotoperator= (const GridPlot &rhs)
 
bool removeOverlay (ImageOverlay &overlay)
 
void setColorScale (const ColorScale &colorScale)
 
void setData (const ArrayNd &data)
 
void setFixedDimensions (const DataExecution::ObjectArray &dimensions)
 
void setGridLineColor (const QColor &color)
 
void setGridLinesEnabled (bool b)
 
void setSmoothingEnabled (bool b)
 
void setTitle (const QString &title)
 
void setXDimension (const NamedDimensionRange &dim)
 
void setXPanelDimension (const NamedDimensionRange &dim)
 
void setYDimension (const NamedDimensionRange &dim)
 
void setYPanelDimension (const NamedDimensionRange &dim)
 

Member Enumeration Documentation

◆ Dimension

enum Dimension
Enumerator
XDimension 
YDimension 
XPanelDimension 
YPanelDimension 

Constructor & Destructor Documentation

◆ GridPlot() [1/2]

GridPlot ( )

◆ GridPlot() [2/2]

GridPlot ( const GridPlot other)

◆ ~GridPlot()

~GridPlot ( )
virtual

Member Function Documentation

◆ addOverlay()

bool addOverlay ( ImageOverlay overlay)

◆ clearOverlays()

void clearOverlays ( )

◆ getColorScale()

const ColorScale & getColorScale ( ) const

◆ getData()

const ArrayNd & getData ( ) const

◆ getDimension()

const NamedDimensionRange & getDimension ( Dimension  dim) const
Parameters
dimThe dimension to return
Returns

◆ getFixedDimensions()

const ObjectArray & getFixedDimensions ( ) const

◆ getGridLineColor()

const QColor & getGridLineColor ( ) const

◆ getOverlay()

const ImageOverlay & getOverlay ( int  index) const

◆ getTitle()

const QString & getTitle ( ) const

◆ getXDimension()

const NamedDimensionRange & getXDimension ( ) const

◆ getXPanelDimension()

const NamedDimensionRange & getXPanelDimension ( ) const

◆ getYDimension()

const NamedDimensionRange & getYDimension ( ) const

◆ getYPanelDimension()

const NamedDimensionRange & getYPanelDimension ( ) const

◆ isGridLinesEnabled()

bool isGridLinesEnabled ( ) const

◆ isSmoothingEnabled()

bool isSmoothingEnabled ( ) const

◆ numOverlays()

int numOverlays ( ) const

◆ operator=()

GridPlot & operator= ( const GridPlot rhs)
Parameters
rhs

◆ removeOverlay()

bool removeOverlay ( ImageOverlay overlay)

◆ setColorScale()

void setColorScale ( const ColorScale colorScale)

◆ setData()

void setData ( const ArrayNd data)

◆ setFixedDimensions()

void setFixedDimensions ( const DataExecution::ObjectArray dimensions)

◆ setGridLineColor()

void setGridLineColor ( const QColor &  color)

◆ setGridLinesEnabled()

void setGridLinesEnabled ( bool  b)

◆ setSmoothingEnabled()

void setSmoothingEnabled ( bool  b)

◆ setTitle()

void setTitle ( const QString &  title)

◆ setXDimension()

void setXDimension ( const NamedDimensionRange dim)

◆ setXPanelDimension()

void setXPanelDimension ( const NamedDimensionRange dim)

◆ setYDimension()

void setYDimension ( const NamedDimensionRange dim)

◆ setYPanelDimension()

void setYPanelDimension ( const NamedDimensionRange dim)