SIVIC API: svkDetailedPlotDirector Class Reference

#include <svkDetailedPlotDirector.h>

Inheritance diagram for svkDetailedPlotDirector:

Public Member Functions
	vtkTypeMacro (svkDetailedPlotDirector, vtkObject)

virtual void	AddInput (vtkDataArray array, int component, vtkDataObject sourceToObserve)

virtual void	RemoveAllInputs ()

virtual void	RemoveInput (vtkDataArray *array)

virtual void	SetPlotColor (int plotIndex, double *rgb)

virtual void	SetBackgroundColor (double *rgb)

virtual void	SetBackgroundOpacity (double opacity)

virtual void	SetBackgroundVisibility (bool visible)

virtual void	SetAnnotationTextVisibility (bool visible)

virtual void	SetLineWidth (float width)

virtual void	SetAnnotationText (string text)

virtual void	SetIndexRange (int lower, int upper)

virtual void	GenerateAbscissa (double firstPointValue, double lastPointValue)

virtual void	GenerateAbscissa (svkDcmHeader *header, svkSpecPoint::UnitType type)

virtual void	SetYRange (double lower, double upper)

virtual svkXYPlotActor *	GetPlotActor ()

virtual vtkAxisActor2D *	GetRuler ()

virtual void	AddOnMouseMoveObserver (vtkRenderWindowInteractor *rwi)

virtual void	RemoveOnMouseMoveObserver (vtkRenderWindowInteractor *rwi)

virtual int	GetPointIndexFromXValue (double xValue)

virtual double	GetYValueFromIndex (int plotIndex, int pointIndex)

virtual double	GetYValueFromXValue (int plotIndex, double xValue)

virtual void	Refresh ()

Static Public Member Functions
static svkDetailedPlotDirector *	New ()

Protected Member Functions
	svkDetailedPlotDirector ()
	Constructor. More...

	~svkDetailedPlotDirector ()
	Destructor. More...

Detailed Description

The purpose if this class is to provide a simplified interface to the svkXYPlotActor that will work with simple vtkDataArray objects instead of requiring full fledged vtkDataObjects.

Constructor & Destructor Documentation

svkDetailedPlotDirector ( )

protected

Constructor.

References svkXYPlotActor::GetChartBoxProperty(), svkXYPlotActor::GetXAxisActor2D(), svkXYPlotActor::GetYAxisActor2D(), svkXYPlotActor::New(), svkXYPlotActor::SetAdjustXLabels(), svkXYPlotActor::SetAdjustYLabels(), svkXYPlotActor::SetXLabelFormat(), and svkXYPlotActor::SetYTitle().

~svkDetailedPlotDirector ( )

protected

Destructor.

Member Function Documentation

void AddInput	(	vtkDataArray *	array,
		int	component,
		vtkDataObject *	sourceToObserve
	)

virtual

Adds an input to the actor. This will add a plot line of the given component. The vtkDataObject input is optionally and is only used to regenerate the magnitude array when the given object is modified.

Parameters

array
component

References svkXYPlotActor::AddDataObjectInput(), svkDetailedPlotDirector::GenerateAbscissa(), svkXYPlotActor::GetDataObjectInputConnectionHolder(), svkXYPlotActor::SetDataObjectXComponent(), svkXYPlotActor::SetDataObjectYComponent(), and svkXYPlotActor::SetXValuesToValue().

Referenced by svkPlotGridView::UpdateDetailedPlot().

void AddOnMouseMoveObserver ( vtkRenderWindowInteractor * rwi )

virtual

Adds the observer to watch mouse movements and updates the cursor.

Parameters

rwi

Referenced by svkPlotGridView::SetTlcBrc().

void GenerateAbscissa	(	double	firstPointValue,
		double	lastPointValue
	)

virtual

Generates the array for the abscissa.

Parameters

lower
upper

Referenced by svkDetailedPlotDirector::AddInput(), svkDetailedPlotDirector::GenerateAbscissa(), svkPlotGridView::SetPlotUnits(), and svkPlotGridView::UpdateDetailedPlot().

void GenerateAbscissa	(	svkDcmHeader *	header,
		svkSpecPoint::UnitType	type
	)

virtual

Generates the array for the abscissa.

Parameters

header
type

References svkSpecPoint::ConvertPosUnits(), svkDetailedPlotDirector::GenerateAbscissa(), svkSpecPoint::New(), svkSpecPoint::PTS, and svkSpecPoint::SetDcmHeader().

