adjust point positions using constrained smoothing More...

#include <vtkConstrainedSmoothingFilter.h>

Inheritance diagram for vtkConstrainedSmoothingFilter:

Collaboration diagram for vtkConstrainedSmoothingFilter:

Public Types
enum	ConstraintStrategyType { DEFAULT = 0 , CONSTRAINT_DISTANCE = 1 , CONSTRAINT_BOX = 2 , CONSTRAINT_ARRAY = 3 }
Public Types inherited from vtkPointSetAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
enum	DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
	Values used for setting the desired output precision for various algorithms. More...
typedef vtkObject	Superclass

Public Member Functions

virtual void	SetNumberOfIterations (int)
	Specify the maximum number of iterations for smoothing.
virtual int	GetNumberOfIterations ()
	Specify the maximum number of iterations for smoothing.

virtual void	SetRelaxationFactor (double)
	Specify the relaxation factor for smoothing.
virtual double	GetRelaxationFactor ()
	Specify the relaxation factor for smoothing.

virtual void	SetConstraintStrategy (int)
	Indicate how to apply constraints.
virtual int	GetConstraintStrategy ()
	Indicate how to apply constraints.
void	SetConstraintStrategyToDefault ()
	Indicate how to apply constraints.
void	SetConstraintStrategyToConstraintDistance ()
	Indicate how to apply constraints.
void	SetConstraintStrategyToConstraintBox ()
	Indicate how to apply constraints.
void	SetConstraintStrategyToConstraintArray ()
	Indicate how to apply constraints.

virtual void	SetConstraintDistance (double)
	Specify a constraint distance for point motion (this defines a a local constraint sphere which is placed around each point to restrict its motion).
virtual double	GetConstraintDistance ()
	Specify a constraint distance for point motion (this defines a a local constraint sphere which is placed around each point to restrict its motion).

virtual void	SetConstraintBox (double, double, double)
	Specify a constraint box for point motion.
virtual void	SetConstraintBox (double[3])
	Specify a constraint box for point motion.
virtual double *	GetConstraintBox ()
	Specify a constraint box for point motion.
virtual void	GetConstraintBox (double data[3])
	Specify a constraint box for point motion.

virtual void	SetSmoothingStencils (vtkCellArray *)
	Set / get the point smoothing stencils.
virtual vtkCellArray *	GetSmoothingStencils ()
	Set / get the point smoothing stencils.

virtual void	SetGenerateErrorScalars (bool)
	Turn on/off the generation of scalar distance values.
virtual bool	GetGenerateErrorScalars ()
	Turn on/off the generation of scalar distance values.
virtual void	GenerateErrorScalarsOn ()
	Turn on/off the generation of scalar distance values.
virtual void	GenerateErrorScalarsOff ()
	Turn on/off the generation of scalar distance values.

virtual void	SetGenerateErrorVectors (bool)
	Turn on/off the generation of error vectors.
virtual bool	GetGenerateErrorVectors ()
	Turn on/off the generation of error vectors.
virtual void	GenerateErrorVectorsOn ()
	Turn on/off the generation of error vectors.
virtual void	GenerateErrorVectorsOff ()
	Turn on/off the generation of error vectors.

virtual void	SetOutputPointsPrecision (int)
	Set/get the desired precision for the output types.
virtual int	GetOutputPointsPrecision ()
	Set/get the desired precision for the output types.
Public Member Functions inherited from vtkPointSetAlgorithm
vtkPointSetAlgorithm *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.
vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.
vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.
vtkDataObject *	GetInput ()
vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details
vtkPointSet *	GetOutput ()
	Get the output data object for a port on this algorithm.
vtkPointSet *	GetOutput (int)
	Get the output data object for a port on this algorithm.
void	SetInputData (vtkDataObject *)
	Assign a data object as input.
void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.
void	SetInputData (vtkPointSet *)
	Assign a data object as input.
void	SetInputData (int, vtkPointSet *)
	Assign a data object as input.
void	AddInputData (vtkDataObject *)
	Assign a data object as input.
void	AddInputData (vtkPointSet *)
	Assign a data object as input.
void	AddInputData (int, vtkPointSet *)
	Assign a data object as input.
void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
vtkTypeBool	HasExecutive ()
	Check whether this algorithm has an assigned executive.
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.
vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.
virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.
virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.
vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.
int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.
int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.
void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.
void	UpdateProgress (double amount)
	Update the progress of the process object.
