VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkImageResliceMapper Class Reference

map a slice of a vtkImageData to the screen More...

#include <vtkImageResliceMapper.h>

Inheritance diagram for vtkImageResliceMapper:
Inheritance graph
[legend]
Collaboration diagram for vtkImageResliceMapper:
Collaboration graph
[legend]

List of all members.

Public Types

typedef vtkImageMapper3D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetSlicePlane (vtkPlane *plane)
virtual void Render (vtkRenderer *renderer, vtkImageSlice *prop)
virtual void ReleaseGraphicsResources (vtkWindow *)
unsigned long GetMTime ()
virtual void SetJumpToNearestSlice (int)
virtual void JumpToNearestSliceOn ()
virtual void JumpToNearestSliceOff ()
virtual int GetJumpToNearestSlice ()
virtual void SetSlabThickness (double)
virtual double GetSlabThickness ()
virtual void SetSlabType (int)
virtual int GetSlabType ()
void SetSlabTypeToMin ()
void SetSlabTypeToMax ()
void SetSlabTypeToMean ()
virtual const char * GetSlabTypeAsString ()
virtual void SetSlabSampleFactor (int)
virtual int GetSlabSampleFactor ()
virtual void SetImageSampleFactor (int)
virtual int GetImageSampleFactor ()
virtual void SetAutoAdjustImageQuality (int)
virtual void AutoAdjustImageQualityOn ()
virtual void AutoAdjustImageQualityOff ()
virtual int GetAutoAdjustImageQuality ()
virtual void SetResampleToScreenPixels (int)
virtual void ResampleToScreenPixelsOn ()
virtual void ResampleToScreenPixelsOff ()
virtual int GetResampleToScreenPixels ()
virtual void SetSeparateWindowLevelOperation (int)
virtual void SeparateWindowLevelOperationOn ()
virtual void SeparateWindowLevelOperationOff ()
virtual int GetSeparateWindowLevelOperation ()
virtual void SetInterpolator (vtkAbstractImageInterpolator *sampler)
virtual
vtkAbstractImageInterpolator
GetInterpolator ()
doubleGetBounds ()
void GetBounds (double bounds[6])
int ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)

Static Public Member Functions

static vtkImageResliceMapperNew ()
static int IsTypeOf (const char *type)
static vtkImageResliceMapperSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageResliceMapper ()
 ~vtkImageResliceMapper ()
void UpdateSliceToWorldMatrix (vtkCamera *camera)
void UpdateWorldToDataMatrix (vtkImageSlice *prop)
void UpdateResliceMatrix (vtkRenderer *ren, vtkImageSlice *prop)
void UpdateResliceInformation (vtkRenderer *ren)
void UpdateResliceInterpolation (vtkImageProperty *property)
void UpdateColorInformation (vtkImageProperty *property)
void UpdatePolygonCoords (vtkRenderer *ren)
void Update ()
void ReportReferences (vtkGarbageCollector *)
void CheckerboardImage (vtkImageData *input, vtkCamera *camera, vtkImageProperty *property)

Protected Attributes

vtkImageSliceMapperSliceMapper
int JumpToNearestSlice
int AutoAdjustImageQuality
int SeparateWindowLevelOperation
double SlabThickness
int SlabType
int SlabSampleFactor
int ImageSampleFactor
int ResampleToScreenPixels
int InternalResampleToScreenPixels
int ResliceNeedUpdate
vtkImageResliceToColorsImageReslice
vtkMatrix4x4ResliceMatrix
vtkMatrix4x4WorldToDataMatrix
vtkMatrix4x4SliceToWorldMatrix
vtkTimeStamp UpdateTime

Detailed Description

map a slice of a vtkImageData to the screen

vtkImageResliceMapper will cut a 3D image with an abitrary slice plane and draw the results on the screen. The slice can be set to automatically follow the camera, so that the camera controls the slicing.

Thanks:
Thanks to David Gobbi at the Seaman Family MR Centre and Dept. of Clinical Neurosciences, Foothills Medical Centre, Calgary, for providing this class.
See also:
vtkImageSlice vtkImageProperty vtkImageSliceMapper
Examples:
vtkImageResliceMapper (Examples)
Tests:
vtkImageResliceMapper (Tests)

