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

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

#include <vtkExtractRectilinearGrid.h>

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

List of all members.

Public Types

typedef vtkRectilinearGridAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkExtractRectilinearGridNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetVOI (int, int, int, int, int, int)
virtual void SetVOI (int[6])
virtual intGetVOI ()
virtual void GetVOI (int data[6])
virtual void SetSampleRate (int, int, int)
virtual void SetSampleRate (int[3])
virtual intGetSampleRate ()
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 (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkExtractRectilinearGrid ()
 ~vtkExtractRectilinearGrid ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
bool RequestDataImpl (int voi[6], vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Protected Attributes

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

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 40 of file vtkExtractRectilinearGrid.h.


Member Typedef Documentation

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

Definition at line 44 of file vtkExtractRectilinearGrid.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

virtual vtkObjectBase* vtkExtractRectilinearGrid::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

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.

Reimplemented in vtkPExtractRectilinearGrid.

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

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

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

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.)

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.)

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.)

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.

Reimplemented in vtkPExtractRectilinearGrid.

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

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

Reimplemented from vtkRectilinearGridAlgorithm.

Reimplemented in vtkPExtractRectilinearGrid.

bool vtkExtractRectilinearGrid::RequestDataImpl ( int  voi[6],
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected]

Implementation for RequestData using a specified VOI. This is because the parallel filter needs to muck around with the VOI to get spacing and partitioning to play nice.


Member Data Documentation

Definition at line 94 of file vtkExtractRectilinearGrid.h.

Definition at line 95 of file vtkExtractRectilinearGrid.h.

Definition at line 96 of file vtkExtractRectilinearGrid.h.

Definition at line 98 of file vtkExtractRectilinearGrid.h.


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