bool	CheckAbort ()
	Checks to see if this filter should abort.
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.
void	RemoveAllInputs ()
	Remove all the input data.
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.
vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.
virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.
virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.
virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.
vtkAlgorithmOutput *	GetOutputPort ()
int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.
int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0).
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0).
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.
virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).
virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.
virtual VTK_UNBLOCKTHREADS void	UpdateInformation ()
	Bring the algorithm's information up-to-date.
virtual void	UpdateDataObject ()
	Create output object(s).
virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.
virtual VTK_UNBLOCKTHREADS void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.
virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.
bool	UsesGarbageCollector () const override
	Participate in garbage collection.
virtual void	SetAbortExecute (vtkTypeBool)
	Set/Get the AbortExecute flag for the process object.
virtual vtkTypeBool	GetAbortExecute ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOn ()
	Set/Get the AbortExecute flag for the process object.
virtual void	AbortExecuteOff ()
	Set/Get the AbortExecute flag for the process object.
virtual double	GetProgress ()
	Get the execution progress of a process object.
void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.
vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.
virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.
virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.
void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.
virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.
virtual unsigned long	GetErrorCode ()
	The error code contains a possible error that occurred while reading or writing the file.
void	SetInputArrayToProcess (const char *name, int fieldAssociation)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	Set the input data arrays that this algorithm will process.
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.
virtual VTK_UNBLOCKTHREADS void	Update (int port)
	Bring this algorithm's outputs up-to-date.
virtual VTK_UNBLOCKTHREADS void	Update ()
	Bring this algorithm's outputs up-to-date.
virtual void	SetReleaseDataFlag (vtkTypeBool)
	Turn release data flag on or off for all output ports.
virtual vtkTypeBool	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.
void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.
int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.
int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.
int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.
void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.
int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.
int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.
void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)
virtual void	DebugOn ()
	Turn debugging output on.
virtual void	DebugOff ()
	Turn debugging output off.
bool	GetDebug ()
	Get the value of the debug flag.
void	SetDebug (bool debugFlag)
	Set the value of the debug flag.
virtual void	Modified ()
	Update the modification time for this object.
virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
vtkTypeBool	HasObserver (unsigned long event)
vtkTypeBool	HasObserver (const char *event)
vtkTypeBool	InvokeEvent (unsigned long event)
vtkTypeBool	InvokeEvent (const char *event)
std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
template<class U, class T>
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.
vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.
vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.
virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.
virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.
virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
virtual void	Delete ()
	Delete a VTK object.
virtual void	FastDelete ()
	Delete a reference to this object.
void	InitializeObjectBase ()
void	Print (ostream &os)
	Print an object to an ostream.
void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).
virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).
int	GetReferenceCount ()
	Return the current reference count of this object.
void	SetReferenceCount (int)
	Sets the reference count.
bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

Protected Member Functions
	vtkConstrainedSmoothingFilter ()
	~vtkConstrainedSmoothingFilter () override=default
int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called by the superclass.
Protected Member Functions inherited from vtkPointSetAlgorithm
	vtkPointSetAlgorithm ()
	~vtkPointSetAlgorithm () override=default
virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called by the superclass.
virtual int	ExecuteInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
virtual int	ComputeInputUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )
int	FillOutputPortInformation (int port, vtkInformation *info) override
int	FillInputPortInformation (int port, vtkInformation *info) override
virtual int	ComputeInputUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called by the superclass.
Protected Member Functions inherited from vtkObject
	vtkObject ()
	~vtkObject () override
void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events.
void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	ReportReferences (vtkGarbageCollector *)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
double	Convergence
int	NumberOfIterations
double	RelaxationFactor
int	ConstraintStrategy
double	ConstraintDistance
double	ConstraintBox [3]
vtkSmartPointer< vtkCellArray >	SmoothingStencils
bool	GenerateErrorScalars
bool	GenerateErrorVectors
int	OutputPointsPrecision
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
std::string	ObjectName
Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkPointSetAlgorithm	Superclass
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
static vtkConstrainedSmoothingFilter *	New ()
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
static vtkConstrainedSmoothingFilter *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
vtkConstrainedSmoothingFilter *	NewInstance () const
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
virtual void	SetConvergence (double)
	Specify a convergence criterion for the iteration process.
