vtkImageSlab Class Reference

#include <vtkImageSlab.h>

Inheritance diagram for vtkImageSlab:

Inheritance graph
[legend]
Collaboration diagram for vtkImageSlab:

Collaboration graph
[legend]

List of all members.


Detailed Description

combine image slices to form a slab image

vtkImageSlab will combine all of the slices of an image to create a single slice. The slices can be combined with the following operations: averaging, summation, minimum, maximum. If you require an arbitrary angle of projection, you can use vtkImageReslice.

Thanks:
Thanks to David Gobbi for contributing this class to VTK.
Tests:
vtkImageSlab (Tests)

Definition at line 40 of file vtkImageSlab.h.


Public Types

typedef vtkThreadedImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetOrientation (int)
void SetOrientationToX ()
void SetOrientationToY ()
void SetOrientationToZ ()
virtual int GetOrientation ()
virtual void SetSliceRange (int, int)
void SetSliceRange (int[2])
virtual int * GetSliceRange ()
virtual void GetSliceRange (int &, int &)
virtual void GetSliceRange (int[2])
virtual void SetOperation (int)
void SetOperationToMin ()
void SetOperationToMax ()
void SetOperationToMean ()
void SetOperationToSum ()
virtual int GetOperation ()
const char * GetOperationAsString ()
virtual void SetTrapezoidIntegration (int)
virtual void TrapezoidIntegrationOn ()
virtual void TrapezoidIntegrationOff ()
virtual int GetTrapezoidIntegration ()
virtual void SetMultiSliceOutput (int)
virtual void MultiSliceOutputOn ()
virtual void MultiSliceOutputOff ()
virtual int GetMultiSliceOutput ()
void SetOutputScalarTypeToFloat ()
void SetOutputScalarTypeToDouble ()
void SetOutputScalarTypeToInputScalarType ()
virtual int GetOutputScalarType ()

Static Public Member Functions

static vtkImageSlabNew ()
static int IsTypeOf (const char *type)
static vtkImageSlabSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkImageSlab ()
 ~vtkImageSlab ()
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ThreadedRequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector, vtkImageData ***inData, vtkImageData **outData, int ext[6], int id)
virtual void SetOutputScalarType (int)

Protected Attributes

int Operation
int Orientation
int SliceRange [2]
int OutputScalarType
int MultiSliceOutput
int TrapezoidIntegration

Member Typedef Documentation

Reimplemented from vtkThreadedImageAlgorithm.

Definition at line 44 of file vtkImageSlab.h.


Constructor & Destructor Documentation

vtkImageSlab::vtkImageSlab (  )  [protected]