Definition at line 50 of file vtkImageResliceMapper.h.


Member Typedef Documentation

Reimplemented from vtkImageMapper3D.

Definition at line 54 of file vtkImageResliceMapper.h.


Constructor & Destructor Documentation

vtkImageResliceMapper::vtkImageResliceMapper ( ) [protected]
vtkImageResliceMapper::~vtkImageResliceMapper ( ) [protected]

Member Function Documentation

static vtkImageResliceMapper* vtkImageResliceMapper::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkAlgorithm.

virtual const char* vtkImageResliceMapper::GetClassName ( ) [virtual]

Reimplemented from vtkImageMapper3D.

static int vtkImageResliceMapper::IsTypeOf ( const char *  name) [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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkImageMapper3D.

virtual int vtkImageResliceMapper::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 vtkImageMapper3D.

static vtkImageResliceMapper* vtkImageResliceMapper::SafeDownCast ( vtkObject o) [static]

Reimplemented from vtkImageMapper3D.

void vtkImageResliceMapper::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 vtkImageMapper3D.

virtual void vtkImageResliceMapper::SetSlicePlane ( vtkPlane plane) [virtual]

Set the slice that will be used to cut through the image. This slice should be in world coordinates, rather than data coordinates. Use SliceFacesCamera and SliceAtFocalPoint if you want the slice to automatically follow the camera.

virtual void vtkImageResliceMapper::SetJumpToNearestSlice ( int  ) [virtual]

When using SliceAtFocalPoint, this causes the slicing to occur at the closest slice to the focal point, instead of the default behavior where a new slice is interpolated between the original slices. This flag is ignored if the slicing is oblique to the original slices.

virtual void vtkImageResliceMapper::JumpToNearestSliceOn ( ) [virtual]

When using SliceAtFocalPoint, this causes the slicing to occur at the closest slice to the focal point, instead of the default behavior where a new slice is interpolated between the original slices. This flag is ignored if the slicing is oblique to the original slices.

virtual void vtkImageResliceMapper::JumpToNearestSliceOff ( ) [virtual]

When using SliceAtFocalPoint, this causes the slicing to occur at the closest slice to the focal point, instead of the default behavior where a new slice is interpolated between the original slices. This flag is ignored if the slicing is oblique to the original slices.

virtual int vtkImageResliceMapper::GetJumpToNearestSlice ( ) [virtual]

When using SliceAtFocalPoint, this causes the slicing to occur at the closest slice to the focal point, instead of the default behavior where a new slice is interpolated between the original slices. This flag is ignored if the slicing is oblique to the original slices.

virtual void vtkImageResliceMapper::SetSlabThickness ( double  ) [virtual]

The slab thickness, for thick slicing (default: zero)

virtual double vtkImageResliceMapper::GetSlabThickness ( ) [virtual]

The slab thickness, for thick slicing (default: zero)

virtual void vtkImageResliceMapper::SetSlabType ( int  ) [virtual]

The slab type, for thick slicing (default: mean)

virtual int vtkImageResliceMapper::GetSlabType ( ) [virtual]

The slab type, for thick slicing (default: mean)

void vtkImageResliceMapper::SetSlabTypeToMin ( ) [inline]

The slab type, for thick slicing (default: mean)

Definition at line 83 of file vtkImageResliceMapper.h.

void vtkImageResliceMapper::SetSlabTypeToMax ( ) [inline]

The slab type, for thick slicing (default: mean)

Definition at line 85 of file vtkImageResliceMapper.h.

void vtkImageResliceMapper::SetSlabTypeToMean ( ) [inline]

The slab type, for thick slicing (default: mean)

Definition at line 87 of file vtkImageResliceMapper.h.

virtual const char* vtkImageResliceMapper::GetSlabTypeAsString ( ) [virtual]

The slab type, for thick slicing (default: mean)

virtual void vtkImageResliceMapper::SetSlabSampleFactor ( int  ) [virtual]

Set the number of slab samples to use as a factor of the number of input slices within the slab thickness. The default value is 2, but 1 will increase speed with very little loss of quality.

virtual int vtkImageResliceMapper::GetSlabSampleFactor ( ) [virtual]

Set the number of slab samples to use as a factor of the number of input slices within the slab thickness. The default value is 2, but 1 will increase speed with very little loss of quality.

virtual void vtkImageResliceMapper::SetImageSampleFactor ( int  ) [virtual]

Set the reslice sample frequency as in relation to the input image sample frequency. The default value is 1, but higher values can be used to improve the results. This is cheaper than turning on ResampleToScreenPixels.

virtual int vtkImageResliceMapper::GetImageSampleFactor ( ) [virtual]

Set the reslice sample frequency as in relation to the input image sample frequency. The default value is 1, but higher values can be used to improve the results. This is cheaper than turning on ResampleToScreenPixels.

virtual void vtkImageResliceMapper::SetAutoAdjustImageQuality ( int  ) [virtual]

Automatically reduce the rendering quality for greater speed when doing an interactive render. This is on by default.

virtual void vtkImageResliceMapper::AutoAdjustImageQualityOn ( ) [virtual]

Automatically reduce the rendering quality for greater speed when doing an interactive render. This is on by default.

virtual void vtkImageResliceMapper::AutoAdjustImageQualityOff ( ) [virtual]

Automatically reduce the rendering quality for greater speed when doing an interactive render. This is on by default.

virtual int vtkImageResliceMapper::GetAutoAdjustImageQuality ( ) [virtual]

Automatically reduce the rendering quality for greater speed when doing an interactive render. This is on by default.

virtual void vtkImageResliceMapper::SetResampleToScreenPixels ( int  ) [virtual]

Resample the image directly to the screen pixels, instead of using a texture to scale the image after resampling. This is slower and uses more memory, but provides high-quality results. It is On by default.

virtual void vtkImageResliceMapper::ResampleToScreenPixelsOn ( ) [virtual]

Resample the image directly to the screen pixels, instead of using a texture to scale the image after resampling. This is slower and uses more memory, but provides high-quality results. It is On by default.

virtual void vtkImageResliceMapper::ResampleToScreenPixelsOff ( ) [virtual]

Resample the image directly to the screen pixels, instead of using a texture to scale the image after resampling. This is slower and uses more memory, but provides high-quality results. It is On by default.

virtual int vtkImageResliceMapper::GetResampleToScreenPixels ( ) [virtual]

Resample the image directly to the screen pixels, instead of using a texture to scale the image after resampling. This is slower and uses more memory, but provides high-quality results. It is On by default.

virtual void vtkImageResliceMapper::SetSeparateWindowLevelOperation ( int  ) [virtual]

Keep the color mapping stage distinct from the reslicing stage. This will improve the quality and possibly the speed of interactive window/level operations, but it uses more memory and might slow down interactive slicing operations. On by default.

virtual void vtkImageResliceMapper::SeparateWindowLevelOperationOn ( ) [virtual]

Keep the color mapping stage distinct from the reslicing stage. This will improve the quality and possibly the speed of interactive window/level operations, but it uses more memory and might slow down interactive slicing operations. On by default.

virtual void vtkImageResliceMapper::SeparateWindowLevelOperationOff ( ) [virtual]

Keep the color mapping stage distinct from the reslicing stage. This will improve the quality and possibly the speed of interactive window/level operations, but it uses more memory and might slow down interactive slicing operations. On by default.

virtual int vtkImageResliceMapper::GetSeparateWindowLevelOperation ( ) [virtual]

Keep the color mapping stage distinct from the reslicing stage. This will improve the quality and possibly the speed of interactive window/level operations, but it uses more memory and might slow down interactive slicing operations. On by default.

virtual void vtkImageResliceMapper::SetInterpolator ( vtkAbstractImageInterpolator sampler) [virtual]

Set a custom interpolator. This will only be used if the ResampleToScreenPixels option is on.

virtual vtkAbstractImageInterpolator* vtkImageResliceMapper::GetInterpolator ( ) [virtual]

Set a custom interpolator. This will only be used if the ResampleToScreenPixels option is on.

virtual void vtkImageResliceMapper::Render ( vtkRenderer renderer,
vtkImageSlice prop 
) [virtual]

This should only be called by the renderer.

Implements vtkImageMapper3D.

virtual void vtkImageResliceMapper::ReleaseGraphicsResources ( vtkWindow ) [virtual]

Release any graphics resources that are being consumed by this mapper. The parameter window is used to determine which graphic resources to release.

Implements vtkImageMapper3D.

unsigned long vtkImageResliceMapper::GetMTime ( ) [virtual]

Get the mtime for the mapper.

Reimplemented from vtkAbstractMapper.

double* vtkImageResliceMapper::GetBounds ( ) [virtual]

The bounding box (array of six doubles) of the data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Implements vtkAbstractMapper3D.

void vtkImageResliceMapper::GetBounds ( double  bounds[6]) [inline, virtual]

The bounding box (array of six doubles) of the data expressed as (xmin,xmax, ymin,ymax, zmin,zmax).

Reimplemented from vtkAbstractMapper3D.

Definition at line 158 of file vtkImageResliceMapper.h.

int vtkImageResliceMapper::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inInfo,
vtkInformationVector outInfo 
) [virtual]

