#include <svkOverlayViewController.h>

Inheritance diagram for svkOverlayViewController:

Public Types
enum	InteractorStyle { SELECTION, WINDOW_LEVEL, COLOR_OVERLAY, ROTATION }

enum	WindowLevelTarget { REFERENCE_IMAGE = 0, IMAGE_OVERLAY }
	Enum for window level targets. More...

Public Member Functions
	vtkTypeMacro (svkOverlayViewController, svkDataViewController)

	svkOverlayViewController ()

	~svkOverlayViewController ()

virtual void	SetInput (svkImageData *data, int index=0)

virtual void	SetSlice (int slice)

virtual void	SetSlice (int slice, bool centerImage)

virtual void	SetSlice (int slice, svkDcmHeader::Orientation orientation)

virtual int	GetImageSlice (svkDcmHeader::Orientation sliceOrientation=svkDcmHeader::UNKNOWN_ORIENTATION)

virtual void	SetRWInteractor (vtkRenderWindowInteractor *)

virtual void	TurnPropOn (int propIndex)

virtual void	TurnPropOff (int propIndex)

virtual int *	GetTlcBrc ()

virtual void	SetTlcBrc (int *tlcBrc)

void	SetOverlayOpacity (double opacity)

void	SetOverlayThreshold (double threshold)

double	GetOverlayThreshold ()

double	GetOverlayThresholdValue ()

void	SetLevel (double level, WindowLevelTarget target=REFERENCE_IMAGE)

double	GetLevel (WindowLevelTarget target=REFERENCE_IMAGE)

void	SetWindow (double window, WindowLevelTarget target=REFERENCE_IMAGE)

double	GetWindow (WindowLevelTarget target=REFERENCE_IMAGE)

int	GetCurrentStyle ()

void	SetCurrentStyle (int style)

void	UseWindowLevelStyle ()
	Switches to the window level style interactor. More...

void	UseColorOverlayStyle ()
	Switches to the window level style interactor. More...

void	UseSelectionStyle ()
	Switches to the selection style interactor. More...

void	UseRotationStyle ()
	Switches to the rotation style interactor. More...

void	ResetWindowLevel ()
	Resets the window level, source taken from vtkImageViewer2. More...

void	HighlightSelectionVoxels ()

void	Reset ()

string	GetDataCompatibility (svkImageData *data, int targetIndex)

void	SetInterpolationType (int interpolationType)

void	SetLUT (svkLookupTable::svkLookupTableType type)

void	TurnOrthogonalImagesOn ()

void	TurnOrthogonalImagesOff ()

bool	IsImageInsideSpectra ()

Public Member Functions inherited from svkDataViewController
	vtkTypeMacro (svkDataViewController, vtkObject)

	svkDataViewController ()
	Constructor. More...

	~svkDataViewController ()
	Destructor. More...

virtual svkImageData *	GetData (int index=0)

virtual void	SetView (svkDataView *view)
	Set input data and initialize default range values. More...

virtual svkDataView *	GetView ()

virtual int	GetSlice ()

virtual void	SetWindowLevelRange (double lower, double upper, int index)

virtual vtkRenderWindowInteractor *	GetRWInteractor ()

Static Public Member Functions
static svkOverlayViewController *	New ()

Protected Types
enum	DataInputs { MRI = 0, MR4D = 1, MET = 2 }
	enum represents data indicies More...

Protected Attributes
bool	visualizationCreated
	enum represents data indicies More...

vtkRenderWindow *	myRenderWindow
	the views render window More...

vtkCallbackCommand *	cursorLocationCB
	callback that responds to mouse movements to update cursor location display More...

vtkCallbackCommand *	dragSelectionCB
	callback that responds to left click to highlight voxels More...

vtkCallbackCommand *	colorOverlayCB
	callback that responds to left click to highlight voxels More...

vtkCallbackCommand *	interactorSwitchCB

vtkTextActor *	mousePositionText
	the actor that represents the mouse location More...

vtkRenderer *	mouseLocRenderer
	the renderer used to display the mouse location More...

