#include <svkBoxPlot.h>

Inheritance diagram for svkBoxPlot:

Public Types
enum	PlotComponent { REAL = 0, IMAGINARY, MAGNITUDE }

Public Member Functions
	vtkTypeMacro (svkBoxPlot, vtkOpenGLActor)

	svkBoxPlot ()

	~svkBoxPlot ()

void	Initialize ()

void	GeneratePolyData ()

vtkTransform *	GetTransform ()

void	SetData (vtkFloatArray *plotData)

void	SetPlotAreaBounds (double *bounds)

void	SetPointRange (int startPt, int endPt)

void	SetValueRange (double minValue, double maxValue)

double *	GetBounds ()

void	SetComponent (PlotComponent component)

Static Public Member Functions
static svkBoxPlot *	New ()

Protected Attributes
double *	plotAreaBounds
	The bounds in which the plot is to be placed. More...

int	startPt
	The index of the first point in the plotData to be plotted. More...

int	endPt
	The index of the last point in the plotData to be plotted. More...

int	numPoints
	The number of points in the plotData. More...

double	minValue
	The minimum value to be plotted. More...

double	maxValue
	The maximum value to be plotted. More...

vtkFloatArray *	plotData
	The data to be plotted. More...

vtkFloatArray *	pointData
	The data point values used to make up the line. More...

vtkPoints *	polyLinePoints
	The points that make up the line. More...

Detailed Description

svkBoxPlot generates and handles an actor to be used in a plot grid.\ This actor is a poly line, and its orginal coordinate system is inherently maintained. This mean that its x range is 0-npoints and y range is the min and max magnitudes of the data array that is input. The actor is then scaled to match the geometry of the current range, and location of the voxel in the given scan. It has a method called "initialize" which will create a legitimate actor, with all values zero– to be used for testing purposes.

TODO: This class extends vtkActor, and overrides its RenderOpaqueGeometry. this allows the object to be added to collections, and renders (where it renders properly, but the actor still does not behave exactly as it should. It has an internal actor that is rendered for the RenderOpaqueGemoetry, but when you use Get/SetProperty it has to be manually passed to this internal actor. This may be the only way to do it, but it may be worth checking out to see if there is a better way.

NOTE: This class is deprecated and no longer in use.

Member Enumeration Documentation

enum PlotComponent

Enumerator
REAL
IMAGINARY
MAGNITUDE

Constructor & Destructor Documentation

svkBoxPlot ( )

Constructor. This constructor creates new vtkObjects, and sets some instant variables.

References svkBoxPlot::endPt, svkBoxPlot::maxValue, svkBoxPlot::minValue, svkBoxPlot::numPoints, svkBoxPlot::plotAreaBounds, svkBoxPlot::plotData, svkBoxPlot::pointData, svkBoxPlot::polyLinePoints, svkBoxPlot::REAL, and svkBoxPlot::startPt.

~svkBoxPlot ( )

Destructor.

References svkBoxPlot::plotAreaBounds, svkBoxPlot::plotData, svkBoxPlot::pointData, and svkBoxPlot::polyLinePoints.

Member Function Documentation

void GeneratePolyData ( )

Generates the poly data object that is used to represent the data. This method will copy the current plotData into the pointData, then call modified on the polyLine object so that it nows to sync with the new data.

TODO: Find a way to Not Copy the new data, and just change a data reference.

References svkBoxPlot::IMAGINARY, svkBoxPlot::numPoints, svkBoxPlot::plotData, svkBoxPlot::pointData, svkBoxPlot::polyLinePoints, and svkBoxPlot::REAL.

Referenced by svkBoxPlot::Initialize(), and svkBoxPlot::SetData().

double * GetBounds ( )

Returns the bounds of the actor.

vtkTransform* GetTransform ( )

void Initialize ( )

Initialize a default object. This can be used as a test, it fully generates a functional svkBoxPlot. All elements have value zero.

References svkBoxPlot::GeneratePolyData(), svkBoxPlot::numPoints, svkBoxPlot::SetData(), svkBoxPlot::SetPlotAreaBounds(), svkBoxPlot::SetPointRange(), and svkBoxPlot::SetValueRange().

static svkBoxPlot* New ( )

static

void SetComponent ( PlotComponent component )

void SetData ( vtkFloatArray * plotData )

Set the Data Array to be plotted.

Parameters

plotData a vtkFloatArray that contains the data to be plotted

References svkBoxPlot::endPt, svkBoxPlot::GeneratePolyData(), svkBoxPlot::maxValue, svkBoxPlot::minValue, svkBoxPlot::numPoints, svkBoxPlot::plotData, svkBoxPlot::pointData, svkBoxPlot::polyLinePoints, and svkBoxPlot::startPt.

Referenced by svkBoxPlot::Initialize().

void SetPlotAreaBounds ( double * plotAreaBounds )

Sets the PHYSICAL BOUNDS of the plot, NOT the range of the data. Use SetPointRange, and SetValueRange for that! Said in another way this is the space the plot will fill.

Parameters

plotAreaBounds the boundries in which you want the plot to be located [xmin, xmax, ymin, ymax, zmin, zmax]

References svkBoxPlot::plotData.

Referenced by svkBoxPlot::Initialize().