Handle requests from the pipeline executive.

Reimplemented from vtkImageMapper3D.

void vtkImageResliceMapper::CheckerboardImage ( vtkImageData input,
vtkCamera camera,
vtkImageProperty property 
) [protected]

Do a checkerboard pattern to the alpha of an RGBA image

void vtkImageResliceMapper::UpdateSliceToWorldMatrix ( vtkCamera camera) [protected]

Update the slice-to-world matrix from the camera.

void vtkImageResliceMapper::UpdateWorldToDataMatrix ( vtkImageSlice prop) [protected]

Check if the vtkProp3D matrix has changed, and if so, set the WorldToDataMatrix to its inverse.

void vtkImageResliceMapper::UpdateResliceMatrix ( vtkRenderer ren,
vtkImageSlice prop 
) [protected]

Update the reslice matrix, which is the slice-to-data matrix.

void vtkImageResliceMapper::UpdateResliceInformation ( vtkRenderer ren) [protected]

Set all of the reslicing parameters. This requires that the SliceToWorld and WorldToData matrices are up-to-date.

void vtkImageResliceMapper::UpdateResliceInterpolation ( vtkImageProperty property) [protected]

Set the interpolation.

void vtkImageResliceMapper::UpdateColorInformation ( vtkImageProperty property) [protected]