virtual double	GetConvergence ()
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiation, to obtain type information, and print the state of a class instance.

Additional Inherited Members
Static Public Member Functions inherited from vtkPointSetAlgorithm
static vtkPointSetAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkPointSetAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
static vtkInformationIntegerKey *	ABORTED ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.
static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.
Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.
static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
Public Attributes inherited from vtkAlgorithm
enum vtkAlgorithm::DesiredOutputPrecision	RemoveNoPriorTemporalAccessInformationKey
std::atomic< vtkTypeBool >	AbortExecute
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

adjust point positions using constrained smoothing

vtkConstrainedSmoothingFilter is a filter that adjusts point coordinates using a modified Laplacian smoothing approach. The effect is to "relax" or "smooth" the mesh, making the cells better shaped and the points more evenly distributed. Note that this filter operates on any vtkPointSet and derived classes. Cell topology is never modified; note however if the constraints are too lax, cells may self-intersect or otherwise be deformed in unfavorable ways.

A central concept of this filter is the point smoothing stencil. A smoothing stencil for a point pi is the list of points pj which connect to pi via an edge. To smooth the point pi, pi is moved towards the average position of pj multiplied by the relaxation factor, and limited by the constraint distance. This process is repeated either until convergence occurs, or the maximum number of iterations is reached. Note that smoothing stencils may be specified; or if not provided, the stencils are computed from the input cells connected edges (using vtkExtractEdges with UseAllPoints enabled).

To constrain the motion of the points, either set the filter's constraint distance or constraint box, or provide an input point data array (of type vtkDoubleArray) named "SmoothingConstraints." The filter's constraint distance (or constraint box if selected) defines a local sphere (or box) centered on each point to restrict point motion and is applied to all points; whereas the smoothing data array may have different constraint values per point. If provided by the user, by default the smoothing data array takes precedence over the filter's constraint distance and constraint box.

Warning: The smoothing process reduces high frequency information in the geometry of the mesh. With excessive smoothing important details may be lost, and the surface may shrink towards the centroid. The constraints on point movement help significantly in preventing shrinkage from happening.; This filter is used internally by the filters vtkSurfaceNets2D and vtkSurfaceNets3D. vtkConstrainedSmoothingFilter is used by these filters to smooth the extracted surface net, with the constraint distance and constraint box set in relation to a volume voxel.

See also: vtkWindowedSincPolyDataFilter vtkSmoothPolyDataFilter vtkAttributeSmoothingFilter vtkExtractEdges vtkSurfaceNets2D vtkSurfaceNets3D

Tests:: vtkConstrainedSmoothingFilter (Tests)

Definition at line 64 of file vtkConstrainedSmoothingFilter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPointSetAlgorithm vtkConstrainedSmoothingFilter::Superclass

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

Definition at line 73 of file vtkConstrainedSmoothingFilter.h.

Member Enumeration Documentation

◆ ConstraintStrategyType

enum vtkConstrainedSmoothingFilter::ConstraintStrategyType

Enumerator
DEFAULT
CONSTRAINT_DISTANCE
CONSTRAINT_BOX
CONSTRAINT_ARRAY

Definition at line 110 of file vtkConstrainedSmoothingFilter.h.

Constructor & Destructor Documentation

◆ vtkConstrainedSmoothingFilter()

vtkConstrainedSmoothingFilter::vtkConstrainedSmoothingFilter ( )

protected

◆ ~vtkConstrainedSmoothingFilter()

vtkConstrainedSmoothingFilter::~vtkConstrainedSmoothingFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ New()

vtkConstrainedSmoothingFilter * vtkConstrainedSmoothingFilter::New ( )

static

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

◆ IsTypeOf()

vtkTypeBool vtkConstrainedSmoothingFilter::IsTypeOf ( const char * type )

static

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

◆ IsA()

virtual vtkTypeBool vtkConstrainedSmoothingFilter::IsA ( const char * type )

virtual

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

Reimplemented from vtkPointSetAlgorithm.

◆ SafeDownCast()

vtkConstrainedSmoothingFilter * vtkConstrainedSmoothingFilter::SafeDownCast ( vtkObjectBase * o )

static

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkConstrainedSmoothingFilter::NewInstanceInternal ( ) const

protectedvirtual

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

Reimplemented from vtkPointSetAlgorithm.

