vtkExtractRectilinearGrid Class Reference

#include <vtkExtractRectilinearGrid.h>

Inheritance diagram for vtkExtractRectilinearGrid:

Inheritance graph
[legend]
Collaboration diagram for vtkExtractRectilinearGrid:

Collaboration graph
[legend]

List of all members.


Detailed Description

Extract a sub grid (VOI) from the structured rectilinear dataset.

vtkExtractRectilinearGrid rounds out the set of filters that extract a subgrid out of a larger structured data set. RIght now, this filter only supports extracting a VOI. In the future, it might support strides like the vtkExtract grid filter.

See also:
vtkExtractGrid vtkImageClip vtkGeometryFilter vtkExtractGeometry vtkExtractVOI vtkStructuredGridGeometryFilter
Tests:
vtkExtractRectilinearGrid (Tests)

Definition at line 36 of file vtkExtractRectilinearGrid.h.


Public Types

typedef vtkRectilinearGridAlgorithm 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])
virtual void SetIncludeBoundary (int)
virtual int GetIncludeBoundary ()
virtual void IncludeBoundaryOn ()
virtual void IncludeBoundaryOff ()

Static Public Member Functions

static vtkExtractRectilinearGridNew ()
static int IsTypeOf (const char *type)
static vtkExtractRectilinearGridSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkExtractRectilinearGrid ()
 ~vtkExtractRectilinearGrid ()
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

Member Typedef Documentation

Reimplemented from vtkRectilinearGridAlgorithm.

Definition at line 40 of file vtkExtractRectilinearGrid.h.


Constructor & Destructor Documentation

vtkExtractRectilinearGrid::vtkExtractRectilinearGrid (  )  [protected]

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

Definition at line 74 of file vtkExtractRectilinearGrid.h.


Member Function Documentation

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

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

Reimplemented from vtkRectilinearGridAlgorithm.

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

Reimplemented from vtkRectilinearGridAlgorithm.

static int vtkExtractRectilinearGrid::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 vtkRectilinearGridAlgorithm.

virtual int vtkExtractRectilinearGrid::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 vtkRectilinearGridAlgorithm.

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

Reimplemented from vtkRectilinearGridAlgorithm.

void vtkExtractRectilinearGrid::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 vtkRectilinearGridAlgorithm.

virtual void vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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* vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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* vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 void vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::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 vtkExtractRectilinearGrid::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkRectilinearGridAlgorithm.

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

Reimplemented from vtkRectilinearGridAlgorithm.

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

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

Reimplemented from vtkRectilinearGridAlgorithm.


Member Data Documentation

int vtkExtractRectilinearGrid::VOI[6] [protected]

Definition at line 80 of file vtkExtractRectilinearGrid.h.

Definition at line 81 of file vtkExtractRectilinearGrid.h.

Definition at line 82 of file vtkExtractRectilinearGrid.h.


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

Generated on Sat Dec 27 13:24:45 2008 for VTK by  doxygen 1.5.6