vtkInteractorObserver *	windowLevelStyle
	interactor style for window leveling More...

vtkInteractorObserver *	colorOverlayStyle
	interactor style for window leveling More...

vtkInteractorObserver *	rotationStyle
	interactor style for 3D rotation More...

svkOverlaySelector *	dragSelectStyle
	interactor style for selecting voxels More...

vtkActor *	scanBoundryActor
	actor that represents the scan boundry More...

double	initialColorWindowLevel [2]

int	pickPos [2]

double	startOpacity

int	currentInteractorStyle

Protected Attributes inherited from svkDataViewController
vector< svkImageData * >	dataVector

svkDataView *	view

vtkRenderWindowInteractor *	rwi

Detailed Description

svkOverlayViewController is a concrete implementation of DataViewController. It is designed to work with the svkOverlayView to create a workspace for overlaying the spatial location of spectroscopy voxels, with the anatomical image from the same scan.

Member Enumeration Documentation

enum DataInputs

protected

enum represents data indicies

Enumerator
MRI
MR4D
MET

enum InteractorStyle

Enumerator
SELECTION
WINDOW_LEVEL
COLOR_OVERLAY
ROTATION

enum WindowLevelTarget

Enum for window level targets.

Enumerator
REFERENCE_IMAGE
IMAGE_OVERLAY

Constructor & Destructor Documentation

svkOverlayViewController ( )

Constructor initializes the associated DataView and initializes callbacks.

~svkOverlayViewController ( )

Destructor.

References svkOverlayViewController::colorOverlayCB, svkOverlayViewController::colorOverlayStyle, svkOverlayViewController::cursorLocationCB, svkOverlayViewController::dragSelectionCB, svkOverlayViewController::dragSelectStyle, svkOverlayViewController::interactorSwitchCB, svkOverlayViewController::rotationStyle, svkDataViewController::rwi, svkOverlayViewController::scanBoundryActor, svkDataViewController::view, and svkOverlayViewController::windowLevelStyle.

Member Function Documentation

int GetCurrentStyle ( )

References svkOverlayViewController::currentInteractorStyle.

string GetDataCompatibility	(	svkImageData *	data,
		int	targetIndex
	)

References svkDataViewController::view.

int GetImageSlice ( svkDcmHeader::Orientation sliceOrientation = svkDcmHeader::UNKNOWN_ORIENTATION )

virtual

Getter for the current image slice, as opposed to the spectroscopic slice.

References svkDataView::GetOrientation(), svkDataView::GetSlice(), svkDataViewController::GetView(), and svkDcmHeader::UNKNOWN_ORIENTATION.

double GetLevel ( WindowLevelTarget target = REFERENCE_IMAGE )

References svkOverlayViewController::IMAGE_OVERLAY, svkOverlayViewController::REFERENCE_IMAGE, and svkDataViewController::view.

double GetOverlayThreshold ( )

References svkDataViewController::view.

double GetOverlayThresholdValue ( )

References svkDataViewController::view.

int * GetTlcBrc ( )

virtual

Used to get the current Top Left and Bottom Right Corners of the display

Returns: a pointer to a length two vector, the first element being the cell id of the top left corner and the second the bottom right corner.

References svkDataViewController::view.

Referenced by svkOverlayViewController::SetTlcBrc(), svkOverlayViewController::TurnPropOff(), and svkOverlayViewController::TurnPropOn().

double GetWindow ( WindowLevelTarget target = REFERENCE_IMAGE )

References svkOverlayViewController::IMAGE_OVERLAY, svkOverlayViewController::REFERENCE_IMAGE, and svkDataViewController::view.

void HighlightSelectionVoxels ( )

References svkDataViewController::view.

bool IsImageInsideSpectra ( )

References svkDataViewController::view.

static svkOverlayViewController* New ( )

static

void Reset ( )

void ResetWindowLevel ( )

Resets the window level, source taken from vtkImageViewer2.

References svkOverlayView::ResetWindowLevel(), and svkDataViewController::view.

void SetCurrentStyle ( int style )