◆ NewInstance()

vtkConstrainedSmoothingFilter * vtkConstrainedSmoothingFilter::NewInstance ( ) const

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

◆ PrintSelf()

void vtkConstrainedSmoothingFilter::PrintSelf	(	ostream &	os,
		vtkIndent	indent )

overridevirtual

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

Reimplemented from vtkAlgorithm.

◆ SetConvergence()

virtual void vtkConstrainedSmoothingFilter::SetConvergence ( double )

virtual

Specify a convergence criterion for the iteration process.

Smaller numbers result in more smoothing iterations. Convergence occurs when, for the current iteration, the maximum distance any point moves is less than or equal to Convergence. The default value is 0.

◆ GetConvergence()

virtual double vtkConstrainedSmoothingFilter::GetConvergence ( )

virtual

Standard methods for instantiation, to obtain type information, and print the state of a class instance.

◆ SetNumberOfIterations()

virtual void vtkConstrainedSmoothingFilter::SetNumberOfIterations ( int )

virtual

Specify the maximum number of iterations for smoothing.

The number of iterations may be less if the smoothing process converges. The default value is 10.

◆ GetNumberOfIterations()

virtual int vtkConstrainedSmoothingFilter::GetNumberOfIterations ( )

virtual

Specify the maximum number of iterations for smoothing.

The number of iterations may be less if the smoothing process converges. The default value is 10.

◆ SetRelaxationFactor()

virtual void vtkConstrainedSmoothingFilter::SetRelaxationFactor ( double )

virtual

Specify the relaxation factor for smoothing.

As in all iterative methods, the stability of the process is sensitive to this parameter. In general, small relaxation factors and large numbers of iterations are more stable than larger relaxation factors and smaller numbers of iterations. The default value is 0.01.

◆ GetRelaxationFactor()

virtual double vtkConstrainedSmoothingFilter::GetRelaxationFactor ( )

virtual

Specify the relaxation factor for smoothing.

As in all iterative methods, the stability of the process is sensitive to this parameter. In general, small relaxation factors and large numbers of iterations are more stable than larger relaxation factors and smaller numbers of iterations. The default value is 0.01.

◆ SetConstraintStrategy()

virtual void vtkConstrainedSmoothingFilter::SetConstraintStrategy ( int )

virtual

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

◆ GetConstraintStrategy()

virtual int vtkConstrainedSmoothingFilter::GetConstraintStrategy ( )

virtual

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

◆ SetConstraintStrategyToDefault()

void vtkConstrainedSmoothingFilter::SetConstraintStrategyToDefault ( )

inline

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

Definition at line 135 of file vtkConstrainedSmoothingFilter.h.

◆ SetConstraintStrategyToConstraintDistance()

void vtkConstrainedSmoothingFilter::SetConstraintStrategyToConstraintDistance ( )

inline

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

Definition at line 136 of file vtkConstrainedSmoothingFilter.h.

◆ SetConstraintStrategyToConstraintBox()

void vtkConstrainedSmoothingFilter::SetConstraintStrategyToConstraintBox ( )

inline

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

Definition at line 140 of file vtkConstrainedSmoothingFilter.h.

◆ SetConstraintStrategyToConstraintArray()

void vtkConstrainedSmoothingFilter::SetConstraintStrategyToConstraintArray ( )

inline

Indicate how to apply constraints.

By default, a constraint array takes precedence over the filter's constraint distance or constraint box, but if not available then the constraint distance is used. If a CONSTRAINT_ARRAY strategy is specified, and no constraint array is available from the point data, then the points are unconstrained. If the strategy is set to CONSTRAINT_DISTANCE, then a constraint sphere defined by ConstraintDistance is used; while setting the strategy to CONSTRAINT_BOX an axis-aligned x-y-z box is used to constrain point motion (using constraint distance is slightly faster than using a constraint box). Note that is also possible to turn off constraints completely by simply specifying a very large constraint distance. The default constraint strategy is DEFAULT.

Definition at line 141 of file vtkConstrainedSmoothingFilter.h.

◆ SetConstraintDistance()

virtual void vtkConstrainedSmoothingFilter::SetConstraintDistance ( double )

virtual

Specify a constraint distance for point motion (this defines a a local constraint sphere which is placed around each point to restrict its motion).

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint distance is 0.001. Setting the constraint strategy to CONSTRAINT_DISTANCE forces the box to be used.

