Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkContourFilter Class Reference

generate isosurfaces/isolines from scalar values. More...

#include <vtkContourFilter.h>

Inheritance diagram for vtkContourFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkContourFilter:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetValue (int i, float value)
float GetValue (int i)
float * GetValues ()
void GetValues (float *contourValues)
void SetNumberOfContours (int number)
int GetNumberOfContours ()
void GenerateValues (int numContours, float range[2])
void GenerateValues (int numContours, float rangeStart, float rangeEnd)
unsigned long GetMTime ()
virtual void SetComputeNormals (int)
virtual int GetComputeNormals ()
virtual void ComputeNormalsOn ()
virtual void ComputeNormalsOff ()
virtual void SetComputeGradients (int)
virtual int GetComputeGradients ()
virtual void ComputeGradientsOn ()
virtual void ComputeGradientsOff ()
virtual void SetComputeScalars (int)
virtual int GetComputeScalars ()
virtual void ComputeScalarsOn ()
virtual void ComputeScalarsOff ()
virtual void SetUseScalarTree (int)
virtual int GetUseScalarTree ()
virtual void UseScalarTreeOn ()
virtual void UseScalarTreeOff ()
void SetLocator (vtkPointLocator *locator)
virtual vtkPointLocatorGetLocator ()
void CreateDefaultLocator ()
void SetLocator (vtkPointLocator &locator)

Static Public Methods

int IsTypeOf (const char *type)
vtkContourFilter * SafeDownCast (vtkObject *o)
vtkContourFilter * New ()

Protected Methods

 vtkContourFilter ()
 ~vtkContourFilter ()
 vtkContourFilter (const vtkContourFilter &)
void operator= (const vtkContourFilter &)
void Execute ()

Protected Attributes

vtkContourValuesContourValues
int ComputeNormals
int ComputeGradients
int ComputeScalars
vtkPointLocatorLocator
int UseScalarTree
vtkScalarTreeScalarTree

Detailed Description

generate isosurfaces/isolines from scalar values.

Date:
2000/12/10 20:08:32
Revision:
1.56

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.

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

If the input data is structured, consider using a filter that is optimized for structured data. These can be found in the patented classes of vtk.

Warning:
For unstructured data or structured grids, normals and gradients are not computed. Use vtkPolyDataNormals to compute the surface normals.
See also:
vtkMarchingContourFilter vtkKitwareContourFilter vtkMarchingCubes vtkSliceCubes vtkDividingCubes vtkMarchingSquares vtkImageMarchingCubes
Examples:
vtkContourFilter (examples)

Definition at line 89 of file vtkContourFilter.h.


Constructor & Destructor Documentation

vtkContourFilter::vtkContourFilter   [protected]
 

vtkContourFilter::~vtkContourFilter   [protected]
 

vtkContourFilter::vtkContourFilter const vtkContourFilter &    [inline, protected]
 

Definition at line 158 of file vtkContourFilter.h.


Member Function Documentation

virtual const char* vtkContourFilter::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

Reimplemented in vtkKitwareContourFilter.

