vtkImageViewer2 Class Reference
#include <vtkImageViewer2.h>
Inheritance diagram for vtkImageViewer2:
[legend]Collaboration diagram for vtkImageViewer2:
[legend]List of all members.
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->SetInput( myImage ); 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
- Tests:
- vtkImageViewer2 (Tests)
Definition at line 73 of file vtkImageViewer2.h.
Member Typedef Documentation
Member Enumeration Documentation
|
|
Set/get the slice orientation BTX - Enumerator:
-
| SLICE_ORIENTATION_YZ |
|
| SLICE_ORIENTATION_XZ |
|
| SLICE_ORIENTATION_XY |
|
Definition at line 95 of file vtkImageViewer2.h. |
Constructor & Destructor Documentation
| vtkImageViewer2::vtkImageViewer2 |
( |
|
) |
[protected] |
|
| vtkImageViewer2::~vtkImageViewer2 |
( |
|
) |
[protected] |
|
Member Function Documentation
|
|
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject. |
| virtual const char* vtkImageViewer2::GetClassName |
( |
|
) |
[virtual] |
|
| static int vtkImageViewer2::IsTypeOf |
( |
const char * |
type |
) |
[static] |
|
|
|
Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
| virtual int vtkImageViewer2::IsA |
( |
const char * |
type |
) |
[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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkObject. |
| void vtkImageViewer2::PrintSelf |
( |
ostream & |
os, |
|
|
vtkIndent |
indent |
|
) |
[virtual] |
|
|
|
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. |
| virtual char* vtkImageViewer2::GetWindowName |
( |
|
) |
[virtual] |
|
|
|
Get the name of rendering window. |
| virtual void vtkImageViewer2::Render |
( |
void |
|
) |
[virtual] |
|
|
|
Render the resulting image. |
| virtual void vtkImageViewer2::SetInput |
( |
vtkImageData * |
in |
) |
[virtual] |
|
|
|
Set/Get the input image to the viewer. |
| virtual vtkImageData* vtkImageViewer2::GetInput |
( |
|
) |
[virtual] |
|
|
|
Render the resulting image. |
|
|
Render the resulting image. |
| virtual int vtkImageViewer2::GetSliceOrientation |
( |
|
) |
[virtual] |
|
|
|
Set/get the slice orientation BTX |
| virtual void vtkImageViewer2::SetSliceOrientation |
( |
int |
orientation |
) |
[virtual] |
|
|
|
Set/get the slice orientation BTX |
| virtual void vtkImageViewer2::SetSliceOrientationToXY |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkImageViewer2::SetSliceOrientationToYZ |
( |
|
) |
[inline, virtual] |
|
| virtual void vtkImageViewer2::SetSliceOrientationToXZ |
( |
|
) |
[inline, virtual] |
|
| virtual int vtkImageViewer2::GetSlice |
( |
|
) |
[virtual] |
|
|
|
Set/Get the current slice to display (depending on the orientation this can be in X, Y or Z). |
| virtual void vtkImageViewer2::SetSlice |
( |
int |
s |
) |
[virtual] |
|
|
|
Set/Get the current slice to display (depending on the orientation this can be in X, Y or Z). |
| virtual int vtkImageViewer2::GetSliceMin |
( |
|
) |
[virtual] |
|
|
|
Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z). |
| virtual int vtkImageViewer2::GetSliceMax |
( |
|
) |
[virtual] |
|
|
|
Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z). |
| virtual void vtkImageViewer2::GetSliceRange |
( |
int |
range[2] |
) |
[inline, virtual] |
|
|
|
Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z).
Definition at line 124 of file vtkImageViewer2.h. |
| virtual void vtkImageViewer2::GetSliceRange |
( |
int & |
min, |
|
|
int & |
max |
|
) |
[virtual] |
|
|
|
Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z). |
| virtual int* vtkImageViewer2::GetSliceRange |
( |
|
) |
[virtual] |
|
|
|
Return the minimum and maximum slice values (depending on the orientation this can be in X, Y or Z). |
| virtual double vtkImageViewer2::GetColorWindow |
( |
|
) |
[virtual] |
|
|
|
Set window and level for mapping pixels to colors. |
| virtual double vtkImageViewer2::GetColorLevel |
( |
|
) |
[virtual] |
|
|
|
Set window and level for mapping pixels to colors. |
| virtual void vtkImageViewer2::SetColorWindow |
( |
double |
s |
) |
[virtual] |
|
|
|
Set window and level for mapping pixels to colors. |
| virtual void vtkImageViewer2::SetColorLevel |
( |
double |
s |
) |
[virtual] |
|
|
|
Set window and level for mapping pixels to colors. |
| virtual void vtkImageViewer2::SetDisplayId |
( |
void * |
a |
) |
[virtual] |
|
|
|
These are here when using a Tk window. |
| virtual void vtkImageViewer2::SetWindowId |
( |
void * |
a |
) |
[virtual] |
|
|
|
These are here when using a Tk window. |
| virtual void vtkImageViewer2::SetParentId |
( |
void * |
a |
) |
[virtual] |
|
|
|
These are here when using a Tk window. |
| virtual int* vtkImageViewer2::GetPosition |
( |
|
) |
[virtual] |
|
|
|
Set/Get the position in screen coordinates of the rendering window. |
| virtual void vtkImageViewer2::SetPosition |
( |
int |
a, |
|
|
int |
b |
|
) |
[virtual] |
|
|
|
Set/Get the position in screen coordinates of the rendering window. |
| virtual void vtkImageViewer2::SetPosition |
( |
int |
a[2] |
) |
[inline, virtual] |
|
|
|
Set/Get the position in screen coordinates of the rendering window.
Definition at line 149 of file vtkImageViewer2.h. |
| virtual int* vtkImageViewer2::GetSize |
( |
|
) |
[virtual] |
|
|
|
Set/Get the size of the window in screen coordinates. |
| virtual void vtkImageViewer2::SetSize |
( |
int |
a, |
|
|
int |
b |
|
) |
[virtual] |
|
|
|
Set/Get the size of the window in screen coordinates. |
| virtual void vtkImageViewer2::SetSize |
( |
int |
a[2] |
) |
[inline, virtual] |
|
|
|
Set/Get the size of the window in screen coordinates.
Definition at line 156 of file vtkImageViewer2.h. |
|
|
Get the internal render window, renderer, image actor, and image map instances. |
| virtual vtkRenderer* vtkImageViewer2::GetRenderer |
( |
|
) |
[virtual] |
|
|
|
Get the internal render window, renderer, image actor, and image map instances. |
| virtual vtkImageActor* vtkImageViewer2::GetImageActor |
( |
|
) |
[virtual] |
|
|
|
Get the internal render window, renderer, image actor, and image map instances. |
|
|
Get the internal render window, renderer, image actor, and image map instances. |
|
|
Get the internal render window, renderer, image actor, and image map instances. |
| virtual void vtkImageViewer2::SetRenderWindow |
( |
vtkRenderWindow * |
arg |
) |
[virtual] |
|
|
|
Set your own renderwindow and renderer |
| virtual void vtkImageViewer2::SetRenderer |
( |
vtkRenderer * |
arg |
) |
[virtual] |
|
|
|
Set your own renderwindow and renderer |
|
|
Attach an interactor for the internal render window. |
| virtual void vtkImageViewer2::SetOffScreenRendering |
( |
int |
|
) |
[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. |
| virtual int vtkImageViewer2::GetOffScreenRendering |
( |
|
) |
[virtual] |
|
|
|
Attach an interactor for the internal render window. |
| virtual void vtkImageViewer2::OffScreenRenderingOn |
( |
|
) |
[virtual] |
|
|
|
Attach an interactor for the internal render window. |
| virtual void vtkImageViewer2::OffScreenRenderingOff |
( |
|
) |
[virtual] |
|
|
|
Attach an interactor for the internal render window. |
| int vtkImageViewer2::GetWholeZMin |
( |
|
) |
|
|
| int vtkImageViewer2::GetWholeZMax |
( |
|
) |
|
|
| int vtkImageViewer2::GetZSlice |
( |
|
) |
|
|
| void vtkImageViewer2::SetZSlice |
( |
int |
|
) |
|
|
| virtual void vtkImageViewer2::InstallPipeline |
( |
|
) |
[protected, virtual] |
|
| virtual void vtkImageViewer2::UnInstallPipeline |
( |
|
) |
[protected, virtual] |
|
| virtual void vtkImageViewer2::UpdateOrientation |
( |
|
) |
[protected, virtual] |
|
| virtual void vtkImageViewer2::UpdateDisplayExtent |
( |
|
) |
[protected, virtual] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
Generated on Mon Jan 21 23:54:34 2008 for VTK by
1.4.3-20050530