generate filled contours for vtkPolyData More...

#include <vtkBandedPolyDataContourFilter.h>

Inheritance diagram for vtkBandedPolyDataContourFilter:

Collaboration diagram for vtkBandedPolyDataContourFilter:

Public Types
typedef vtkPolyDataAlgorithm	Superclass
Public Member Functions
virtual int	IsA (const char *type)
vtkBandedPolyDataContourFilter *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
vtkPolyData *	GetContourEdgesOutput ()
unsigned long	GetMTime ()

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)

virtual void	SetClipping (int)
virtual int	GetClipping ()
virtual void	ClippingOn ()
virtual void	ClippingOff ()

virtual void	SetScalarMode (int)
virtual int	GetScalarMode ()
void	SetScalarModeToIndex ()
void	SetScalarModeToValue ()

virtual void	SetGenerateContourEdges (int)
virtual int	GetGenerateContourEdges ()
virtual void	GenerateContourEdgesOn ()
virtual void	GenerateContourEdgesOff ()

virtual void	SetClipTolerance (double)
virtual double	GetClipTolerance ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkBandedPolyDataContourFilter *	SafeDownCast (vtkObjectBase *o)
static vtkBandedPolyDataContourFilter *	New ()
Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkBandedPolyDataContourFilter ()
	~vtkBandedPolyDataContourFilter ()
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
int	ComputeScalarIndex (double)
int	IsContourValue (double val)
int	ClipEdge (int v1, int v2, vtkPoints pts, vtkDataArray inScalars, vtkDoubleArray outScalars, vtkPointData inPD, vtkPointData *outPD)
int	InsertCell (vtkCellArray cells, int npts, vtkIdType pts, int cellId, double s, vtkFloatArray *newS)
Protected Attributes
vtkContourValues *	ContourValues
int	Clipping
int	ScalarMode
double *	ClipValues
int	NumberOfClipValues
int	ClipIndex [2]
double	ClipTolerance
double	InternalClipTolerance
int	GenerateContourEdges

Detailed Description

generate filled contours for vtkPolyData

vtkBandedPolyDataContourFilter is a filter that takes as input vtkPolyData and produces as output filled contours (also represented as vtkPolyData). Filled contours are bands of cells that all have the same cell scalar value, and can therefore be colored the same. The method is also referred to as filled contour generation.

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. Each contour value divides (or clips) the data into two pieces, values below the contour value, and values above it. The scalar values of each band correspond to the specified contour value. Note that if the first and last contour values are not the minimum/maximum contour range, then two extra contour values are added corresponding to the minimum and maximum range values. These extra contour bands can be prevented from being output by turning clipping on.

See also:: vtkClipDataSet vtkClipPolyData vtkClipVolume vtkContourFilter

Examples:: vtkBandedPolyDataContourFilter (Examples)

Tests:: vtkBandedPolyDataContourFilter (Tests)

Definition at line 64 of file vtkBandedPolyDataContourFilter.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkBandedPolyDataContourFilter::Superclass

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 67 of file vtkBandedPolyDataContourFilter.h.

Constructor & Destructor Documentation

vtkBandedPolyDataContourFilter::vtkBandedPolyDataContourFilter ( ) [protected]

vtkBandedPolyDataContourFilter::~vtkBandedPolyDataContourFilter ( ) [protected]

Member Function Documentation

static int vtkBandedPolyDataContourFilter::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 vtkBandedPolyDataContourFilter::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 vtkBandedPolyDataContourFilter* vtkBandedPolyDataContourFilter::SafeDownCast ( vtkObjectBase * o ) [static]

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkBandedPolyDataContourFilter::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

vtkBandedPolyDataContourFilter* vtkBandedPolyDataContourFilter::NewInstance ( ) const

Reimplemented from vtkPolyDataAlgorithm.

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

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

Construct object with no contours defined.

Reimplemented from vtkPolyDataAlgorithm.

void vtkBandedPolyDataContourFilter::SetValue	(	int	i,
		double	value
	)		`[inline]`

Methods to set / get contour values. A single value at a time can be set with SetValue(). Multiple contour values can be set with GenerateValues(). Note that GenerateValues() generates n values inclusive of the start and end range values.

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

Definition at line 176 of file vtkBandedPolyDataContourFilter.h.

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

Get the ith contour value.

Definition at line 182 of file vtkBandedPolyDataContourFilter.h.

double * vtkBandedPolyDataContourFilter::GetValues ( ) [inline]

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

Definition at line 189 of file vtkBandedPolyDataContourFilter.h.

void vtkBandedPolyDataContourFilter::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 197 of file vtkBandedPolyDataContourFilter.h.

void vtkBandedPolyDataContourFilter::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 205 of file vtkBandedPolyDataContourFilter.h.

