VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkImageViewer2 Class Reference

Display a 2D image. More...

#include <vtkImageViewer2.h>

Inheritance diagram for vtkImageViewer2:
[legend]
Collaboration diagram for vtkImageViewer2:
[legend]

Public Types

enum  { SLICE_ORIENTATION_YZ = 0, SLICE_ORIENTATION_XZ = 1, SLICE_ORIENTATION_XY = 2 }
 Set/get the slice orientation. More...
 
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...
 
vtkImageViewer2NewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual const char * GetWindowName ()
 Get the name of rendering window. More...
 
virtual void Render (void)
 Render the resulting image. More...
 
virtual void SetInputData (vtkImageData *in)
 Set/Get the input image to the viewer. More...
 
virtual vtkImageDataGetInput ()
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual int GetSliceOrientation ()
 
virtual void SetSliceOrientation (int orientation)
 
virtual void SetSliceOrientationToXY ()
 
virtual void SetSliceOrientationToYZ ()
 
virtual void SetSliceOrientationToXZ ()
 
virtual int GetSlice ()
 Set/Get the current slice to display (depending on the orientation this can be in X, Y or Z). More...
 
virtual void SetSlice (int s)
 
virtual void UpdateDisplayExtent ()
 Update the display extent manually so that the proper slice for the given orientation is displayed. More...
 
virtual int GetSliceMin ()
 Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z). More...
 
virtual int GetSliceMax ()
 
virtual void GetSliceRange (int range[2])
 
virtual void GetSliceRange (int &min, int &max)
 
virtual int * GetSliceRange ()
 
virtual double GetColorWindow ()
 Set window and level for mapping pixels to colors. More...
 
virtual double GetColorLevel ()
 
virtual void SetColorWindow (double s)
 
virtual void SetColorLevel (double s)
 
virtual void SetDisplayId (void *a)
 These are here when using a Tk window. More...
 
virtual void SetWindowId (void *a)
 
virtual void SetParentId (void *a)
 
virtual int * GetPosition ()
 Set/Get the position in screen coordinates of the rendering window. More...
 
virtual void SetPosition (int a, int b)
 
virtual void SetPosition (int a[2])
 
virtual int * GetSize ()
 Set/Get the size of the window in screen coordinates in pixels. More...
 
virtual void SetSize (int a, int b)
 
virtual void SetSize (int a[2])
 
virtual vtkRenderWindowGetRenderWindow ()
 Get the internal render window, renderer, image actor, and image map instances. More...
 
virtual vtkRendererGetRenderer ()
 
virtual vtkImageActorGetImageActor ()
 
virtual vtkImageMapToWindowLevelColorsGetWindowLevel ()
 
virtual vtkInteractorStyleImageGetInteractorStyle ()
 
virtual void SetRenderWindow (vtkRenderWindow *arg)
 Set your own renderwindow and renderer. More...
 
virtual void SetRenderer (vtkRenderer *arg)
 
virtual void SetupInteractor (vtkRenderWindowInteractor *)
 Attach an interactor for the internal render window. More...
 
virtual void SetOffScreenRendering (vtkTypeBool)
 Create a window in memory instead of on the screen. More...
 
virtual vtkTypeBool GetOffScreenRendering ()
 
virtual void OffScreenRenderingOn ()
 
virtual void OffScreenRenderingOff ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkImageViewer2New ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkImageViewer2SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkImageViewer2 ()
 
 ~vtkImageViewer2 () override
 
virtual void InstallPipeline ()
 
virtual void UnInstallPipeline ()
 
virtual void UpdateOrientation ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkInformationGetInputInformation ()
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkImageMapToWindowLevelColorsWindowLevel
 
vtkRenderWindowRenderWindow
 
vtkRendererRenderer
 
vtkImageActorImageActor
 
vtkRenderWindowInteractorInteractor
 
vtkInteractorStyleImageInteractorStyle
 
int SliceOrientation
 
