select piece (e.g., volume of interest) and/or subsample structured grid dataset More...
#include <vtkExtractGrid.h>
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.
- Examples:
- vtkExtractGrid (Examples)
- Tests:
- vtkExtractGrid (Tests)
Definition at line 51 of file vtkExtractGrid.h.
Member Typedef Documentation
Reimplemented from vtkStructuredGridAlgorithm.
Definition at line 55 of file vtkExtractGrid.h.
Constructor & Destructor Documentation
| vtkExtractGrid::vtkExtractGrid | ( | ) | [protected] |
| vtkExtractGrid::~vtkExtractGrid | ( | ) | [inline, protected] |
Definition at line 90 of file vtkExtractGrid.h.
Member Function Documentation
| static vtkExtractGrid* vtkExtractGrid::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkStructuredGridAlgorithm.
| static int vtkExtractGrid::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 vtkStructuredGridAlgorithm.
| virtual int vtkExtractGrid::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 vtkStructuredGridAlgorithm.
| static vtkExtractGrid* vtkExtractGrid::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
Reimplemented from vtkStructuredGridAlgorithm.
| virtual vtkObjectBase* vtkExtractGrid::NewInstanceInternal | ( | ) | const [protected, virtual] |
Reimplemented from vtkStructuredGridAlgorithm.
| vtkExtractGrid* vtkExtractGrid::NewInstance | ( | ) | const |
Reimplemented from vtkStructuredGridAlgorithm.
| void vtkExtractGrid::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 vtkStructuredGridAlgorithm.
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 * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkStructuredGridAlgorithm.
| virtual int vtkExtractGrid::RequestInformation | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
Reimplemented from vtkStructuredGridAlgorithm.
| virtual int vtkExtractGrid::RequestUpdateExtent | ( | vtkInformation * | , |
| vtkInformationVector ** | , | ||
| vtkInformationVector * | |||
| ) | [protected, virtual] |
This is called by the superclass. This is the method you should override.
Reimplemented from vtkStructuredGridAlgorithm.
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:
- dox/Filters/Extraction/vtkExtractGrid.h