int vtkBandedPolyDataContourFilter::GetNumberOfContours ( ) [inline]

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

Definition at line 211 of file vtkBandedPolyDataContourFilter.h.

void vtkBandedPolyDataContourFilter::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 218 of file vtkBandedPolyDataContourFilter.h.

void vtkBandedPolyDataContourFilter::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 226 of file vtkBandedPolyDataContourFilter.h.

virtual void vtkBandedPolyDataContourFilter::SetClipping ( int ) [virtual]

Indicate whether to clip outside the range specified by the user. (The range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified are not sent to the output.

virtual int vtkBandedPolyDataContourFilter::GetClipping ( ) [virtual]

Indicate whether to clip outside the range specified by the user. (The range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified are not sent to the output.

virtual void vtkBandedPolyDataContourFilter::ClippingOn ( ) [virtual]

Indicate whether to clip outside the range specified by the user. (The range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified are not sent to the output.

virtual void vtkBandedPolyDataContourFilter::ClippingOff ( ) [virtual]

Indicate whether to clip outside the range specified by the user. (The range is contour value[0] to contour value[numContours-1].) Clipping means all cells outside of the range specified are not sent to the output.

virtual void vtkBandedPolyDataContourFilter::SetScalarMode ( int ) [virtual]

Control whether the cell scalars are output as an integer index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a scalar value which is a value between clip values is used.

virtual int vtkBandedPolyDataContourFilter::GetScalarMode ( ) [virtual]

Control whether the cell scalars are output as an integer index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a scalar value which is a value between clip values is used.

void vtkBandedPolyDataContourFilter::SetScalarModeToIndex ( ) [inline]

Control whether the cell scalars are output as an integer index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a scalar value which is a value between clip values is used.

Definition at line 105 of file vtkBandedPolyDataContourFilter.h.

void vtkBandedPolyDataContourFilter::SetScalarModeToValue ( ) [inline]

Control whether the cell scalars are output as an integer index or a scalar value. If an index, the index refers to the bands produced by the clipping range. If a value, then a scalar value which is a value between clip values is used.

Definition at line 107 of file vtkBandedPolyDataContourFilter.h.

virtual void vtkBandedPolyDataContourFilter::SetGenerateContourEdges ( int ) [virtual]

Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).

virtual int vtkBandedPolyDataContourFilter::GetGenerateContourEdges ( ) [virtual]

Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).

virtual void vtkBandedPolyDataContourFilter::GenerateContourEdgesOn ( ) [virtual]

Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).

virtual void vtkBandedPolyDataContourFilter::GenerateContourEdgesOff ( ) [virtual]

Turn on/off a flag to control whether contour edges are generated. Contour edges are the edges between bands. If enabled, they are generated from polygons/triangle strips and placed into the second output (the ContourEdgesOutput).

virtual void vtkBandedPolyDataContourFilter::SetClipTolerance ( double ) [virtual]

Set/Get the clip tolerance. Warning: setting this too large will certainly cause numerical issues. Change from the default value of FLT_EPSILON at your own risk. The actual internal clip tolerance is computed by multiplying ClipTolerance by the scalar range.

virtual double vtkBandedPolyDataContourFilter::GetClipTolerance ( ) [virtual]

Set/Get the clip tolerance. Warning: setting this too large will certainly cause numerical issues. Change from the default value of FLT_EPSILON at your own risk. The actual internal clip tolerance is computed by multiplying ClipTolerance by the scalar range.

vtkPolyData* vtkBandedPolyDataContourFilter::GetContourEdgesOutput ( )

Get the second output which contains the edges dividing the contour bands. This output is empty unless GenerateContourEdges is enabled.

unsigned long vtkBandedPolyDataContourFilter::GetMTime ( ) [virtual]

Overload GetMTime because we delegate to vtkContourValues so its modified time must be taken into account.

Reimplemented from vtkObject.

int vtkBandedPolyDataContourFilter::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.

int vtkBandedPolyDataContourFilter::ComputeScalarIndex ( double ) [protected]

int vtkBandedPolyDataContourFilter::IsContourValue ( double val ) [protected]

int vtkBandedPolyDataContourFilter::ClipEdge	(	int	v1,
		int	v2,
		vtkPoints *	pts,
		vtkDataArray *	inScalars,
		vtkDoubleArray *	outScalars,
		vtkPointData *	inPD,
		vtkPointData *	outPD
	)		`[protected]`

int vtkBandedPolyDataContourFilter::InsertCell	(	vtkCellArray *	cells,
		int	npts,
		vtkIdType *	pts,
		int	cellId,
		double	s,
		vtkFloatArray *	newS
	)		`[protected]`