int vtkContourFilter::IsTypeOf const char *    type [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 vtkDataSetToPolyDataFilter.

Reimplemented in vtkKitwareContourFilter.

virtual int vtkContourFilter::IsA const char *    type [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 vtkDataSetToPolyDataFilter.

Reimplemented in vtkKitwareContourFilter.

vtkContourFilter* vtkContourFilter::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetToPolyDataFilter.

Reimplemented in vtkKitwareContourFilter.

void vtkContourFilter::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 vtkSource.

vtkContourFilter* vtkContourFilter::New   [static]
 

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

Reimplemented from vtkPolyDataSource.

Reimplemented in vtkKitwareContourFilter.

void vtkContourFilter::SetValue int    i,
float    value
[inline]
 

Methods to set / get contour values.

Definition at line 175 of file vtkContourFilter.h.

float vtkContourFilter::GetValue int    i [inline]
 

Get the ith contour value.

Definition at line 179 of file vtkContourFilter.h.

float * vtkContourFilter::GetValues   [inline]
 

Get a pointer to an array of contour values. There will be GetNumberOfContours() values in the list.

Definition at line 184 of file vtkContourFilter.h.

void vtkContourFilter::GetValues float *    contourValues [inline]
 

Fill a supplied list with contour values. There will be GetNumberOfContours() values in the list. Make sure you allocate enough memory to hold the list.

Definition at line 190 of file vtkContourFilter.h.

void vtkContourFilter::SetNumberOfContours int    number [inline]
 

Set the number of contours to place into the list. You only really need to use this method to reduce list size. The method SetValue() will automatically increase list size as needed.

Definition at line 196 of file vtkContourFilter.h.

int vtkContourFilter::GetNumberOfContours   [inline]
 

Get the number of contours in the list of contour values.

Definition at line 200 of file vtkContourFilter.h.

void vtkContourFilter::GenerateValues int    numContours,
float    range[2]
[inline]
 

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

Definition at line 205 of file vtkContourFilter.h.

void vtkContourFilter::GenerateValues int    numContours,
float    rangeStart,
float    rangeEnd
[inline]
 

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

Definition at line 210 of file vtkContourFilter.h.

unsigned long vtkContourFilter::GetMTime   [virtual]
 

Modified GetMTime Because we delegate to vtkContourValues

Reimplemented from vtkObject.

virtual void vtkContourFilter::SetComputeNormals int    [virtual]
 

Set/Get the computation of normals. Normal computation is fairly 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.

virtual int vtkContourFilter::GetComputeNormals   [virtual]
 

virtual void vtkContourFilter::ComputeNormalsOn   [virtual]
 

virtual void vtkContourFilter::ComputeNormalsOff   [virtual]
 

virtual void vtkContourFilter::SetComputeGradients int    [virtual]
 

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.

virtual int vtkContourFilter::GetComputeGradients   [virtual]
 

virtual void vtkContourFilter::ComputeGradientsOn   [virtual]
 

virtual void vtkContourFilter::ComputeGradientsOff   [virtual]
 

virtual void vtkContourFilter::SetComputeScalars int    [virtual]
 

Set/Get the computation of scalars.

virtual int vtkContourFilter::GetComputeScalars   [virtual]
 

virtual void vtkContourFilter::ComputeScalarsOn   [virtual]
 

virtual void vtkContourFilter::ComputeScalarsOff   [virtual]
 

virtual void vtkContourFilter::SetUseScalarTree int    [virtual]
 

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

virtual int vtkContourFilter::GetUseScalarTree   [virtual]
 

virtual void vtkContourFilter::UseScalarTreeOn   [virtual]
 

virtual void vtkContourFilter::UseScalarTreeOff   [virtual]
 

void vtkContourFilter::SetLocator vtkPointLocator   locator
 

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

virtual vtkPointLocator* vtkContourFilter::GetLocator   [virtual]
 

void vtkContourFilter::CreateDefaultLocator void   
 

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

void vtkContourFilter::SetLocator vtkPointLocator   locator [inline]
 

For legacy compatibility. Do not use.

Definition at line 151 of file vtkContourFilter.h.

void vtkContourFilter::operator= const vtkContourFilter &    [inline, protected]
 

Definition at line 159 of file vtkContourFilter.h.

void vtkContourFilter::Execute   [protected, virtual]
 

Reimplemented from vtkSource.

Reimplemented in vtkKitwareContourFilter.


Member Data Documentation

vtkContourValues* vtkContourFilter::ContourValues [protected]
 

Definition at line 163 of file vtkContourFilter.h.

int vtkContourFilter::ComputeNormals [protected]
 

Definition at line 164 of file vtkContourFilter.h.

int vtkContourFilter::ComputeGradients [protected]
 

Definition at line 165 of file vtkContourFilter.h.

int vtkContourFilter::ComputeScalars [protected]
 

Definition at line 166 of file vtkContourFilter.h.

vtkPointLocator* vtkContourFilter::Locator [protected]
 

Definition at line 167 of file vtkContourFilter.h.

int vtkContourFilter::UseScalarTree [protected]
 

Definition at line 168 of file vtkContourFilter.h.

vtkScalarTree* vtkContourFilter::ScalarTree [protected]
 

Definition at line 169 of file vtkContourFilter.h.


The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:47:02 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001