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

vtkMarchingSquares Class Reference

generate isoline(s) from structured points set. More...

#include <vtkMarchingSquares.h>

Inheritance diagram for vtkMarchingSquares:

Inheritance graph
[legend]
Collaboration diagram for vtkMarchingSquares:

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)
virtual void SetImageRange (int data[])
virtual int * GetImageRange ()
virtual void GetImageRange (int data[6])
void SetImageRange (int imin, int imax, int jmin, int jmax, int kmin, int kmax)
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 int GetMTime ()
void SetLocator (vtkPointLocator *locator)
virtual vtkPointLocator * GetLocator ()
void CreateDefaultLocator ()
void SetLocator (vtkPointLocator &locator)

Static Public Methods

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

Protected Methods

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

Protected Attributes

vtkContourValues * ContourValues
int ImageRange [6]
vtkPointLocator * Locator

Detailed Description

generate isoline(s) from structured points set.

Date:
2000/12/10 20:09:16
Revision:
1.28

vtkMarchingSquares is a filter that takes as input a structured points set and generates on output one or more isolines. One or more contour values must be specified to generate the isolines. Alternatively, you can specify a min/max scalar range and the number of contours to generate a series of evenly spaced contour values.

To generate contour lines the input data must be of topological dimension 2 (i.e., an image). If not, you can use the ImageRange ivar to select an image plane from an input volume. This avoids having to extract a plane first (using vtkExtractSubVolume). The filter deals with this by first trying to use the input data directly, and if not a 2D image, then uses the ImageRange ivar to reduce it to an image.

Warning:
This filter is specialized to images. If you are interested in contouring other types of data, use the general vtkContourFilter.
See also:
vtkContourFilter vtkMarchingCubes vtkSliceCubes vtkDividingCubes
Examples:
vtkMarchingSquares (examples)

Definition at line 88 of file vtkMarchingSquares.h.

Constructor & Destructor Documentation

vtkMarchingSquares::vtkMarchingSquares (    )  [protected]
 

vtkMarchingSquares::~vtkMarchingSquares (    )  [protected]
 

vtkMarchingSquares::vtkMarchingSquares (  const vtkMarchingSquares &    )  [inline, protected]
 

Definition at line 133 of file vtkMarchingSquares.h.

Member Function Documentation

vtkMarchingSquares* vtkMarchingSquares::New (    )  [static]
 

Instantiate object with no start, end, or progress methods.

Reimplemented from vtkPolyDataSource.

virtual const char* vtkMarchingSquares::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 vtkStructuredPointsToPolyDataFilter.

int vtkMarchingSquares::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 vtkStructuredPointsToPolyDataFilter.

virtual int vtkMarchingSquares::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 vtkStructuredPointsToPolyDataFilter.

vtkMarchingSquares* vtkMarchingSquares::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 vtkStructuredPointsToPolyDataFilter.

void vtkMarchingSquares::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.

virtual void vtkMarchingSquares::SetImageRange (  int    data[] )  [virtual]
 

Set/Get the i-j-k index range which define a plane on which to generate contour lines. Using this ivar it is possible to input a 3D volume directly and then generate contour lines on one of the i-j-k planes, or a portion of a plane.

virtual int* vtkMarchingSquares::GetImageRange (    )  [virtual]
 

virtual void vtkMarchingSquares::GetImageRange (  int    data[6] )  [virtual]
 

void vtkMarchingSquares::SetImageRange (  int    imin,
int    imax,
int    jmin,
int    jmax,
int    kmin,
int    kmax
) 
 

void vtkMarchingSquares::SetValue (  int    i,
float    value
)  [inline]
 

Set a particular contour value at contour number i. The index i ranges between 0<=i<NumberOfContours.

Definition at line 145 of file vtkMarchingSquares.h.

float vtkMarchingSquares::GetValue (  int    i )  [inline]
 

Get the ith contour value.

Definition at line 149 of file vtkMarchingSquares.h.

float * vtkMarchingSquares::GetValues (    )  [inline]
 

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

Definition at line 154 of file vtkMarchingSquares.h.

void vtkMarchingSquares::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 160 of file vtkMarchingSquares.h.

void vtkMarchingSquares::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 166 of file vtkMarchingSquares.h.

int vtkMarchingSquares::GetNumberOfContours (    )  [inline]
 

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

Definition at line 170 of file vtkMarchingSquares.h.

void vtkMarchingSquares::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 175 of file vtkMarchingSquares.h.

void vtkMarchingSquares::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 180 of file vtkMarchingSquares.h.

unsigned long int vtkMarchingSquares::GetMTime (    )  [virtual]
 

Return this object's modified time.

Reimplemented from vtkObject.

void vtkMarchingSquares::SetLocator (  vtkPointLocator *    locator ) 
 

virtual vtkPointLocator* vtkMarchingSquares::GetLocator (    )  [virtual]
 

void vtkMarchingSquares::CreateDefaultLocator (  void    ) 
 

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

void vtkMarchingSquares::SetLocator (  vtkPointLocator &    locator )  [inline]
 

Obsolete method for legacy compatibility. Do not use.

Definition at line 126 of file vtkMarchingSquares.h.

void vtkMarchingSquares::operator= (  const vtkMarchingSquares &    )  [inline, protected]
 

Definition at line 134 of file vtkMarchingSquares.h.

void vtkMarchingSquares::Execute (    )  [protected, virtual]
 

Reimplemented from vtkSource.

Member Data Documentation

vtkContourValues* vtkMarchingSquares::ContourValues [protected]
 

Definition at line 138 of file vtkMarchingSquares.h.

int vtkMarchingSquares::ImageRange[6] [protected]
 

Definition at line 139 of file vtkMarchingSquares.h.

vtkPointLocator* vtkMarchingSquares::Locator [protected]
 

Definition at line 140 of file vtkMarchingSquares.h.

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