int FirstRender
 
int Slice
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkImageViewer2Callback
 

Detailed Description

Display a 2D image.

vtkImageViewer2 is a convenience class for displaying a 2D image. It packages up the functionality found in vtkRenderWindow, vtkRenderer, vtkImageActor and vtkImageMapToWindowLevelColors into a single easy to use class. This class also creates an image interactor style (vtkInteractorStyleImage) that allows zooming and panning of images, and supports interactive window/level operations on the image. Note that vtkImageViewer2 is simply a wrapper around these classes.

vtkImageViewer2 uses the 3D rendering and texture mapping engine to draw an image on a plane. This allows for rapid rendering, zooming, and panning. The image is placed in the 3D scene at a depth based on the z-coordinate of the particular image slice. Each call to SetSlice() changes the image data (slice) displayed AND changes the depth of the displayed slice in the 3D scene. This can be controlled by the AutoAdjustCameraClippingRange ivar of the InteractorStyle member.

It is possible to mix images and geometry, using the methods:

viewer->SetInputConnection( imageSource->GetOutputPort() ); // or viewer->SetInputData ( image ); viewer->GetRenderer()->AddActor( myActor );

This can be used to annotate an image with a PolyData of "edges" or or highlight sections of an image or display a 3D isosurface with a slice from the volume, etc. Any portions of your geometry that are in front of the displayed slice will be visible; any portions of your geometry that are behind the displayed slice will be obscured. A more general framework (with respect to viewing direction) for achieving this effect is provided by the vtkImagePlaneWidget .

Note that pressing 'r' will reset the window/level and pressing shift+'r' or control+'r' will reset the camera.

See also
vtkRenderWindow vtkRenderer vtkImageActor vtkImageMapToWindowLevelColors

Definition at line 75 of file vtkImageViewer2.h.

Member Typedef Documentation

◆ Superclass

Definition at line 79 of file vtkImageViewer2.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Set/get the slice orientation.

Enumerator
SLICE_ORIENTATION_YZ 
SLICE_ORIENTATION_XZ 
SLICE_ORIENTATION_XY 

Definition at line 105 of file vtkImageViewer2.h.

Constructor & Destructor Documentation

◆ vtkImageViewer2()

vtkImageViewer2::vtkImageViewer2 ( )
protected

◆ ~vtkImageViewer2()

vtkImageViewer2::~vtkImageViewer2 ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkImageViewer2* vtkImageViewer2::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkImageViewer2::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.

Reimplemented in vtkResliceImageViewer.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkImageViewer2::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented in vtkResliceImageViewer.

◆ NewInstance()

vtkImageViewer2* vtkImageViewer2::NewInstance ( ) const

◆ PrintSelf()

void vtkImageViewer2::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.

Reimplemented in vtkResliceImageViewer.

◆ GetWindowName()

virtual const char* vtkImageViewer2::GetWindowName ( )
virtual

Get the name of rendering window.

◆ Render()

virtual void vtkImageViewer2::Render ( void  )
virtual

Render the resulting image.

Reimplemented in vtkResliceImageViewer.

◆ SetInputData()

virtual void vtkImageViewer2::SetInputData ( vtkImageData in)
virtual

Set/Get the input image to the viewer.

Reimplemented in vtkResliceImageViewer.

◆ GetInput()

virtual vtkImageData* vtkImageViewer2::GetInput ( )
virtual

◆ SetInputConnection()

virtual void vtkImageViewer2::SetInputConnection ( vtkAlgorithmOutput input)
virtual

Reimplemented in vtkResliceImageViewer.

◆ GetSliceOrientation()

virtual int vtkImageViewer2::GetSliceOrientation ( )
virtual

◆ SetSliceOrientation()

virtual void vtkImageViewer2::SetSliceOrientation ( int  orientation)
virtual

◆ SetSliceOrientationToXY()

virtual void vtkImageViewer2::SetSliceOrientationToXY ( )
inlinevirtual

