vtkExtractVOI Class Reference

#include <vtkExtractVOI.h>

Inheritance diagram for vtkExtractVOI:

Inheritance graph
[legend]
Collaboration diagram for vtkExtractVOI:

Collaboration graph
[legend]

List of all members.


Detailed Description

select piece (e.g., volume of interest) and/or subsample structured points dataset

vtkExtractVOI is a filter that selects a portion of an input structured points dataset, or subsamples an input dataset. (The selected portion of interested is referred to as the Volume Of Interest, or VOI.) The output of this filter is a structured points dataset. The filter treats input data of any topological dimension (i.e., point, line, image, or volume) and can generate output data of any topological dimension.

To use this filter set the VOI ivar which are i-j-k min/max indices that specify a rectangular region in the data. (Note that these are 0-offset.) You can also specify a sampling rate to subsample the data.

Typical applications of this filter are to extract a slice from a volume for image processing, subsampling large volumes to reduce data size, or extracting regions of a volume with interesting data.

See also:
vtkGeometryFilter vtkExtractGeometry vtkExtractGrid
Examples:
vtkExtractVOI (Examples)
Tests:
vtkExtractVOI (Tests)

Definition at line 49 of file vtkExtractVOI.h.


Public Types

typedef vtkImageAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetVOI (int, int, int, int, int, int)
virtual void SetVOI (int[6])
virtual int * GetVOI ()
virtual void GetVOI (int data[6])
virtual void SetSampleRate (int, int, int)
virtual void SetSampleRate (int[3])
virtual int * GetSampleRate ()
virtual void GetSampleRate (int data[3])

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkExtractVOISafeDownCast (vtkObject *o)
static vtkExtractVOINew ()

Protected Member Functions

 vtkExtractVOI ()
 ~vtkExtractVOI ()
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Protected Attributes

int VOI [6]
int SampleRate [3]

Member Typedef Documentation

Reimplemented from vtkImageAlgorithm.

Definition at line 52 of file vtkExtractVOI.h.


Constructor & Destructor Documentation

vtkExtractVOI::vtkExtractVOI (  )  [protected]

vtkExtractVOI::~vtkExtractVOI (  )  [inline, protected]

Definition at line 77 of file vtkExtractVOI.h.


Member Function Documentation

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

Reimplemented from vtkImageAlgorithm.

static int vtkExtractVOI::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

virtual int vtkExtractVOI::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

void vtkExtractVOI::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 vtkImageAlgorithm.

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

Construct object to extract all of the input data.

Reimplemented from vtkAlgorithm.

virtual void vtkExtractVOI::SetVOI ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
) [virtual]

Specify i-j-k (min,max) pairs to extract. The resulting structured points dataset can be of any topological dimension (i.e., point, line, image, or volume).

virtual void vtkExtractVOI::SetVOI ( int  [6]  )  [virtual]

Specify i-j-k (min,max) pairs to extract. The resulting structured points dataset can be of any topological dimension (i.e., point, line, image, or volume).

virtual int* vtkExtractVOI::GetVOI (  )  [virtual]

Specify i-j-k (min,max) pairs to extract. The resulting structured points dataset can be of any topological dimension (i.e., point, line, image, or volume).

virtual void vtkExtractVOI::GetVOI ( int  data[6]  )  [virtual]

Specify i-j-k (min,max) pairs to extract. The resulting structured points dataset can be of any topological dimension (i.e., point, line, image, or volume).

virtual void vtkExtractVOI::SetSampleRate ( int  ,
int  ,
int   
) [virtual]

Set the sampling rate in the i, j, and k directions. If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

virtual void vtkExtractVOI::SetSampleRate ( int  [3]  )  [virtual]

Set the sampling rate in the i, j, and k directions. If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

virtual int* vtkExtractVOI::GetSampleRate (  )  [virtual]

Set the sampling rate in the i, j, and k directions. If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

virtual void vtkExtractVOI::GetSampleRate ( int  data[3]  )  [virtual]

Set the sampling rate in the i, j, and k directions. If the rate is > 1, then the resulting VOI will be subsampled representation of the input. For example, if the SampleRate=(2,2,2), every other point will be selected, resulting in a volume 1/8th the original size.

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

Reimplemented from vtkImageAlgorithm.

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

Reimplemented from vtkImageAlgorithm.

virtual int vtkExtractVOI::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

This is called by the superclass. This is the method you should override.

Reimplemented from vtkImageAlgorithm.


Member Data Documentation

int vtkExtractVOI::VOI[6] [protected]

Definition at line 89 of file vtkExtractVOI.h.

int vtkExtractVOI::SampleRate[3] [protected]

Definition at line 90 of file vtkExtractVOI.h.


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

Generated on Sat Dec 27 13:25:01 2008 for VTK by  doxygen 1.5.6