QuickView Class Reference

#include <QuickView.h>

Detailed Description

A convenient class to render itk images with vtk.

This class presents a convenient and efficient mechanism to display ITK images in VTK render windows.

The AddImage and AddRGBImage methods collect ITK images to be rendered in a collection of VTK RenderWindow's. Each image can be flipped about the vertical axis. An optional description will be displayed at the bottom of each render window.

If m_ShareCamera is true, a single vtkCamera will be used for each render window (default is false).

Each image is rescaled to have a range between 0 and 255. Currently, the size of each render window is fixed at 300,300 and the text size for descriptions is fixed at 10.

The Visualize method displays the render windows and starts a vtkInteractorStyleImage. The layout and background color of each render window is fixed. The optional boolean for the constructor, if false, bypasses the interactor. This is useful for running tests.

Typical usage:

QuickView viewer;
viewer.AddImage(someFilter->GetOutput().
                true (to flip image) or false.
                "text to display with the image");
 
viewer.AddRGBImage(someFilter->GetOutput().
                   true (to flip image) or false.
                   "text to display with the image");

Definition at line 111 of file QuickView.h.

Collaboration diagram for QuickView:

Public Member Functions
template<typename TImage>
void	AddImage (TImage *, bool FlipVertical=true, std::string Description="")
template<typename TImage>
void	AddRGBImage (TImage *, bool FlipVertical=true, std::string Description="")
void	InterpolateOff ()
void	InterpolateOn ()
	QuickView ()
void	SetNumberOfColumns (const unsigned int columns)
void	SetSnapshotExtension (const std::string &iExtension)
void	SetSnapshotPath (const std::string &iPath)
void	SetSnapshotPrefix (const std::string &iPrefix)
void	SetViewPortSize (const unsigned int size)
void	ShareCameraOff ()
void	ShareCameraOn ()
void	SnapshotOff ()
void	SnapshotOn ()
void	Visualize (bool interact=true)

Private Attributes
std::vector< ImageInfo >	Images
itk::IdentifierType	m_Counter
bool	m_Interpolate
unsigned int	m_NumberOfColumns
bool	m_ShareCamera
bool	m_Snapshot
std::string	m_SnapshotExtension
std::string	m_SnapshotPath
std::string	m_SnapshotPrefix
unsigned int	m_ViewPortSize
std::vector< RGBImageInfo >	RGBImages

Constructor & Destructor Documentation

QuickView()

QuickView::QuickView ( )

inline

Definition at line 114 of file QuickView.h.

References m_Counter, m_Interpolate, m_NumberOfColumns, m_ShareCamera, m_Snapshot, m_SnapshotExtension, m_SnapshotPath, m_SnapshotPrefix, and m_ViewPortSize.

Member Function Documentation

AddImage()

template<typename TImage>

void QuickView::AddImage	(	TImage *	,
		bool	FlipVertical = true,
		std::string	Description = "" )

Add an image to be rendered.

AddRGBImage()

template<typename TImage>

void QuickView::AddRGBImage	(	TImage *	,
		bool	FlipVertical = true,
		std::string	Description = "" )

Add an RGB image to be rendered

InterpolateOff()

void QuickView::InterpolateOff ( )

inline

Use pixel replication in rendered image

Definition at line 159 of file QuickView.h.

References m_Interpolate.

InterpolateOn()

void QuickView::InterpolateOn ( )

inline

Use pixel interpolation in rendered image

Definition at line 166 of file QuickView.h.

References m_Interpolate.

SetNumberOfColumns()

void QuickView::SetNumberOfColumns ( const unsigned int columns )

inline

Set the number of columns, default 4.

Definition at line 210 of file QuickView.h.

References m_NumberOfColumns.

SetSnapshotExtension()

void QuickView::SetSnapshotExtension ( const std::string & iExtension )

inline

Provide the image format to be used when taking snapshot

Definition at line 199 of file QuickView.h.

References m_SnapshotExtension.

SetSnapshotPath()

void QuickView::SetSnapshotPath ( const std::string & iPath )

inline

Definition at line 186 of file QuickView.h.

References m_SnapshotPath.

SetSnapshotPrefix()

void QuickView::SetSnapshotPrefix ( const std::string & iPrefix )

inline

Definition at line 192 of file QuickView.h.

References m_SnapshotPrefix.

SetViewPortSize()

void QuickView::SetViewPortSize ( const unsigned int size )

inline

Set the viewport size, default 300.

Definition at line 217 of file QuickView.h.

References m_ViewPortSize.

ShareCameraOff()

void QuickView::ShareCameraOff ( )

inline

Each render window will have its own camera

Definition at line 145 of file QuickView.h.

References m_ShareCamera.

ShareCameraOn()

void QuickView::ShareCameraOn ( )

inline

Each render window will use the same camera

Definition at line 152 of file QuickView.h.

References m_ShareCamera.

SnapshotOff()

void QuickView::SnapshotOff ( )

inline

Each render window will take a snapshot

Definition at line 180 of file QuickView.h.

References m_Snapshot.

SnapshotOn()

void QuickView::SnapshotOn ( )

inline

Each render window will take a snapshot

Definition at line 173 of file QuickView.h.

References m_Snapshot.

Visualize()

void QuickView::Visualize

(

bool

interact = true

)

Render the images. If interact is true, start a vtk Interactor. If false, return after one render.

Member Data Documentation

Images

std::vector<ImageInfo> QuickView::Images

private

Definition at line 223 of file QuickView.h.

m_Counter

itk::IdentifierType QuickView::m_Counter

private

Definition at line 225 of file QuickView.h.

Referenced by QuickView().

m_Interpolate

bool QuickView::m_Interpolate

private

Definition at line 231 of file QuickView.h.

Referenced by InterpolateOff(), InterpolateOn(), and QuickView().

m_NumberOfColumns

unsigned int QuickView::m_NumberOfColumns

private

Definition at line 232 of file QuickView.h.

Referenced by QuickView(), and SetNumberOfColumns().

m_ShareCamera

bool QuickView::m_ShareCamera

private

Definition at line 229 of file QuickView.h.

Referenced by QuickView(), ShareCameraOff(), and ShareCameraOn().

m_Snapshot

bool QuickView::m_Snapshot

private

Definition at line 230 of file QuickView.h.

Referenced by QuickView(), SnapshotOff(), and SnapshotOn().

m_SnapshotExtension

std::string QuickView::m_SnapshotExtension

private

Definition at line 228 of file QuickView.h.

Referenced by QuickView(), and SetSnapshotExtension().

m_SnapshotPath

std::string QuickView::m_SnapshotPath

private

Definition at line 226 of file QuickView.h.

Referenced by QuickView(), and SetSnapshotPath().

m_SnapshotPrefix

std::string QuickView::m_SnapshotPrefix

private

Definition at line 227 of file QuickView.h.

Referenced by QuickView(), and SetSnapshotPrefix().

m_ViewPortSize

unsigned int QuickView::m_ViewPortSize

private

Definition at line 233 of file QuickView.h.

Referenced by QuickView(), and SetViewPortSize().

RGBImages

std::vector<RGBImageInfo> QuickView::RGBImages

private

Definition at line 224 of file QuickView.h.

---

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

• QuickView.h