Definition at line 114 of file vtkImageViewer2.h.

◆ SetSliceOrientationToYZ()

virtual void vtkImageViewer2::SetSliceOrientationToYZ ( )
inlinevirtual

Definition at line 118 of file vtkImageViewer2.h.

◆ SetSliceOrientationToXZ()

virtual void vtkImageViewer2::SetSliceOrientationToXZ ( )
inlinevirtual

Definition at line 122 of file vtkImageViewer2.h.

◆ GetSlice()

virtual int vtkImageViewer2::GetSlice ( )
virtual

Set/Get the current slice to display (depending on the orientation this can be in X, Y or Z).

◆ SetSlice()

virtual void vtkImageViewer2::SetSlice ( int  s)
virtual

◆ UpdateDisplayExtent()

virtual void vtkImageViewer2::UpdateDisplayExtent ( )
virtual

Update the display extent manually so that the proper slice for the given orientation is displayed.

It will also try to set a reasonable camera clipping range. This method is called automatically when the Input is changed, but most of the time the input of this class is likely to remain the same, i.e. connected to the output of a filter, or an image reader. When the input of this filter or reader itself is changed, an error message might be displayed since the current display extent is probably outside the new whole extent. Calling this method will ensure that the display extent is reset properly.

Reimplemented in vtkResliceImageViewer.

◆ GetSliceMin()

virtual int vtkImageViewer2::GetSliceMin ( )
virtual

Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z).

◆ GetSliceMax()

virtual int vtkImageViewer2::GetSliceMax ( )
virtual

◆ GetSliceRange() [1/3]

virtual void vtkImageViewer2::GetSliceRange ( int  range[2])
inlinevirtual

Definition at line 157 of file vtkImageViewer2.h.

◆ GetSliceRange() [2/3]

virtual void vtkImageViewer2::GetSliceRange ( int &  min,
int &  max 
)
virtual

◆ GetSliceRange() [3/3]

virtual int* vtkImageViewer2::GetSliceRange ( )
virtual

◆ GetColorWindow()

virtual double vtkImageViewer2::GetColorWindow ( )
virtual

Set window and level for mapping pixels to colors.

◆ GetColorLevel()

virtual double vtkImageViewer2::GetColorLevel ( )
virtual

◆ SetColorWindow()

virtual void vtkImageViewer2::SetColorWindow ( double  s)
virtual

Reimplemented in vtkResliceImageViewer.

◆ SetColorLevel()

virtual void vtkImageViewer2::SetColorLevel ( double  s)
virtual

Reimplemented in vtkResliceImageViewer.

◆ SetDisplayId()

virtual void vtkImageViewer2::SetDisplayId ( void *  a)
virtual

These are here when using a Tk window.

◆ SetWindowId()

virtual void vtkImageViewer2::SetWindowId ( void *  a)
virtual

◆ SetParentId()

virtual void vtkImageViewer2::SetParentId ( void *  a)
virtual

◆ GetPosition()

virtual int* vtkImageViewer2::GetPosition ( )
virtual

Set/Get the position in screen coordinates of the rendering window.

◆ SetPosition() [1/2]

virtual void vtkImageViewer2::SetPosition ( int  a,
int  b 
)
virtual

◆ SetPosition() [2/2]

virtual void vtkImageViewer2::SetPosition ( int  a[2])
inlinevirtual

Definition at line 187 of file vtkImageViewer2.h.

◆ GetSize()

virtual int* vtkImageViewer2::GetSize ( )
virtual

Set/Get the size of the window in screen coordinates in pixels.

◆ SetSize() [1/2]

virtual void vtkImageViewer2::SetSize ( int  a,
int  b 
)
virtual

◆ SetSize() [2/2]

virtual void vtkImageViewer2::SetSize ( int  a[2])
inlinevirtual

Definition at line 196 of file vtkImageViewer2.h.

◆ GetRenderWindow()