◆ GetConstraintDistance()

virtual double vtkConstrainedSmoothingFilter::GetConstraintDistance ( )

virtual

Specify a constraint distance for point motion (this defines a a local constraint sphere which is placed around each point to restrict its motion).

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint distance is 0.001. Setting the constraint strategy to CONSTRAINT_DISTANCE forces the box to be used.

◆ SetConstraintBox() [1/2]

virtual void vtkConstrainedSmoothingFilter::SetConstraintBox	(	double	,
		double	,
		double	)

virtual

Specify a constraint box for point motion.

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint box is (1,1,1). Setting the constraint strategy to CONSTRAINT_BOX forces the box to be used.

◆ SetConstraintBox() [2/2]

virtual void vtkConstrainedSmoothingFilter::SetConstraintBox ( double [3] )

virtual

Specify a constraint box for point motion.

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint box is (1,1,1). Setting the constraint strategy to CONSTRAINT_BOX forces the box to be used.

◆ GetConstraintBox() [1/2]

virtual double * vtkConstrainedSmoothingFilter::GetConstraintBox ( )

virtual

Specify a constraint box for point motion.

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint box is (1,1,1). Setting the constraint strategy to CONSTRAINT_BOX forces the box to be used.

◆ GetConstraintBox() [2/2]

virtual void vtkConstrainedSmoothingFilter::GetConstraintBox ( double data[3] )

virtual

Specify a constraint box for point motion.

By default, if a point data array constraint distance (named "SmoothingConstraints") is provided in the input point data, then the array takes precedence. By default, the constraint box is (1,1,1). Setting the constraint strategy to CONSTRAINT_BOX forces the box to be used.

◆ SetSmoothingStencils()

virtual void vtkConstrainedSmoothingFilter::SetSmoothingStencils ( vtkCellArray * )

virtual

Set / get the point smoothing stencils.

Here we are repurposing a cell array to define stencils. Basically what's happening is that each point is treated a "cell" connected to a list of point ids (i.e., the "stencil") that defines the smoothing edge connections. By default, no smoothing stencils are defined.

◆ GetSmoothingStencils()

virtual vtkCellArray * vtkConstrainedSmoothingFilter::GetSmoothingStencils ( )

virtual

Set / get the point smoothing stencils.

Here we are repurposing a cell array to define stencils. Basically what's happening is that each point is treated a "cell" connected to a list of point ids (i.e., the "stencil") that defines the smoothing edge connections. By default, no smoothing stencils are defined.

◆ SetGenerateErrorScalars()

virtual void vtkConstrainedSmoothingFilter::SetGenerateErrorScalars ( bool )

virtual

Turn on/off the generation of scalar distance values.

By default, the generation of error scalars is disabled.

◆ GetGenerateErrorScalars()

virtual bool vtkConstrainedSmoothingFilter::GetGenerateErrorScalars ( )

virtual

Turn on/off the generation of scalar distance values.

By default, the generation of error scalars is disabled.

◆ GenerateErrorScalarsOn()

virtual void vtkConstrainedSmoothingFilter::GenerateErrorScalarsOn ( )

virtual

Turn on/off the generation of scalar distance values.

By default, the generation of error scalars is disabled.

◆ GenerateErrorScalarsOff()

virtual void vtkConstrainedSmoothingFilter::GenerateErrorScalarsOff ( )

virtual

Turn on/off the generation of scalar distance values.

By default, the generation of error scalars is disabled.

◆ SetGenerateErrorVectors()

virtual void vtkConstrainedSmoothingFilter::SetGenerateErrorVectors ( bool )

virtual

Turn on/off the generation of error vectors.

By default, the generation of error vectors is disabled.

◆ GetGenerateErrorVectors()

virtual bool vtkConstrainedSmoothingFilter::GetGenerateErrorVectors ( )

virtual

Turn on/off the generation of error vectors.

By default, the generation of error vectors is disabled.

◆ GenerateErrorVectorsOn()

virtual void vtkConstrainedSmoothingFilter::GenerateErrorVectorsOn ( )

virtual

Turn on/off the generation of error vectors.

By default, the generation of error vectors is disabled.

◆ GenerateErrorVectorsOff()

virtual void vtkConstrainedSmoothingFilter::GenerateErrorVectorsOff ( )

virtual

Turn on/off the generation of error vectors.