References svkOverlayViewController::COLOR_OVERLAY, svkOverlayViewController::ROTATION, svkOverlayViewController::SELECTION, svkOverlayViewController::UseColorOverlayStyle(), svkOverlayViewController::UseRotationStyle(), svkOverlayViewController::UseSelectionStyle(), svkOverlayViewController::UseWindowLevelStyle(), and svkOverlayViewController::WINDOW_LEVEL.

void SetInput	(	svkImageData *	data,
		int	index = `0`
	)

virtual

Setter method. Also calls the SetInput method of its view. svkOverlayView has two inputs, an image and a spectroscopy data set.

Parameters

data	the data you wish to view
index	the index of the input you wish to set.

Implements svkDataViewController.

References svkDataViewController::dataVector, svkDataViewController::GetSlice(), svkDataViewController::GetView(), svkOverlayViewController::MET, svkOverlayView::MR4D, svkOverlayViewController::MR4D, svkOverlayViewController::MRI, svkDataView::SetInput(), svkOverlayViewController::SetSlice(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

void SetInterpolationType ( int interpolationType )

References svkDataViewController::view.

void SetLevel	(	double	level,
		WindowLevelTarget	target = `REFERENCE_IMAGE`
	)

References svkOverlayViewController::IMAGE_OVERLAY, svkOverlayViewController::REFERENCE_IMAGE, and svkDataViewController::view.

void SetLUT ( svkLookupTable::svkLookupTableType type )

References svkDataViewController::view.

void SetOverlayOpacity ( double opacity )

References svkDataViewController::view.

void SetOverlayThreshold ( double threshold )

References svkDataViewController::view.

void SetRWInteractor ( vtkRenderWindowInteractor * rwi )

virtual

Setter method. Also gets the render window from the render window actor. Once these have been set, CreateDataVisualization() is called and starts the actual create of the visualization.

Parameters

rwi	the vtkRenderWindowInteractor you want the View to use

Reimplemented from svkDataViewController.

References svkDataViewController::dataVector, svkOverlayViewController::MRI, svkOverlayViewController::myRenderWindow, svkDataViewController::rwi, and svkDataViewController::SetRWInteractor().

Referenced by svkOverlayViewController::Reset().

void SetSlice ( int slice )

virtual

Setter. Should be modified to take action once the slice is set, and to modify its View to do the same.

Parameters

slice	the slice you want to view
the	image you want to change the slice of, 0 is primary 1 and 2 are orthogonal

Reimplemented from svkDataViewController.

References svkDataView::SetSlice(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

Referenced by svkOverlayViewController::SetInput(), and svkOverlayViewController::SetSlice().

void SetSlice	(	int	slice,
		bool	centerImage
	)

virtual

Setter. Should be modified to take action once the slice is set, and to modify its View to do the same.

Parameters

slice	the slice you want to view
the	image you want to change the slice of, 0 is primary 1 and 2 are orthogonal

References svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

void SetSlice	(	int	slice,
		svkDcmHeader::Orientation	orientation
	)

virtual

Setter. Should be modified to take action once the slice is set, and to modify its View to do the same.

Parameters

slice	the slice you want to view
the	image you want to change the slice of, 0 is primary 1 and 2 are orthogonal

References svkOverlayViewController::SetSlice(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

void SetTlcBrc ( int * tlcBrc )

virtual

Used to set externally the Top Left and Bottom Right Corners of the display

Parameters

tlcBrc pointer to a length two vector, the first element being the l cell id of the top left corner and the second the bottom right corner.

References svkOverlayViewController::GetTlcBrc(), and svkDataViewController::view.

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

void SetWindow	(	double	window,
		WindowLevelTarget	target = `REFERENCE_IMAGE`
	)

References svkOverlayViewController::IMAGE_OVERLAY, svkOverlayViewController::REFERENCE_IMAGE, and svkDataViewController::view.

void TurnOrthogonalImagesOff ( )

References svkDataViewController::view.

void TurnOrthogonalImagesOn ( )

References svkDataViewController::view.

void TurnPropOff ( int propIndex )

virtual

Turn off the vtkActorCollection representing a given topology for a given image.

Parameters

actorIndex	the index of the topology you want to turn off
imageIndex	the index of the image who's topology you want turned off

References svkOverlayViewController::GetTlcBrc(), svkOverlayViewController::SetTlcBrc(), svkDataView::TurnPropOff(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

void TurnPropOn ( int propIndex )

virtual

Turn on the vtkActorCollection representing a given topology for a given image.

Parameters

actorIndex	the index of the topology you want to turn on
imageIndex	the index of the image who's topology you want turned on

References svkOverlayViewController::GetTlcBrc(), svkOverlayViewController::SetTlcBrc(), svkDataView::TurnPropOn(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

void UseColorOverlayStyle ( )

Switches to the window level style interactor.

References svkOverlayViewController::COLOR_OVERLAY, svkOverlayViewController::colorOverlayStyle, svkOverlayViewController::currentInteractorStyle, svkDataView::GetRenderer(), svkOverlayView::MOUSE_LOCATION, svkOverlayViewController::myRenderWindow, svkOverlayView::PRIMARY, svkDataView::Refresh(), svkDataViewController::rwi, svkDataView::TurnRendererOff(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

Referenced by svkOverlayViewController::SetCurrentStyle().

void UseRotationStyle ( )

Switches to the rotation style interactor.

References svkDcmHeader::AXIAL, svkDcmHeader::CORONAL, svkOverlayViewController::currentInteractorStyle, svkDataView::GetOrientation(), svkDataView::GetRenderer(), svkDataView::IsPropOn(), svkOverlayView::MOUSE_LOCATION, svkOverlayViewController::myRenderWindow, svkOverlayView::PRIMARY, svkOverlayViewController::ROTATION, svkOverlayViewController::rotationStyle, svkDataViewController::rwi, svkDcmHeader::SAGITTAL, svkOverlayView::SAT_BANDS_AXIAL, svkOverlayView::SAT_BANDS_AXIAL_OUTLINE, svkOverlayView::SAT_BANDS_CORONAL, svkOverlayView::SAT_BANDS_CORONAL_OUTLINE, svkOverlayView::SAT_BANDS_SAGITTAL, svkOverlayView::SAT_BANDS_SAGITTAL_OUTLINE, svkDataView::TurnPropOn(), svkDataView::TurnRendererOff(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

Referenced by svkOverlayViewController::SetCurrentStyle().

void UseSelectionStyle ( )

Switches to the selection style interactor.

References svkDcmHeader::AXIAL, svkDcmHeader::CORONAL, svkOverlayViewController::currentInteractorStyle, svkOverlayViewController::dragSelectStyle, svkDataView::GetRenderer(), svkDataViewController::GetView(), svkDataView::IsPropOn(), svkOverlayView::MOUSE_LOCATION, svkOverlayViewController::myRenderWindow, svkOverlayView::PRIMARY, svkDataViewController::rwi, svkDcmHeader::SAGITTAL, svkOverlayView::SAT_BANDS_AXIAL, svkOverlayView::SAT_BANDS_AXIAL_OUTLINE, svkOverlayView::SAT_BANDS_CORONAL, svkOverlayView::SAT_BANDS_CORONAL_OUTLINE, svkOverlayView::SAT_BANDS_SAGITTAL, svkOverlayView::SAT_BANDS_SAGITTAL_OUTLINE, svkOverlayViewController::SELECTION, svkDataView::TurnPropOff(), svkDataView::TurnPropOn(), svkDataView::TurnRendererOn(), svkDataViewController::view, and svkOverlayViewController::visualizationCreated.

Referenced by svkOverlayViewController::SetCurrentStyle().

void UseWindowLevelStyle ( )

Switches to the window level style interactor.

References svkOverlayViewController::currentInteractorStyle, svkOverlayView::MOUSE_LOCATION, svkOverlayViewController::myRenderWindow, svkDataViewController::rwi, svkDataView::TurnRendererOff(), svkDataViewController::view, svkOverlayViewController::visualizationCreated, svkOverlayViewController::WINDOW_LEVEL, and svkOverlayViewController::windowLevelStyle.

Referenced by svkOverlayViewController::SetCurrentStyle().

vtkTypeMacro	(	svkOverlayViewController	,
		svkDataViewController
	)

Member Data Documentation

vtkCallbackCommand* colorOverlayCB

protected

callback that responds to left click to highlight voxels

Referenced by svkOverlayViewController::Reset(), svkOverlayViewController::svkOverlayViewController(), and svkOverlayViewController::~svkOverlayViewController().

vtkInteractorObserver* colorOverlayStyle

protected

interactor style for window leveling

Referenced by svkOverlayViewController::svkOverlayViewController(), svkOverlayViewController::UseColorOverlayStyle(), and svkOverlayViewController::~svkOverlayViewController().

int currentInteractorStyle

protected

Referenced by svkOverlayViewController::GetCurrentStyle(), svkOverlayViewController::UseColorOverlayStyle(), svkOverlayViewController::UseRotationStyle(), svkOverlayViewController::UseSelectionStyle(), and svkOverlayViewController::UseWindowLevelStyle().

vtkCallbackCommand* cursorLocationCB

protected

callback that responds to mouse movements to update cursor location display

Referenced by svkOverlayViewController::Reset(), svkOverlayViewController::svkOverlayViewController(), and svkOverlayViewController::~svkOverlayViewController().

vtkCallbackCommand* dragSelectionCB

protected

callback that responds to left click to highlight voxels

Referenced by svkOverlayViewController::Reset(), svkOverlayViewController::svkOverlayViewController(), and svkOverlayViewController::~svkOverlayViewController().

svkOverlaySelector* dragSelectStyle

protected

interactor style for selecting voxels

Referenced by svkOverlayViewController::svkOverlayViewController(), svkOverlayViewController::UseSelectionStyle(), and svkOverlayViewController::~svkOverlayViewController().

double initialColorWindowLevel[2]

protected

vtkCallbackCommand* interactorSwitchCB

protected

Referenced by svkOverlayViewController::svkOverlayViewController(), and svkOverlayViewController::~svkOverlayViewController().

vtkRenderer* mouseLocRenderer

protected

the renderer used to display the mouse location

vtkTextActor* mousePositionText

protected

the actor that represents the mouse location

vtkRenderWindow* myRenderWindow

protected

the views render window

Referenced by svkOverlayViewController::SetRWInteractor(), svkOverlayViewController::UseColorOverlayStyle(), svkOverlayViewController::UseRotationStyle(), svkOverlayViewController::UseSelectionStyle(), and svkOverlayViewController::UseWindowLevelStyle().

int pickPos[2]

protected

vtkInteractorObserver* rotationStyle

protected

interactor style for 3D rotation

Referenced by svkOverlayViewController::svkOverlayViewController(), svkOverlayViewController::UseRotationStyle(), and svkOverlayViewController::~svkOverlayViewController().

vtkActor* scanBoundryActor

protected

actor that represents the scan boundry

Referenced by svkOverlayViewController::svkOverlayViewController(), and svkOverlayViewController::~svkOverlayViewController().

double startOpacity

protected

bool visualizationCreated

protected

enum represents data indicies

determines of the visualization has been initialized

Referenced by svkOverlayViewController::Reset(), svkOverlayViewController::SetInput(), svkOverlayViewController::SetSlice(), svkOverlayViewController::svkOverlayViewController(), svkOverlayViewController::TurnPropOff(), svkOverlayViewController::TurnPropOn(), svkOverlayViewController::UseColorOverlayStyle(), svkOverlayViewController::UseRotationStyle(), svkOverlayViewController::UseSelectionStyle(), and svkOverlayViewController::UseWindowLevelStyle().

vtkInteractorObserver* windowLevelStyle

protected

interactor style for window leveling

Referenced by svkOverlayViewController::svkOverlayViewController(), svkOverlayViewController::UseWindowLevelStyle(), and svkOverlayViewController::~svkOverlayViewController().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation