Display a 2d image. More...

#include <vtkImageViewer.h>

Inheritance diagram for vtkImageViewer:

Collaboration diagram for vtkImageViewer:

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkImageViewer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

char *	GetWindowName ()
	Get name of rendering window. More...

virtual void	Render ()
	Render the resulting image. More...

void	SetupInteractor (vtkRenderWindowInteractor *)
	Create and attach an interactor for this window. More...


void	SetInputData (vtkImageData *in)
	Set/Get the input to the viewer. More...

vtkImageData *	GetInput ()
	Set/Get the input to the viewer. More...

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set/Get the input to the viewer. More...


int	GetWholeZMin ()
	What is the possible Min/ Max z slices available. More...

int	GetWholeZMax ()
	What is the possible Min/ Max z slices available. More...


int	GetZSlice ()
	Set/Get the current Z Slice to display. More...

void	SetZSlice (int s)
	Set/Get the current Z Slice to display. More...


double	GetColorWindow ()
	Sets window/level for mapping pixels to colors. More...

double	GetColorLevel ()
	Sets window/level for mapping pixels to colors. More...

void	SetColorWindow (double s)
	Sets window/level for mapping pixels to colors. More...

void	SetColorLevel (double s)
	Sets window/level for mapping pixels to colors. More...


void	SetDisplayId (void *a)
	These are here for using a tk window. More...

void	SetWindowId (void *a)
	These are here for using a tk window. More...

void	SetParentId (void *a)
	These are here for using a tk window. More...


int *	GetPosition ()
	Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...

void	SetPosition (int x, int y)
	Set the position (x and y) of the rendering window in screen coordinates (in pixels). More...

virtual void	SetPosition (int a[2])
	Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...


int *	GetSize ()
	Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...

void	SetSize (int width, int height)
	Set the size (width and height) of the rendering window in screen coordinates (in pixels). More...

virtual void	SetSize (int a[2])
	Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...


virtual vtkRenderWindow *	GetRenderWindow ()
	Get the internal objects. More...

void	SetRenderWindow (vtkRenderWindow *renWin)
	Get the internal objects. More...

virtual vtkRenderer *	GetRenderer ()
	Get the internal objects. More...

virtual vtkImageMapper *	GetImageMapper ()
	Get the internal objects. More...

virtual vtkActor2D *	GetActor2D ()
	Get the internal objects. More...


void	SetOffScreenRendering (vtkTypeBool)
	Create a window in memory instead of on the screen. More...

vtkTypeBool	GetOffScreenRendering ()
	Create a window in memory instead of on the screen. More...

void	OffScreenRenderingOn ()
	Create a window in memory instead of on the screen. More...

void	OffScreenRenderingOff ()
	Create a window in memory instead of on the screen. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes. More...

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not. More...

Static Public Member Functions
static vtkImageViewer *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkImageViewer *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkImageViewer ()

	~vtkImageViewer () override

vtkAlgorithm *	GetInputAlgorithm ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkRenderWindow *	RenderWindow

vtkRenderer *	Renderer

vtkImageMapper *	ImageMapper

vtkActor2D *	Actor2D

int	FirstRender

vtkRenderWindowInteractor *	Interactor

vtkInteractorStyleImage *	InteractorStyle

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkImageViewerCallback

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Display a 2d image.

vtkImageViewer is a convenience class for displaying a 2d image. It packages up the functionality found in vtkRenderWindow, vtkRenderer, vtkActor2D and vtkImageMapper into a single easy to use class. Behind the scenes these four classes are actually used to to provide the required functionality. vtkImageViewer is simply a wrapper around them.

See also: vtkRenderWindow vtkRenderer vtkImageMapper vtkActor2D

Examples:: vtkImageViewer (Examples)

Online Examples:

HDRReader

ImageGradient

Tests:: vtkImageViewer (Tests)

Definition at line 64 of file vtkImageViewer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImageViewer::Superclass

Definition at line 69 of file vtkImageViewer.h.

Constructor & Destructor Documentation

◆ vtkImageViewer()

vtkImageViewer::vtkImageViewer ( )

protected

◆ ~vtkImageViewer()

vtkImageViewer::~vtkImageViewer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkImageViewer* vtkImageViewer::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkImageViewer::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkImageViewer::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkImageViewer* vtkImageViewer::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageViewer::NewInstanceInternal ( ) const

protectedvirtual

◆ NewInstance()

vtkImageViewer* vtkImageViewer::NewInstance ( ) const

◆ PrintSelf()

void vtkImageViewer::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ GetWindowName()

char* vtkImageViewer::GetWindowName ( )

inline

Get name of rendering window.

Definition at line 75 of file vtkImageViewer.h.

◆ Render()

virtual void vtkImageViewer::Render ( )

virtual

Render the resulting image.

◆ SetInputData()

void vtkImageViewer::SetInputData ( vtkImageData * in )

inline

Set/Get the input to the viewer.

Definition at line 86 of file vtkImageViewer.h.

◆ GetInput()

vtkImageData* vtkImageViewer::GetInput ( )

inline

Set/Get the input to the viewer.

Definition at line 87 of file vtkImageViewer.h.

◆ SetInputConnection()

virtual void vtkImageViewer::SetInputConnection ( vtkAlgorithmOutput * input )

inlinevirtual

Set/Get the input to the viewer.

Definition at line 88 of file vtkImageViewer.h.

◆ GetWholeZMin()

int vtkImageViewer::GetWholeZMin ( )

inline

What is the possible Min/ Max z slices available.

Definition at line 98 of file vtkImageViewer.h.

◆ GetWholeZMax()

int vtkImageViewer::GetWholeZMax ( )

inline

What is the possible Min/ Max z slices available.

Definition at line 99 of file vtkImageViewer.h.

◆ GetZSlice()

int vtkImageViewer::GetZSlice ( )

inline

Set/Get the current Z Slice to display.

Definition at line 106 of file vtkImageViewer.h.

◆ SetZSlice()

void vtkImageViewer::SetZSlice ( int s )

inline

Set/Get the current Z Slice to display.

Definition at line 107 of file vtkImageViewer.h.

◆ GetColorWindow()

double vtkImageViewer::GetColorWindow ( )

inline

Sets window/level for mapping pixels to colors.

Definition at line 114 of file vtkImageViewer.h.

◆ GetColorLevel()

double vtkImageViewer::GetColorLevel ( )

inline

Sets window/level for mapping pixels to colors.

Definition at line 115 of file vtkImageViewer.h.

◆ SetColorWindow()

void vtkImageViewer::SetColorWindow ( double s )

inline

Sets window/level for mapping pixels to colors.

Definition at line 116 of file vtkImageViewer.h.

◆ SetColorLevel()

void vtkImageViewer::SetColorLevel ( double s )

inline

Sets window/level for mapping pixels to colors.

Definition at line 117 of file vtkImageViewer.h.

◆ SetDisplayId()

void vtkImageViewer::SetDisplayId ( void * a )

inline

These are here for using a tk window.

Definition at line 124 of file vtkImageViewer.h.

◆ SetWindowId()

void vtkImageViewer::SetWindowId ( void * a )

inline

These are here for using a tk window.

Definition at line 125 of file vtkImageViewer.h.

◆ SetParentId()

void vtkImageViewer::SetParentId ( void * a )

inline

These are here for using a tk window.

Definition at line 126 of file vtkImageViewer.h.

◆ GetPosition()

int* vtkImageViewer::GetPosition ( )

inline

Get the position (x and y) of the rendering window in screen coordinates (in pixels).

Definition at line 134 of file vtkImageViewer.h.

◆ SetPosition() [1/2]

void vtkImageViewer::SetPosition	(	int	x,
		int	y
	)

inline

Set the position (x and y) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

Definition at line 141 of file vtkImageViewer.h.

◆ SetPosition() [2/2]

virtual void vtkImageViewer::SetPosition ( int a[2] )

virtual

Get the position (x and y) of the rendering window in screen coordinates (in pixels).

◆ GetSize()

int* vtkImageViewer::GetSize ( )

inline

Get the size (width and height) of the rendering window in screen coordinates (in pixels).

Definition at line 150 of file vtkImageViewer.h.

◆ SetSize() [1/2]

void vtkImageViewer::SetSize	(	int	width,
		int	height
	)

inline

Set the size (width and height) of the rendering window in screen coordinates (in pixels).

This resizes the operating system's view/window and redraws it.

If the size has changed, this method will fire vtkCommand::WindowResizeEvent.

Definition at line 160 of file vtkImageViewer.h.