virtual vtkRenderWindow* vtkImageViewer2::GetRenderWindow ( )
virtual

Get the internal render window, renderer, image actor, and image map instances.

◆ GetRenderer()

virtual vtkRenderer* vtkImageViewer2::GetRenderer ( )
virtual

◆ GetImageActor()

virtual vtkImageActor* vtkImageViewer2::GetImageActor ( )
virtual

◆ GetWindowLevel()

virtual vtkImageMapToWindowLevelColors* vtkImageViewer2::GetWindowLevel ( )
virtual

◆ GetInteractorStyle()

virtual vtkInteractorStyleImage* vtkImageViewer2::GetInteractorStyle ( )
virtual

◆ SetRenderWindow()

virtual void vtkImageViewer2::SetRenderWindow ( vtkRenderWindow arg)
virtual

Set your own renderwindow and renderer.

◆ SetRenderer()

virtual void vtkImageViewer2::SetRenderer ( vtkRenderer arg)
virtual

◆ SetupInteractor()

virtual void vtkImageViewer2::SetupInteractor ( vtkRenderWindowInteractor )
virtual

Attach an interactor for the internal render window.

◆ SetOffScreenRendering()

virtual void vtkImageViewer2::SetOffScreenRendering ( vtkTypeBool  )
virtual

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()

virtual vtkTypeBool vtkImageViewer2::GetOffScreenRendering ( )
virtual

◆ OffScreenRenderingOn()

virtual void vtkImageViewer2::OffScreenRenderingOn ( )
virtual

◆ OffScreenRenderingOff()

virtual void vtkImageViewer2::OffScreenRenderingOff ( )
virtual

◆ InstallPipeline()

virtual void vtkImageViewer2::InstallPipeline ( )
protectedvirtual

Reimplemented in vtkResliceImageViewer.

◆ UnInstallPipeline()

virtual void vtkImageViewer2::UnInstallPipeline ( )
protectedvirtual

Reimplemented in vtkResliceImageViewer.

◆ UpdateOrientation()

virtual void vtkImageViewer2::UpdateOrientation ( )
protectedvirtual

Reimplemented in vtkResliceImageViewer.

◆ GetInputAlgorithm()

vtkAlgorithm* vtkImageViewer2::GetInputAlgorithm ( )
protected

◆ GetInputInformation()

vtkInformation* vtkImageViewer2::GetInputInformation ( )
protected

Friends And Related Function Documentation

◆ vtkImageViewer2Callback

friend class vtkImageViewer2Callback
friend

Definition at line 258 of file vtkImageViewer2.h.

Member Data Documentation

◆ WindowLevel

vtkImageMapToWindowLevelColors* vtkImageViewer2::WindowLevel
protected

Definition at line 242 of file vtkImageViewer2.h.

◆ RenderWindow

vtkRenderWindow* vtkImageViewer2::RenderWindow
protected

Definition at line 243 of file vtkImageViewer2.h.

◆ Renderer

vtkRenderer* vtkImageViewer2::Renderer
protected

Definition at line 244 of file vtkImageViewer2.h.

◆ ImageActor

vtkImageActor* vtkImageViewer2::ImageActor
protected

Definition at line 245 of file vtkImageViewer2.h.

◆ Interactor

vtkRenderWindowInteractor* vtkImageViewer2::Interactor
protected

Definition at line 246 of file vtkImageViewer2.h.

◆ InteractorStyle

vtkInteractorStyleImage* vtkImageViewer2::InteractorStyle
protected

Definition at line 247 of file vtkImageViewer2.h.

◆ SliceOrientation

int vtkImageViewer2::SliceOrientation
protected

Definition at line 249 of file vtkImageViewer2.h.

◆ FirstRender

int vtkImageViewer2::FirstRender
protected

Definition at line 250 of file vtkImageViewer2.h.

◆ Slice

int vtkImageViewer2::Slice
protected

Definition at line 251 of file vtkImageViewer2.h.


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