By default, the generation of error vectors is disabled.

◆ SetOutputPointsPrecision()

virtual void vtkConstrainedSmoothingFilter::SetOutputPointsPrecision ( int )

virtual

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ GetOutputPointsPrecision()

virtual int vtkConstrainedSmoothingFilter::GetOutputPointsPrecision ( )

virtual

Set/get the desired precision for the output types.

See the documentation for the vtkAlgorithm::DesiredOutputPrecision enum for an explanation of the available precision settings.

◆ RequestData()

int vtkConstrainedSmoothingFilter::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *	)

overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPointSetAlgorithm.

Member Data Documentation

◆ Convergence

double vtkConstrainedSmoothingFilter::Convergence

protected

Definition at line 216 of file vtkConstrainedSmoothingFilter.h.

◆ NumberOfIterations

int vtkConstrainedSmoothingFilter::NumberOfIterations

protected

Definition at line 217 of file vtkConstrainedSmoothingFilter.h.

◆ RelaxationFactor

double vtkConstrainedSmoothingFilter::RelaxationFactor

protected

Definition at line 218 of file vtkConstrainedSmoothingFilter.h.

◆ ConstraintStrategy

int vtkConstrainedSmoothingFilter::ConstraintStrategy

protected

Definition at line 220 of file vtkConstrainedSmoothingFilter.h.

◆ ConstraintDistance

double vtkConstrainedSmoothingFilter::ConstraintDistance

protected

Definition at line 221 of file vtkConstrainedSmoothingFilter.h.

◆ ConstraintBox

double vtkConstrainedSmoothingFilter::ConstraintBox[3]

protected

Definition at line 222 of file vtkConstrainedSmoothingFilter.h.

◆ SmoothingStencils

vtkSmartPointer<vtkCellArray> vtkConstrainedSmoothingFilter::SmoothingStencils

protected

Definition at line 223 of file vtkConstrainedSmoothingFilter.h.

◆ GenerateErrorScalars

bool vtkConstrainedSmoothingFilter::GenerateErrorScalars

protected

Definition at line 225 of file vtkConstrainedSmoothingFilter.h.

◆ GenerateErrorVectors

bool vtkConstrainedSmoothingFilter::GenerateErrorVectors

protected

Definition at line 226 of file vtkConstrainedSmoothingFilter.h.

◆ OutputPointsPrecision

int vtkConstrainedSmoothingFilter::OutputPointsPrecision

protected

Definition at line 227 of file vtkConstrainedSmoothingFilter.h.

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

Filters/Core/vtkConstrainedSmoothingFilter.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ ConstraintStrategyType

Constructor & Destructor Documentation

◆ vtkConstrainedSmoothingFilter()

◆ ~vtkConstrainedSmoothingFilter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetConvergence()

◆ GetConvergence()

◆ SetNumberOfIterations()

◆ GetNumberOfIterations()

◆ SetRelaxationFactor()

◆ GetRelaxationFactor()

◆ SetConstraintStrategy()

◆ GetConstraintStrategy()

◆ SetConstraintStrategyToDefault()

◆ SetConstraintStrategyToConstraintDistance()

◆ SetConstraintStrategyToConstraintBox()

◆ SetConstraintStrategyToConstraintArray()

◆ SetConstraintDistance()

◆ GetConstraintDistance()

◆ SetConstraintBox() [1/2]

◆ SetConstraintBox() [2/2]

◆ GetConstraintBox() [1/2]

◆ GetConstraintBox() [2/2]

◆ SetSmoothingStencils()

◆ GetSmoothingStencils()

◆ SetGenerateErrorScalars()

◆ GetGenerateErrorScalars()

◆ GenerateErrorScalarsOn()

◆ GenerateErrorScalarsOff()

◆ SetGenerateErrorVectors()

◆ GetGenerateErrorVectors()

◆ GenerateErrorVectorsOn()

◆ GenerateErrorVectorsOff()

◆ SetOutputPointsPrecision()

◆ GetOutputPointsPrecision()

◆ RequestData()

Member Data Documentation

◆ Convergence

◆ NumberOfIterations

◆ RelaxationFactor

◆ ConstraintStrategy

◆ ConstraintDistance

◆ ConstraintBox

◆ SmoothingStencils

◆ GenerateErrorScalars

◆ GenerateErrorVectors

◆ OutputPointsPrecision