VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkExtractGrid Class Reference

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

#include <vtkExtractGrid.h>

Inherits vtkStructuredGridAlgorithm.

Public Types

typedef vtkStructuredGridAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkExtractGridNewInstance () const
 
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])
 
virtual void SetIncludeBoundary (int)
 
virtual int GetIncludeBoundary ()
 
virtual void IncludeBoundaryOn ()
 
virtual void IncludeBoundaryOff ()
 

Static Public Member Functions

static vtkExtractGridNew ()
 
static int IsTypeOf (const char *type)
 
static vtkExtractGridSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkExtractGrid ()
 
 ~vtkExtractGrid ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

Protected Attributes

int VOI [6]
 
int SampleRate [3]
 
int IncludeBoundary
 

Detailed Description

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

vtkExtractGrid is a filter that selects a portion of an input structured grid 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 grid 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 plane from a grid for contouring, subsampling large grids to reduce data size, or extracting regions of a grid with interesting data.

See Also
vtkGeometryFilter vtkExtractGeometry vtkExtractVOI vtkStructuredGridGeometryFilter
Examples:
vtkExtractGrid (Examples)
Tests:
vtkExtractGrid (Tests)

Definition at line 51 of file vtkExtractGrid.h.

Member Typedef Documentation

typedef vtkStructuredGridAlgorithm vtkExtractGrid::Superclass

Definition at line 55 of file vtkExtractGrid.h.

Constructor & Destructor Documentation

vtkExtractGrid::vtkExtractGrid ( )
protected
vtkExtractGrid::~vtkExtractGrid ( )
inlineprotected

Definition at line 90 of file vtkExtractGrid.h.

Member Function Documentation

static vtkExtractGrid* vtkExtractGrid::New ( )
static
static int vtkExtractGrid::IsTypeOf ( const char *  type)
static
virtual int vtkExtractGrid::IsA ( const char *  type)
virtual
static vtkExtractGrid* vtkExtractGrid::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkExtractGrid::NewInstanceInternal ( ) const
protectedvirtual
vtkExtractGrid* vtkExtractGrid::NewInstance ( ) const
void vtkExtractGrid::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkExtractGrid::SetVOI ( int  ,
int  ,
int  ,
int  ,
int  ,
int   
)
virtual

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

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

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

virtual int* vtkExtractGrid::GetVOI ( )
virtual

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

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

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

virtual void vtkExtractGrid::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. Initial value is (1,1,1).

virtual void vtkExtractGrid::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. Initial value is (1,1,1).

virtual int* vtkExtractGrid::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. Initial value is (1,1,1).

virtual void vtkExtractGrid::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. Initial value is (1,1,1).

virtual void vtkExtractGrid::SetIncludeBoundary ( int  )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

virtual int vtkExtractGrid::GetIncludeBoundary ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

virtual void vtkExtractGrid::IncludeBoundaryOn ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

virtual void vtkExtractGrid::IncludeBoundaryOff ( )
virtual

Control whether to enforce that the "boundary" of the grid is output in the subsampling process. (This ivar only has effect when the SampleRate in any direction is not equal to 1.) When this ivar IncludeBoundary is on, the subsampling will always include the boundary of the grid even though the sample rate is not an even multiple of the grid dimensions. (By default IncludeBoundary is off.)

virtual int vtkExtractGrid::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkExtractGrid::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkExtractGrid::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Member Data Documentation

int vtkExtractGrid::VOI[6]
protected

Definition at line 96 of file vtkExtractGrid.h.

int vtkExtractGrid::SampleRate[3]
protected

Definition at line 97 of file vtkExtractGrid.h.

int vtkExtractGrid::IncludeBoundary
protected

Definition at line 98 of file vtkExtractGrid.h.


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