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

Tests:: vtkMarchingSquares (Tests)

Definition at line 51 of file vtkMarchingSquares.h.


Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
unsigned long int	GetMTime ()
void	SetLocator (vtkIncrementalPointLocator *locator)
virtual vtkIncrementalPointLocator *	GetLocator ()
void	CreateDefaultLocator ()

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, double value)
double	GetValue (int i)
double *	GetValues ()
void	GetValues (double *contourValues)
void	SetNumberOfContours (int number)
int	GetNumberOfContours ()
void	GenerateValues (int numContours, double range[2])
void	GenerateValues (int numContours, double rangeStart, double rangeEnd)
Static Public Member Functions
static vtkMarchingSquares *	New ()
static int	IsTypeOf (const char *type)
static vtkMarchingSquares *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkMarchingSquares ()
	~vtkMarchingSquares ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	FillInputPortInformation (int port, vtkInformation *info)
Protected Attributes
vtkContourValues *	ContourValues
int	ImageRange [6]
vtkIncrementalPointLocator *	Locator

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkMarchingSquares::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 55 of file vtkMarchingSquares.h.

Constructor & Destructor Documentation

vtkMarchingSquares::vtkMarchingSquares ( ) [protected]

vtkMarchingSquares::~vtkMarchingSquares ( ) [protected]

Member Function Documentation

static vtkMarchingSquares* vtkMarchingSquares::New ( ) [static]

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

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

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

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]`

Methods to set contour values

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

Definition at line 110 of file vtkMarchingSquares.h.

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

Get the ith contour value.

Definition at line 116 of file vtkMarchingSquares.h.

double * vtkMarchingSquares::GetValues ( ) [inline]

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

Definition at line 123 of file vtkMarchingSquares.h.

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 131 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 139 of file vtkMarchingSquares.h.

int vtkMarchingSquares::GetNumberOfContours ( ) [inline]

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

Definition at line 145 of file vtkMarchingSquares.h.

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 152 of file vtkMarchingSquares.h.

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 159 of file vtkMarchingSquares.h.

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

Because we delegate to vtkContourValues

Reimplemented from vtkObject.

void vtkMarchingSquares::SetLocator ( vtkIncrementalPointLocator * locator )

virtual vtkIncrementalPointLocator* 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.

virtual int vtkMarchingSquares::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkMarchingSquares::FillInputPortInformation	(	int	port,
		vtkInformation *	info
	)			`[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 vtkPolyDataAlgorithm.