◆ SetSize() [2/2]

virtual void vtkImageViewer::SetSize ( int a[2] )

virtual

Get the size (width and height) of the rendering window in screen coordinates (in pixels).

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkImageViewer::GetRenderWindow ( )

virtual

Get the internal objects.

◆ SetRenderWindow()

void vtkImageViewer::SetRenderWindow ( vtkRenderWindow * renWin )

Get the internal objects.

◆ GetRenderer()

virtual vtkRenderer* vtkImageViewer::GetRenderer ( )

virtual

Get the internal objects.

◆ GetImageMapper()

virtual vtkImageMapper* vtkImageViewer::GetImageMapper ( )

virtual

Get the internal objects.

◆ GetActor2D()

virtual vtkActor2D* vtkImageViewer::GetActor2D ( )

virtual

Get the internal objects.

◆ SetupInteractor()

void vtkImageViewer::SetupInteractor ( vtkRenderWindowInteractor * )

Create and attach an interactor for this window.

◆ SetOffScreenRendering()

void vtkImageViewer::SetOffScreenRendering ( vtkTypeBool )

Create a window in memory instead of on the screen.

This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

◆ GetOffScreenRendering()

vtkTypeBool vtkImageViewer::GetOffScreenRendering ( )

Create a window in memory instead of on the screen.

This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

◆ OffScreenRenderingOn()

void vtkImageViewer::OffScreenRenderingOn ( )

Create a window in memory instead of on the screen.

This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

◆ OffScreenRenderingOff()

void vtkImageViewer::OffScreenRenderingOff ( )

Create a window in memory instead of on the screen.

This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.

◆ GetInputAlgorithm()

vtkAlgorithm* vtkImageViewer::GetInputAlgorithm ( )

protected

Friends And Related Function Documentation

◆ vtkImageViewerCallback

friend class vtkImageViewerCallback

friend

Definition at line 204 of file vtkImageViewer.h.

Member Data Documentation

◆ RenderWindow

vtkRenderWindow* vtkImageViewer::RenderWindow

protected

Definition at line 196 of file vtkImageViewer.h.

◆ Renderer

vtkRenderer* vtkImageViewer::Renderer

protected

Definition at line 197 of file vtkImageViewer.h.

◆ ImageMapper

vtkImageMapper* vtkImageViewer::ImageMapper

protected

Definition at line 198 of file vtkImageViewer.h.

◆ Actor2D

vtkActor2D* vtkImageViewer::Actor2D

protected

Definition at line 199 of file vtkImageViewer.h.

◆ FirstRender

int vtkImageViewer::FirstRender

protected

Definition at line 200 of file vtkImageViewer.h.

◆ Interactor

vtkRenderWindowInteractor* vtkImageViewer::Interactor

protected

Definition at line 201 of file vtkImageViewer.h.

◆ InteractorStyle

vtkInteractorStyleImage* vtkImageViewer::InteractorStyle

protected

Definition at line 202 of file vtkImageViewer.h.

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

Interaction/Image/vtkImageViewer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImageViewer()

◆ ~vtkImageViewer()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ GetWindowName()

◆ Render()

◆ SetInputData()

◆ GetInput()

◆ SetInputConnection()

◆ GetWholeZMin()

◆ GetWholeZMax()

◆ GetZSlice()

◆ SetZSlice()

◆ GetColorWindow()

◆ GetColorLevel()

◆ SetColorWindow()

◆ SetColorLevel()

◆ SetDisplayId()

◆ SetWindowId()

◆ SetParentId()

◆ GetPosition()

◆ SetPosition() [1/2]

◆ SetPosition() [2/2]

◆ GetSize()

◆ SetSize() [1/2]

◆ SetSize() [2/2]

◆ GetRenderWindow()

◆ SetRenderWindow()

◆ GetRenderer()

◆ GetImageMapper()

◆ GetActor2D()

◆ SetupInteractor()

◆ SetOffScreenRendering()

◆ GetOffScreenRendering()

◆ OffScreenRenderingOn()

◆ OffScreenRenderingOff()

◆ GetInputAlgorithm()

Friends And Related Function Documentation

◆ vtkImageViewerCallback

Member Data Documentation

◆ RenderWindow

◆ Renderer

◆ ImageMapper

◆ Actor2D

◆ FirstRender

◆ Interactor

◆ InteractorStyle