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

# vtkWindowedSincPolyDataFilter Class Reference

`#include <vtkWindowedSincPolyDataFilter.h>`

Inheritance diagram for vtkWindowedSincPolyDataFilter:

[legend]
Collaboration diagram for vtkWindowedSincPolyDataFilter:

[legend]
List of all members.

## Detailed Description

adjust point positions using a windowed sinc function interpolation kernel

Date:
  2002/11/26 19:07:01

Revision:
  1.22

vtkWindowedSincPolyDataFiler adjust point coordinate using a windowed sinc function interpolation kernel. The effect is to "relax" the mesh, making the cells better shaped and the vertices more evenly distributed. Note that this filter operates the lines, polygons, and triangle strips composing an instance of vtkPolyData. Vertex or poly-vertex cells are never modified.

The algorithm proceeds as follows. For each vertex v, a topological and geometric analysis is performed to determine which vertices are connected to v, and which cells are connected to v. Then, a connectivity array is constructed for each vertex. (The connectivity array is a list of lists of vertices that directly attach to each vertex.) Next, an iteration phase begins over all vertices. For each vertex v, the coordinates of v are modified using a windowed sinc function interpolation kernel. Taubin describes this methodology is the IBM tech report RC-20404 (#90237, dated 3/12/96) "Optimal Surface Smoothing as Filter Design" G. Taubin, T. Zhang and G. Golub. (Zhang and Golub are at Stanford University).

This report discusses using standard signal processing low-pass filters (in particular windowed sinc functions) to smooth polyhedra. The transfer functions of the low-pass filters are approximated by Chebyshev polynomials. This facilitates applying the filters in an iterative diffusion process (as opposed to a kernel convolution). The more smoothing iterations applied, the higher the degree of polynomial approximating the low-pass filter transfer function. Each smoothing iteration, therefore, applies the next higher term of the Chebyshev filter approximation to the polyhedron. This decoupling of the filter into an iteratively applied polynomial is possible since the Chebyshev polynomials are orthogonal, i.e. increasing the order of the approximation to the filter transfer function does not alter the previously calculated coefficients for the low order terms.

Note: Care must be taken to avoid smoothing with too few iterations. A Chebyshev approximation with too few terms is an poor approximation. The first few smoothing iterations represent a severe scaling and translation of the data. Subsequent iterations cause the smoothed polyhedron to converge to the true location and scale of the object. We have attempted to protect against this by automatically adjusting the filter, effectively widening the pass band. This adjustment is only possible if the number of iterations is greater than 1. Note that this sacrifices some degree of smoothing for model integrity. For those interested, the filter is adjusted by searching for a value sigma such that the actual pass band is k_pb + sigma and such that the filter transfer function evaluates to unity at k_pb, i.e. f(k_pb) = 1

This implementation is currently limited to using an interpolation kernel based on Hamming windows. Other windows (such as Hann, Blackman, Kaiser, Lanczos, Gaussian, and exponential windows) could be used instead.

There are some special instance variables used to control the execution of this filter. (These ivars basically control what vertices can be smoothed, and the creation of the connectivity array.) The BoundarySmoothing ivar enables/disables the smoothing operation on vertices that are on the "boundary" of the mesh. A boundary vertex is one that is surrounded by a semi-cycle of polygons (or used by a single line).

Another important ivar is FeatureEdgeSmoothing. If this ivar is enabled, then interior vertices are classified as either "simple", "interior edge", or "fixed", and smoothed differently. (Interior vertices are manifold vertices surrounded by a cycle of polygons; or used by two line cells.) The classification is based on the number of feature edges attached to v. A feature edge occurs when the angle between the two surface normals of a polygon sharing an edge is greater than the FeatureAngle ivar. Then, vertices used by no feature edges are classified "simple", vertices used by exactly two feature edges are classified "interior edge", and all others are "fixed" vertices.

Once the classification is known, the vertices are smoothed differently. Corner (i.e., fixed) vertices are not smoothed at all. Simple vertices are smoothed as before . Interior edge vertices are smoothed only along their two connected edges, and only if the angle between the edges is less than the EdgeAngle ivar.

The total smoothing can be controlled by using two ivars. The NumberOfIterations determines the maximum number of smoothing passes. The NumberOfIterations corresponds to the degree of the polynomial that is used to approximate the windowed sinc function. Ten or twenty iterations is all the is usually necessary. Contrast this with vtkSmoothPolyDataFilter which usually requires 100 to 200 smoothing iterations. vtkSmoothPolyDataFilter is also not an approximation to an ideal low-pass filter, which can cause the geometry to shrink as the amount of smoothing increases.

The second ivar is the specification of the PassBand for the windowed sinc filter. By design, the PassBand is specified as a floating point number between 0 and 2. Lower PassBand values produce more smoothing. A good default value for the PassBand is 0.1 (for those interested, the PassBand (and frequencies) for PolyData are based on the valence of the vertices, this limits all the frequency modes in a polyhedral mesh to between 0 and 2.)

There are two instance variables that control the generation of error data. If the ivar GenerateErrorScalars is on, then a scalar value indicating the distance of each vertex from its original position is computed. If the ivar GenerateErrorVectors is on, then a vector representing change in position is computed.

Warning:
  The smoothing operation reduces high frequency information in the geometry of the mesh. With excessive smoothing important details may be lost. Enabling FeatureEdgeSmoothing helps reduce this effect, but cannot entirely eliminate it.

See also:
  vtkSmoothPolyDataFilter vtkDecimate vtkDecimatePro

Created by:
  - Miller, Jim

CVS contributions (if > 5%):
  - Miller, Jim (74%)
  - Lorensen, Bill (8%)
  - Henderson, Amy (8%)

CVS logs (CVSweb):
  - .`cxx` (`/Graphics/vtkWindowedSincPolyDataFilter.cxx)`
  - .`h` (`/Graphics/vtkWindowedSincPolyDataFilter.h)`

Tests:
  vtkWindowedSincPolyDataFilter (Tests)

Definition at line 153 of file vtkWindowedSincPolyDataFilter.h.

## Public Types

typedef vtkPolyDataToPolyDataFilter | Superclass

## Public Methods

virtual const char * | GetClassName ()
virtual int | IsA (const char *type)
void | PrintSelf (ostream &os, vtkIndent indent)
virtual void | SetNumberOfIterations (int)
virtual int | GetNumberOfIterations ()
virtual void | SetPassBand (float)
virtual float | GetPassBand ()
virtual void | SetFeatureEdgeSmoothing (int)
virtual int | GetFeatureEdgeSmoothing ()
virtual void | FeatureEdgeSmoothingOn ()
virtual void | FeatureEdgeSmoothingOff ()
virtual void | SetFeatureAngle (float)
virtual float | GetFeatureAngle ()
virtual void | SetEdgeAngle (float)
virtual float | GetEdgeAngle ()
virtual void | SetBoundarySmoothing (int)
virtual int | GetBoundarySmoothing ()
virtual void | BoundarySmoothingOn ()
virtual void | BoundarySmoothingOff ()
virtual void | SetNonManifoldSmoothing (int)
virtual int | GetNonManifoldSmoothing ()
virtual void | NonManifoldSmoothingOn ()
virtual void | NonManifoldSmoothingOff ()
virtual void | SetGenerateErrorScalars (int)
virtual int | GetGenerateErrorScalars ()
virtual void | GenerateErrorScalarsOn ()
virtual void | GenerateErrorScalarsOff ()
virtual void | SetGenerateErrorVectors (int)
virtual int | GetGenerateErrorVectors ()
virtual void | GenerateErrorVectorsOn ()
virtual void | GenerateErrorVectorsOff ()

## Static Public Methods

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

## Protected Methods

| vtkWindowedSincPolyDataFilter ()
| ~vtkWindowedSincPolyDataFilter ()
void | Execute ()

## Protected Attributes

int | NumberOfIterations
float | PassBand
int | FeatureEdgeSmoothing
float | FeatureAngle
float | EdgeAngle
int | BoundarySmoothing
int | NonManifoldSmoothing
int | GenerateErrorScalars
int | GenerateErrorVectors

## Member Typedef Documentation

typedef vtkPolyDataToPolyDataFilter vtkWindowedSincPolyDataFilter::Superclass

| Reimplemented from vtkPolyDataToPolyDataFilter. Definition at line 156 of file vtkWindowedSincPolyDataFilter.h.

## Constructor & Destructor Documentation

vtkWindowedSincPolyDataFilter::vtkWindowedSincPolyDataFilter | ( |  | ) | `[protected]`

vtkWindowedSincPolyDataFilter::~vtkWindowedSincPolyDataFilter | ( |  | ) | `[inline, protected]`

| Definition at line 229 of file vtkWindowedSincPolyDataFilter.h.

## Member Function Documentation

virtual const char* vtkWindowedSincPolyDataFilter::GetClassName | ( |  | ) | `[virtual]`

| Reimplemented from vtkPolyDataToPolyDataFilter.

int vtkWindowedSincPolyDataFilter::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 vtkPolyDataToPolyDataFilter.

virtual int vtkWindowedSincPolyDataFilter::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 vtkPolyDataToPolyDataFilter.

vtkWindowedSincPolyDataFilter* vtkWindowedSincPolyDataFilter::SafeDownCast | ( | vtkObject * | o | ) | `[static]`

| Reimplemented from vtkPolyDataToPolyDataFilter.

void vtkWindowedSincPolyDataFilter::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 vtkPolyDataToPolyDataFilter.

vtkWindowedSincPolyDataFilter* vtkWindowedSincPolyDataFilter::New | ( |  | ) | `[static]`

| Construct object with number of iterations 20; passband .1; feature edge smoothing turned off; feature angle 45 degrees; edge angle 15 degrees; and boundary smoothing turned on. Error scalars and vectors are not generated (by default). The convergence criterion is 0.0 of the bounding box diagonal. Reimplemented from vtkObject.

virtual void vtkWindowedSincPolyDataFilter::SetNumberOfIterations | ( | int |  | ) | `[virtual]`

| Specify the number of iterations (or degree of the polynomial approximating the windowed sinc function).

virtual int vtkWindowedSincPolyDataFilter::GetNumberOfIterations | ( |  | ) | `[virtual]`

| Specify the number of iterations (or degree of the polynomial approximating the windowed sinc function).

virtual void vtkWindowedSincPolyDataFilter::SetPassBand | ( | float |  | ) | `[virtual]`

| Set the passband value for the windowed sinc filter

virtual float vtkWindowedSincPolyDataFilter::GetPassBand | ( |  | ) | `[virtual]`

| Set the passband value for the windowed sinc filter

virtual void vtkWindowedSincPolyDataFilter::SetFeatureEdgeSmoothing | ( | int |  | ) | `[virtual]`

| Turn on/off smoothing along sharp interior edges.

virtual int vtkWindowedSincPolyDataFilter::GetFeatureEdgeSmoothing | ( |  | ) | `[virtual]`

| Turn on/off smoothing along sharp interior edges.

virtual void vtkWindowedSincPolyDataFilter::FeatureEdgeSmoothingOn | ( |  | ) | `[virtual]`

| Turn on/off smoothing along sharp interior edges.

virtual void vtkWindowedSincPolyDataFilter::FeatureEdgeSmoothingOff | ( |  | ) | `[virtual]`

| Turn on/off smoothing along sharp interior edges.

virtual void vtkWindowedSincPolyDataFilter::SetFeatureAngle | ( | float |  | ) | `[virtual]`

| Specify the feature angle for sharp edge identification.

virtual float vtkWindowedSincPolyDataFilter::GetFeatureAngle | ( |  | ) | `[virtual]`

| Specify the feature angle for sharp edge identification.

virtual void vtkWindowedSincPolyDataFilter::SetEdgeAngle | ( | float |  | ) | `[virtual]`

| Specify the edge angle to control smoothing along edges (either interior or boundary).

virtual float vtkWindowedSincPolyDataFilter::GetEdgeAngle | ( |  | ) | `[virtual]`

| Specify the edge angle to control smoothing along edges (either interior or boundary).

virtual void vtkWindowedSincPolyDataFilter::SetBoundarySmoothing | ( | int |  | ) | `[virtual]`

| Turn on/off the smoothing of vertices on the boundary of the mesh.

virtual int vtkWindowedSincPolyDataFilter::GetBoundarySmoothing | ( |  | ) | `[virtual]`

| Turn on/off the smoothing of vertices on the boundary of the mesh.

virtual void vtkWindowedSincPolyDataFilter::BoundarySmoothingOn | ( |  | ) | `[virtual]`

| Turn on/off the smoothing of vertices on the boundary of the mesh.

virtual void vtkWindowedSincPolyDataFilter::BoundarySmoothingOff | ( |  | ) | `[virtual]`

| Turn on/off the smoothing of vertices on the boundary of the mesh.

virtual void vtkWindowedSincPolyDataFilter::SetNonManifoldSmoothing | ( | int |  | ) | `[virtual]`

| Smooth non-manifold vertices.

virtual int vtkWindowedSincPolyDataFilter::GetNonManifoldSmoothing | ( |  | ) | `[virtual]`

| Smooth non-manifold vertices.

virtual void vtkWindowedSincPolyDataFilter::NonManifoldSmoothingOn | ( |  | ) | `[virtual]`

| Smooth non-manifold vertices.

virtual void vtkWindowedSincPolyDataFilter::NonManifoldSmoothingOff | ( |  | ) | `[virtual]`

| Smooth non-manifold vertices.

virtual void vtkWindowedSincPolyDataFilter::SetGenerateErrorScalars | ( | int |  | ) | `[virtual]`

| Turn on/off the generation of scalar distance values.

virtual int vtkWindowedSincPolyDataFilter::GetGenerateErrorScalars | ( |  | ) | `[virtual]`

| Turn on/off the generation of scalar distance values.

virtual void vtkWindowedSincPolyDataFilter::GenerateErrorScalarsOn | ( |  | ) | `[virtual]`

| Turn on/off the generation of scalar distance values.

virtual void vtkWindowedSincPolyDataFilter::GenerateErrorScalarsOff | ( |  | ) | `[virtual]`

| Turn on/off the generation of scalar distance values.

virtual void vtkWindowedSincPolyDataFilter::SetGenerateErrorVectors | ( | int |  | ) | `[virtual]`

| Turn on/off the generation of error vectors.

virtual int vtkWindowedSincPolyDataFilter::GetGenerateErrorVectors | ( |  | ) | `[virtual]`

| Turn on/off the generation of error vectors.

virtual void vtkWindowedSincPolyDataFilter::GenerateErrorVectorsOn | ( |  | ) | `[virtual]`

| Turn on/off the generation of error vectors.

virtual void vtkWindowedSincPolyDataFilter::GenerateErrorVectorsOff | ( |  | ) | `[virtual]`

| Turn on/off the generation of error vectors.

void vtkWindowedSincPolyDataFilter::Execute | ( |  | ) | `[protected, virtual]`

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

## Member Data Documentation

int vtkWindowedSincPolyDataFilter::NumberOfIterations`[protected]`

| Definition at line 233 of file vtkWindowedSincPolyDataFilter.h.

float vtkWindowedSincPolyDataFilter::PassBand`[protected]`

| Definition at line 234 of file vtkWindowedSincPolyDataFilter.h.

int vtkWindowedSincPolyDataFilter::FeatureEdgeSmoothing`[protected]`

| Definition at line 235 of file vtkWindowedSincPolyDataFilter.h.

float vtkWindowedSincPolyDataFilter::FeatureAngle`[protected]`

| Definition at line 236 of file vtkWindowedSincPolyDataFilter.h.

float vtkWindowedSincPolyDataFilter::EdgeAngle`[protected]`

| Definition at line 237 of file vtkWindowedSincPolyDataFilter.h.

int vtkWindowedSincPolyDataFilter::BoundarySmoothing`[protected]`

| Definition at line 238 of file vtkWindowedSincPolyDataFilter.h.

int vtkWindowedSincPolyDataFilter::NonManifoldSmoothing`[protected]`

| Definition at line 239 of file vtkWindowedSincPolyDataFilter.h.

int vtkWindowedSincPolyDataFilter::GenerateErrorScalars`[protected]`

| Definition at line 240 of file vtkWindowedSincPolyDataFilter.h.

int vtkWindowedSincPolyDataFilter::GenerateErrorVectors`[protected]`

| Definition at line 241 of file vtkWindowedSincPolyDataFilter.h.

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

- Graphics/vtkWindowedSincPolyDataFilter.h