vtkImageSlab::~vtkImageSlab (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

static int vtkImageSlab::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 vtkThreadedImageAlgorithm.

virtual int vtkImageSlab::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 vtkThreadedImageAlgorithm.

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

Reimplemented from vtkThreadedImageAlgorithm.

void vtkImageSlab::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 vtkThreadedImageAlgorithm.

virtual void vtkImageSlab::SetOrientation ( int   )  [virtual]

Set the slice direction: zero for x, 1 for y, 2 for z. The default is the Z direction.

void vtkImageSlab::SetOrientationToX (  )  [inline]

Set the slice direction: zero for x, 1 for y, 2 for z. The default is the Z direction.

Definition at line 51 of file vtkImageSlab.h.

void vtkImageSlab::SetOrientationToY (  )  [inline]

Set the slice direction: zero for x, 1 for y, 2 for z. The default is the Z direction.

Definition at line 53 of file vtkImageSlab.h.

void vtkImageSlab::SetOrientationToZ (  )  [inline]

Set the slice direction: zero for x, 1 for y, 2 for z. The default is the Z direction.

Definition at line 55 of file vtkImageSlab.h.

virtual int vtkImageSlab::GetOrientation (  )  [virtual]

Set the slice direction: zero for x, 1 for y, 2 for z. The default is the Z direction.

virtual void vtkImageSlab::SetSliceRange ( int  ,
int   
) [virtual]

Set the range of slices to combine. The default is to project through all slices.

void vtkImageSlab::SetSliceRange ( int  [2]  ) 

Set the range of slices to combine. The default is to project through all slices.

virtual int* vtkImageSlab::GetSliceRange (  )  [virtual]

Set the range of slices to combine. The default is to project through all slices.

virtual void vtkImageSlab::GetSliceRange ( int &  ,
int &   
) [virtual]

Set the range of slices to combine. The default is to project through all slices.

virtual void vtkImageSlab::GetSliceRange ( int  [2]  )  [virtual]

Set the range of slices to combine. The default is to project through all slices.

virtual void vtkImageSlab::SetOperation ( int   )  [virtual]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

void vtkImageSlab::SetOperationToMin (  )  [inline]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

Definition at line 71 of file vtkImageSlab.h.

void vtkImageSlab::SetOperationToMax (  )  [inline]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

Definition at line 73 of file vtkImageSlab.h.

void vtkImageSlab::SetOperationToMean (  )  [inline]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

Definition at line 75 of file vtkImageSlab.h.

void vtkImageSlab::SetOperationToSum (  )  [inline]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

Definition at line 77 of file vtkImageSlab.h.

virtual int vtkImageSlab::GetOperation (  )  [virtual]

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

const char* vtkImageSlab::GetOperationAsString (  ) 

Set the operation to use when combining slices. The choices are "Mean", "Sum", "Min", "Max". The default is "Mean".

virtual void vtkImageSlab::SetTrapezoidIntegration ( int   )  [virtual]

Use trapezoid integration for slab computation. This weighs the first and last slices by half when doing sum and mean, as compared to the default midpoint integration that weighs all slices equally. It is off by default.

virtual void vtkImageSlab::TrapezoidIntegrationOn (  )  [virtual]

Use trapezoid integration for slab computation. This weighs the first and last slices by half when doing sum and mean, as compared to the default midpoint integration that weighs all slices equally. It is off by default.

virtual void vtkImageSlab::TrapezoidIntegrationOff (  )  [virtual]

Use trapezoid integration for slab computation. This weighs the first and last slices by half when doing sum and mean, as compared to the default midpoint integration that weighs all slices equally. It is off by default.

virtual int vtkImageSlab::GetTrapezoidIntegration (  )  [virtual]

Use trapezoid integration for slab computation. This weighs the first and last slices by half when doing sum and mean, as compared to the default midpoint integration that weighs all slices equally. It is off by default.

virtual void vtkImageSlab::SetMultiSliceOutput ( int   )  [virtual]

Turn on multi-slice output. Each slice of the output will be a projection through the specified range of input slices, e.g. if the SliceRange is [0,3] then slice 'i' of the output will be a projection through slices 'i' through '3+i' of the input. This flag is off by default.

virtual void vtkImageSlab::MultiSliceOutputOn (  )  [virtual]

Turn on multi-slice output. Each slice of the output will be a projection through the specified range of input slices, e.g. if the SliceRange is [0,3] then slice 'i' of the output will be a projection through slices 'i' through '3+i' of the input. This flag is off by default.

virtual void vtkImageSlab::MultiSliceOutputOff (  )  [virtual]

Turn on multi-slice output. Each slice of the output will be a projection through the specified range of input slices, e.g. if the SliceRange is [0,3] then slice 'i' of the output will be a projection through slices 'i' through '3+i' of the input. This flag is off by default.

virtual int vtkImageSlab::GetMultiSliceOutput (  )  [virtual]

Turn on multi-slice output. Each slice of the output will be a projection through the specified range of input slices, e.g. if the SliceRange is [0,3] then slice 'i' of the output will be a projection through slices 'i' through '3+i' of the input. This flag is off by default.

void vtkImageSlab::SetOutputScalarTypeToFloat (  )  [inline]

Set the output scalar type to float or double, to avoid potential overflow when doing a summation operation. The default is to use the scalar type of the input data, and clamp the output to the range of the input scalar type.

Definition at line 109 of file vtkImageSlab.h.

void vtkImageSlab::SetOutputScalarTypeToDouble (  )  [inline]

Set the output scalar type to float or double, to avoid potential overflow when doing a summation operation. The default is to use the scalar type of the input data, and clamp the output to the range of the input scalar type.

Definition at line 111 of file vtkImageSlab.h.

void vtkImageSlab::SetOutputScalarTypeToInputScalarType (  )  [inline]

Set the output scalar type to float or double, to avoid potential overflow when doing a summation operation. The default is to use the scalar type of the input data, and clamp the output to the range of the input scalar type.

Definition at line 113 of file vtkImageSlab.h.

virtual int vtkImageSlab::GetOutputScalarType (  )  [virtual]

Set the output scalar type to float or double, to avoid potential overflow when doing a summation operation. The default is to use the scalar type of the input data, and clamp the output to the range of the input scalar type.

virtual int vtkImageSlab::RequestInformation ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual int vtkImageSlab::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Reimplemented from vtkImageAlgorithm.

virtual void vtkImageSlab::ThreadedRequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector,
vtkImageData ***  inData,
vtkImageData **  outData,
int  extent[6],
int  threadId 
) [protected, virtual]

If the subclass does not define an Execute method, then the task will be broken up, multiple threads will be spawned, and each thread will call this method. It is public so that the thread functions can call this method.

Reimplemented from vtkThreadedImageAlgorithm.

virtual void vtkImageSlab::SetOutputScalarType ( int   )  [protected, virtual]


Member Data Documentation

int vtkImageSlab::Operation [protected]

Definition at line 132 of file vtkImageSlab.h.

int vtkImageSlab::Orientation [protected]

Definition at line 135 of file vtkImageSlab.h.

int vtkImageSlab::SliceRange[2] [protected]

Definition at line 136 of file vtkImageSlab.h.

Definition at line 137 of file vtkImageSlab.h.

Definition at line 138 of file vtkImageSlab.h.

Definition at line 139 of file vtkImageSlab.h.


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

Generated on Wed Aug 24 11:42:16 2011 for VTK by  doxygen 1.5.6