svkXYPlotActor * GetPlotActor ( )

virtual

Pure Getter.

Returns

Referenced by svkPlotGridView::svkPlotGridView().

int GetPointIndexFromXValue ( double xValue )

virtual

For i given x-value return the index it closes matches in the adscissa array. If it is not within the abscissa, return -1.

Parameters

xValue

Returns

Referenced by svkDetailedPlotDirector::GetYValueFromXValue().

vtkAxisActor2D * GetRuler ( )

virtual

Pure getter.

Returns

Referenced by svkPlotGridView::svkPlotGridView().

double GetYValueFromIndex	(	int	plotIndex,
		int	pointIndex
	)

virtual

For a given index in the abscissa array find the corresponding Y value for the given plot index.

Parameters

plotIndex
pointIndex

Returns

References svkXYPlotActor::GetDataObjectInputConnectionHolder(), and svkXYPlotActor::GetDataObjectYComponent().

Referenced by svkDetailedPlotDirector::GetYValueFromXValue().

double GetYValueFromXValue	(	int	plotIndex,
		double	xValue
	)

virtual

For a given X value, find the corresponding Y value.

Parameters

plotIndex
xValue

Returns

References svkDetailedPlotDirector::GetPointIndexFromXValue(), and svkDetailedPlotDirector::GetYValueFromIndex().

static svkDetailedPlotDirector* New ( )

static

Referenced by svkPlotGridView::svkPlotGridView().

void Refresh ( )

virtual

Simply calls modified on the actor so that it will re-render. This recalculates the values in the plots.

Referenced by svkPlotGridView::Refresh(), and svkDetailedPlotDirector::SetPlotColor().

void RemoveAllInputs ( )

virtual

Removes all current inputs from the plot actor. Also removes callbacks.

References svkXYPlotActor::RemoveAllDataSetInputConnections().

Referenced by svkPlotGridView::UpdateDetailedPlot().

void RemoveInput ( vtkDataArray * array )

virtual

NOT YET IMPLEMENTED

Parameters

array

void RemoveOnMouseMoveObserver ( vtkRenderWindowInteractor * rwi )

virtual

Remove the observer for the cursor.

Parameters

rwi

Referenced by svkPlotGridView::SetTlcBrc().

void SetAnnotationText ( string text )

virtual

Sets an annotation. The title is used for this.

Referenced by svkPlotGridView::UpdateDetailedPlotOverlay().

void SetAnnotationTextVisibility ( bool visible )

virtual

Sets the visibilty of the annotation text.

Referenced by svkPlotGridView::TurnPropOff(), and svkPlotGridView::TurnPropOn().

void SetBackgroundColor ( double * rgb )

virtual

References svkXYPlotActor::GetChartBoxProperty().

Referenced by svkPlotGridView::SetColorSchema(), and svkPlotGridView::UpdateDetailedPlotOverlay().

void SetBackgroundOpacity ( double opacity )

virtual

Sets the background opacity

References svkXYPlotActor::GetChartBoxProperty().

Referenced by svkPlotGridView::SetOverlayOpacity(), and svkPlotGridView::UpdateDetailedPlotOverlay().

void SetBackgroundVisibility ( bool visible )

virtual

Sets the visibilty of the background.

Referenced by svkPlotGridView::TurnPropOff(), and svkPlotGridView::TurnPropOn().

void SetIndexRange	(	int	lower,
		int	upper
	)

virtual

Sets the range for the abscissa using indecies.

Parameters

lower
upper

Referenced by svkPlotGridView::SetWindowLevelRange(), and svkPlotGridView::UpdateDetailedPlot().

void SetLineWidth ( float width )

virtual

Sets the line width.

References svkXYPlotActor::SetLineWidth().

Referenced by svkPlotGridView::SetPlotLineWidth().

void SetPlotColor	(	int	plotIndex,
		double *	rgb
	)

virtual

Sets the color for a given plot.

Parameters

plotIndex
rgb

References svkDetailedPlotDirector::Refresh(), and svkXYPlotActor::SetPlotColor().

Referenced by svkPlotGridView::SetColorSchema(), and svkPlotGridView::UpdateDetailedPlot().

void SetYRange	(	double	lower,
		double	upper
	)

virtual

Sets the vertical range of the data.

Parameters

lower
upper

Referenced by svkPlotGridView::SetWindowLevelRange().

vtkTypeMacro	(	svkDetailedPlotDirector	,
		vtkObject
	)

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