vtkMarchingSquares Class Reference

#include <vtkMarchingSquares.h>

Inheritance diagram for vtkMarchingSquares:

[legend]Collaboration diagram for vtkMarchingSquares:

[legend]List of all members.

Detailed Description

generate isoline(s) from structured points set

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

Created by:

Schroeder, Will

CVS contributions (if > 5%):

Schroeder, Will (61%)
Martin, Ken (11%)
Lorensen, Bill (7%)
Law, Charles (7%)

CVS logs (CVSweb):

.cxx (/Patented/vtkMarchingSquares.cxx)
.h (/Patented/vtkMarchingSquares.h)

Tests:: vtkMarchingSquares (Tests)

Definition at line 80 of file vtkMarchingSquares.h.

Public Types

typedef vtkPolyDataSource Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void SetValue (int i, double value)

void GetValues (double *contourValues)

void SetNumberOfContours (int number)

unsigned long int GetMTime ()

void SetLocator (vtkPointLocator *locator)

virtual vtkPointLocator * GetLocator ()

void CreateDefaultLocator ()

void SetInput (vtkImageData *input)

vtkImageData * GetInput ()

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)

double GetValue (int i)

double * GetValues ()

int GetNumberOfContours ()

void GenerateValues (int numContours, double range[2])

void GenerateValues (int numContours, double rangeStart, double rangeEnd)

Static Public Member Functions

vtkMarchingSquares * New ()

int IsTypeOf (const char *type)

vtkMarchingSquares * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkMarchingSquares ()

~vtkMarchingSquares ()

void Execute ()

virtual int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

vtkContourValues * ContourValues

int ImageRange [6]

vtkPointLocator * Locator

Member Typedef Documentation

typedef vtkPolyDataSource vtkMarchingSquares::Superclass

Reimplemented from vtkPolyDataSource.
Definition at line 84 of file vtkMarchingSquares.h.

Constructor & Destructor Documentation

vtkMarchingSquares::vtkMarchingSquares ( ) [protected]

vtkMarchingSquares::~vtkMarchingSquares ( ) [protected]

Member Function Documentation

vtkMarchingSquares* vtkMarchingSquares::New ( ) [static]

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

virtual const char* vtkMarchingSquares::GetClassName ( ) [virtual]

Reimplemented from vtkPolyDataSource.

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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPolyDataSource.

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 vtkTypeRevisionMacro found in vtkSetGet.h.
Reimplemented from vtkPolyDataSource.

vtkMarchingSquares* vtkMarchingSquares::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPolyDataSource.

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

void vtkMarchingSquares::SetInput ( vtkImageData * input )

Set / get the input data or filter.

vtkImageData* vtkMarchingSquares::GetInput ( )

Set / get the input data or filter.

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]

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 void vtkMarchingSquares::GetImageRange ( int data[6] ) [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.

void vtkMarchingSquares::SetImageRange ( int imin,

int imax,

int jmin,

int jmax,

int kmin,

int kmax

)

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.

void vtkMarchingSquares::SetValue ( int i,

double value

) [inline]

Set a particular contour value at contour number i. The index i ranges between 0<=i<NumberOfContours.
Definition at line 142 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::SetValue().

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

Get the ith contour value.
Definition at line 147 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::GetValue().

double * 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.
References ContourValues, and vtkContourValues::GetValues().

void vtkMarchingSquares::GetValues ( double * 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 161 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::GetValues().

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 167 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::SetNumberOfContours().

int vtkMarchingSquares::GetNumberOfContours ( ) [inline]

Get the number of contours in the list of contour values.
Definition at line 172 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::GetNumberOfContours().

void vtkMarchingSquares::GenerateValues ( int numContours,

double range[2]

) [inline]

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
Definition at line 179 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::GenerateValues().

void vtkMarchingSquares::GenerateValues ( int numContours,

double rangeStart,

double rangeEnd

) [inline]

Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.
Definition at line 186 of file vtkMarchingSquares.h.
References ContourValues, and vtkContourValues::GenerateValues().

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

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

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

This method is the old style execute method
Reimplemented from vtkSource.

virtual int vtkMarchingSquares::FillInputPortInformation ( int ,

vtkInformation *

) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.
Reimplemented from vtkProcessObject.

Member Data Documentation

vtkContourValues* vtkMarchingSquares::ContourValues [protected]

Definition at line 130 of file vtkMarchingSquares.h.
Referenced by GenerateValues(), GetNumberOfContours(), GetValue(), GetValues(), SetNumberOfContours(), and SetValue().

int vtkMarchingSquares::ImageRange[6] [protected]

Definition at line 131 of file vtkMarchingSquares.h.

vtkPointLocator* vtkMarchingSquares::Locator [protected]

Definition at line 132 of file vtkMarchingSquares.h.

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

dox/Patented/vtkMarchingSquares.h


Public Types
typedef vtkPolyDataSource	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetValue (int i, double value)
void	GetValues (double *contourValues)
void	SetNumberOfContours (int number)
unsigned long int	GetMTime ()
void	SetLocator (vtkPointLocator *locator)
virtual vtkPointLocator *	GetLocator ()
void	CreateDefaultLocator ()

void	SetInput (vtkImageData *input)
vtkImageData *	GetInput ()

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)

double	GetValue (int i)

double *	GetValues ()

int	GetNumberOfContours ()

void	GenerateValues (int numContours, double range[2])

void	GenerateValues (int numContours, double rangeStart, double rangeEnd)
Static Public Member Functions
vtkMarchingSquares *	New ()
int	IsTypeOf (const char *type)
vtkMarchingSquares *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkMarchingSquares ()
	~vtkMarchingSquares ()
void	Execute ()
virtual int	FillInputPortInformation (int, vtkInformation *)
Protected Attributes
vtkContourValues *	ContourValues
int	ImageRange [6]
vtkPointLocator *	Locator