Documentation for vtkContourFilter

vtkContourFilter - generate isosurfaces/isolines from scalar values

Super Class: vtkDataSetToPolyDataFilter

Description:

vtkContourFilter is a filter that takes as input any dataset and generates on output isosurfaces and/or isolines. The exact form of the output depends upon the dimensionality of the input data. Data consisting of 3D cells will generate isosurfaces, data consisting of 2D cells will generate isolines, and data with 1D or 0D cells will generate isopoints. Combinations of output type are possible if the input dimension is mixed. This filter will identify special dataset types (e.g., structured points) and use the appropriate specialized filter to process the data. For examples, if the input dataset type is a volume, this filter will create an internal vtkMarchingCubes instance and use it. This gives much better performance. To use this filter you must specify one or more contour values. You can either use the method SetValue() to specify each contour value, or use GenerateValues() to generate a series of evenly spaced contours. It is also possible to accelerate the operation of this filter (at the cost of extra memory) by using a vtkScalarTree. A scalar tree is used to quickly locate cells that contain a contour surface. This is especially effective if multiple contours are being extracted. If you want to use a scalar tree, invoke the method UseScalarTreeOn().

 

Caveats:

For unstructured data or structured grids, normals and gradients are not computed. This calculation will be implemented in the future. In the mean time, use vtkPolyDataNormals to compute the surface normals.

 

See Also:

vtkMarchingCubes vtkSliceCubes vtkDividingCubes vtkMarchingSquares

 

Methods:

void vtkContourFilter ()
void vtkContourFilter ()
const char *GetClassName ()
void PrintSelf (unknown & ,vtkIndent )
static vtkContourFilter *New ()
void SetValue (int ,float )
float GetValue (int )
float *GetValues ()
void GetValues (float *)
void SetNumberOfContours (int )
int GetNumberOfContours ()
void GenerateValues (int ,float )
void GenerateValues (int ,float ,float )
unsigned long GetMTime ()
void SetComputeNormals (int )
int GetComputeNormals ()
void ComputeNormalsOn ()
void ComputeNormalsOff ()
void SetComputeGradients (int )
int GetComputeGradients ()
void ComputeGradientsOn ()
void ComputeGradientsOff ()
void SetComputeScalars (int )
int GetComputeScalars ()
void ComputeScalarsOn ()
void ComputeScalarsOff ()
void SetUseScalarTree (int )
int GetUseScalarTree ()
void UseScalarTreeOn ()
void UseScalarTreeOff ()
void SetLocator (vtkPointLocator *)
vtkPointLocator *GetLocator ()
void CreateDefaultLocator ()
void SetLocator (vtkPointLocator &)
void Execute ()
void StructuredPointsContour (int )

 

Detailed Method Descriptions:

Construct object with initial range (0,1) and single contour value of 0.0.

static vtkContourFilter *New ()

Methods to set / get contour values.

void SetValue (int ,float )
float GetValue (int )
float *GetValues ()
void GetValues (float *)
void SetNumberOfContours (int )
int GetNumberOfContours ()
void GenerateValues (int ,float )
void GenerateValues (int ,float ,float )

Modified GetMTime Because we delegate to vtkContourValues

unsigned long GetMTime ()

Set/Get the computation of normals. Normal computation is failrly expensive in both time and storage. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

void SetComputeNormals (int )
int GetComputeNormals ()
void ComputeNormalsOn ()
void ComputeNormalsOff ()

Set/Get the computation of gradients. Gradient computation is fairly expensive in both time and storage. Note that if ComputeNormals is on, gradients will have to be calculated, but will not be stored in the output dataset. If the output data will be processed by filters that modify topology or geometry, it may be wise to turn Normals and Gradients off.

void SetComputeGradients (int )
int GetComputeGradients ()
void ComputeGradientsOn ()
void ComputeGradientsOff ()

Set/Get the computation of scalars.

void SetComputeScalars (int )
int GetComputeScalars ()
void ComputeScalarsOn ()
void ComputeScalarsOff ()

Enable the use of a scalar tree to accelerate contour extraction.

void SetUseScalarTree (int )
int GetUseScalarTree ()
void UseScalarTreeOn ()
void UseScalarTreeOff ()

Set / get a spatial locator for merging points. By default, an instance of vtkMergePoints is used.

void SetLocator (vtkPointLocator *)
vtkPointLocator *GetLocator ()

Create default locator. Used to create one when none is specified. The locator is used to merge coincident points.

void CreateDefaultLocator ()

For legacy compatibility. Do not use.

void SetLocator (vtkPointLocator &)