Update anything related to the image coloring.

void vtkImageResliceMapper::UpdatePolygonCoords ( vtkRenderer ren) [protected]

Make a polygon by cutting the data bounds with a plane.

void vtkImageResliceMapper::Update ( ) [protected, virtual]

Override Update to handle some tricky details.

Reimplemented from vtkAlgorithm.

void vtkImageResliceMapper::ReportReferences ( vtkGarbageCollector ) [protected, virtual]

Garbage collection for reference loops.

Reimplemented from vtkAlgorithm.


Member Data Documentation

Definition at line 208 of file vtkImageResliceMapper.h.

Definition at line 210 of file vtkImageResliceMapper.h.

Definition at line 211 of file vtkImageResliceMapper.h.

Definition at line 212 of file vtkImageResliceMapper.h.

Definition at line 213 of file vtkImageResliceMapper.h.

Definition at line 214 of file vtkImageResliceMapper.h.

Definition at line 215 of file vtkImageResliceMapper.h.

Definition at line 216 of file vtkImageResliceMapper.h.

Definition at line 217 of file vtkImageResliceMapper.h.

Definition at line 218 of file vtkImageResliceMapper.h.

Definition at line 219 of file vtkImageResliceMapper.h.

Definition at line 220 of file vtkImageResliceMapper.h.

Definition at line 221 of file vtkImageResliceMapper.h.

Definition at line 222 of file vtkImageResliceMapper.h.

Definition at line 223 of file vtkImageResliceMapper.h.

Definition at line 224 of file vtkImageResliceMapper.h.


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