Man Page for vtkMarchingSquares
Table of Contents

NAME

vtkMarchingSquares - generate isoline(s) from structured points set

SYNOPSIS


#include "/opt/vtk-c++/patented/vtkMarchingSquares.h"

class VTK_EXPORT vtkMarchingSquares : public vtkStructuredPointsToPolyDataFilter

vtkMarchingSquares();
static vtkMarchingSquares *New() {return new vtkMarchingSquares;};
~vtkMarchingSquares();
const char *GetClassName() {return "vtkMarchingSquares";};
void PrintSelf(ostream& os, vtkIndent indent);
void SetImageRange(int data[6]);
void SetImageRange(int *);
int *GetImageRange();
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);
void SetLocator(vtkPointLocator& locator) {this->SetLocator(&locator);};
vtkPointLocator *GetLocator();
void CreateDefaultLocator();

DESCRIPTION

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.

CAVEATS

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

SUMMARY

void SetImageRange(int data[6])
void SetImageRange(int *)
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 SetValue(int i, float value)
Create default locator. Used to create one when none is specified. The locator is used to merge coincident points. Set a particular contour value at contour number i. The index i ranges between 0<=i float GetValue(int i)
Get the ith contour value.

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

void GetValues(float *contourValues)
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.

void SetNumberOfContours(int number)
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.

int GetNumberOfContours()
Get the number of contours in the list of contour values.

void GenerateValues(int numContours, float range[2])
Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

void GenerateValues(int numContours, float
Generate numContours equally spaced contour values between specified range. Contour values will include min/max range values.

vtkMarchingSquares()
Construct object with initial scalar range (0,1) and single contour value of 0.0. The ImageRange are set to extract the first k-plane.

unsigned long GetMTime()
Overload standard modified time function. If contour values are modified, then this object is modified as well.

void SetLocator(vtkPointLocator *locator)
Specify a spatial locator for merging points. By default, an instance of vtkMergePoints is used.


Table of Contents