VTK  9.3.20240329
Public Types | Protected Member Functions | Protected Attributes | List of all members
vtkPointSmoothingFilter Class Reference

adjust point positions to form a pleasing, packed arrangement More...

#include <vtkPointSmoothingFilter.h>

Inheritance diagram for vtkPointSmoothingFilter:
[legend]
Collaboration diagram for vtkPointSmoothingFilter:
[legend]

Public Types

enum  {
  DEFAULT_SMOOTHING = 0 , GEOMETRIC_SMOOTHING , UNIFORM_SMOOTHING , SCALAR_SMOOTHING ,
  TENSOR_SMOOTHING , FRAME_FIELD_SMOOTHING
}
 Specify how smoothing is to be controlled. More...
 
enum  { UNCONSTRAINED_MOTION = 0 , PLANE_MOTION }
 Specify how point motion is to be constrained. More...
 
- 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 SetNeighborhoodSize (int)
 Specify the neighborhood size. More...
 
virtual int GetNeighborhoodSize ()
 Specify the neighborhood size. More...
 
virtual void SetSmoothingMode (int)
 Control how smoothing is to be performed. More...
 
virtual int GetSmoothingMode ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToDefault ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToGeometric ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToUniform ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToScalars ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToTensors ()
 Control how smoothing is to be performed. More...
 
void SetSmoothingModeToFrameField ()
 Control how smoothing is to be performed. More...
 
virtual void SetFrameFieldArray (vtkDataArray *)
 Specify the name of the frame field to use for smoothing. More...
 
virtual vtkDataArrayGetFrameFieldArray ()
 Specify the name of the frame field to use for smoothing. More...
 
virtual void SetNumberOfIterations (int)
 Specify the number of smoothing iterations. More...
 
virtual int GetNumberOfIterations ()
 Specify the number of smoothing iterations. More...
 
virtual void SetNumberOfSubIterations (int)
 Specify the number of smoothing subiterations. More...
 
virtual int GetNumberOfSubIterations ()
 Specify the number of smoothing subiterations. More...
 
virtual void SetMaximumStepSize (double)
 Specify the maximum smoothing step size for each smoothing iteration. More...
 
virtual double GetMaximumStepSize ()
 Specify the maximum smoothing step size for each smoothing iteration. More...
 
virtual void SetConvergence (double)
 Specify a convergence criterion for the iteration process. More...
 
virtual double GetConvergence ()
 Specify a convergence criterion for the iteration process. More...
 
virtual void SetEnableConstraints (bool)
 Enable or disable constraints on points. More...
 
virtual bool GetEnableConstraints ()
 Enable or disable constraints on points. More...
 
virtual void EnableConstraintsOn ()
 Enable or disable constraints on points. More...
 
virtual void EnableConstraintsOff ()
 Enable or disable constraints on points. More...
 
virtual void SetFixedAngle (double)
 Enable or disable constraints on points. More...
 
virtual double GetFixedAngle ()
 Enable or disable constraints on points. More...
 
virtual void SetBoundaryAngle (double)
 Enable or disable constraints on points. More...
 
virtual double GetBoundaryAngle ()
 Enable or disable constraints on points. More...
 
virtual void SetGenerateConstraintScalars (bool)
 If point constraints are enabled, an output scalar indicating the classification of points can be generated. More...
 
virtual bool GetGenerateConstraintScalars ()
 If point constraints are enabled, an output scalar indicating the classification of points can be generated. More...
 
virtual void GenerateConstraintScalarsOn ()
 If point constraints are enabled, an output scalar indicating the classification of points can be generated. More...
 
virtual void GenerateConstraintScalarsOff ()
 If point constraints are enabled, an output scalar indicating the classification of points can be generated. More...
 
virtual void SetGenerateConstraintNormals (bool)
 If point constraints are enabled, an output vector indicating the average normal at each point can be generated. More...
 
virtual bool GetGenerateConstraintNormals ()
 If point constraints are enabled, an output vector indicating the average normal at each point can be generated. More...
 
virtual void GenerateConstraintNormalsOn ()
 If point constraints are enabled, an output vector indicating the average normal at each point can be generated. More...
 
virtual void GenerateConstraintNormalsOff ()
 If point constraints are enabled, an output vector indicating the average normal at each point can be generated. More...
 
virtual void SetComputePackingRadius (bool)
 Enable / disable the computation of a packing radius. More...
 
virtual bool GetComputePackingRadius ()
 Enable / disable the computation of a packing radius. More...
 
virtual void ComputePackingRadiusOn ()
 Enable / disable the computation of a packing radius. More...
 
virtual void ComputePackingRadiusOff ()
 Enable / disable the computation of a packing radius. More...
 
virtual void SetPackingRadius (double)
 Specify the packing radius R. More...
 
virtual double GetPackingRadius ()
 Specify the packing radius R. More...
 
virtual void SetPackingFactor (double)
 Specify the packing factor. More...
 
virtual double GetPackingFactor ()
 Specify the packing factor. More...
 
virtual void SetAttractionFactor (double)
 Control the relative distance of inter-particle attraction. More...
 
virtual double GetAttractionFactor ()
 Control the relative distance of inter-particle attraction. More...
 
virtual void SetMotionConstraint (int)
 Specify how to constrain the motion of points. More...
 
virtual int GetMotionConstraint ()
 Specify how to constrain the motion of points. More...
 
void SetMotionConstraintToUnconstrained ()
 Specify how to constrain the motion of points. More...
 
void SetMotionConstraintToPlane ()
 Specify how to constrain the motion of points. More...
 
void SetPlane (vtkPlane *)
 Specify the plane to which point motion is constrained. More...
 
virtual vtkPlaneGetPlane ()
 Specify the plane to which point motion is constrained. More...
 
void SetLocator (vtkAbstractPointLocator *locator)
 Specify a point locator. More...
 
virtual vtkAbstractPointLocatorGetLocator ()
 Specify a point locator. More...
 
- Public Member Functions inherited from vtkPointSetAlgorithm
vtkPointSetAlgorithmNewInstance () const
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid. More...
 
vtkDataObjectGetInput ()
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkPointSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPointSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (vtkPointSet *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkPointSet *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkPointSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkPointSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
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. More...
 
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. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
bool CheckAbort ()
 Checks to see if this filter should abort. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
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). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
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. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual 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. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
bool UsesGarbageCollector () const override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm. More...
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm. More...
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports. More...
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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. More...
 
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. More...
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
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. More...
 
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. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS(). More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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. More...
 
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. More...
 
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. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
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). More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkPointSmoothingFilter ()
 
 ~vtkPointSmoothingFilter () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- 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. More...
 
virtual int ExecuteInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
virtual int ComputeInputUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
virtual int ComputeInputUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted. More...
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NeighborhoodSize
 
int SmoothingMode
 
int NumberOfIterations
 
int NumberOfSubIterations
 
double MaximumStepSize
 
double Convergence
 
vtkDataArrayFrameFieldArray
 
vtkAbstractPointLocatorLocator
 
bool EnableConstraints
 
double FixedAngle
 
double BoundaryAngle
 
bool GenerateConstraintScalars
 
bool GenerateConstraintNormals
 
bool ComputePackingRadius
 
double PackingRadius
 
double PackingFactor
 
double AttractionFactor
 
int MotionConstraint
 
vtkPlanePlane
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- 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, obtaining type information, and printing information. More...
 
static vtkPointSmoothingFilterNew ()
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
static vtkPointSmoothingFilterSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
vtkPointSmoothingFilterNewInstance () const
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, obtaining type information, and printing information. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, obtaining type information, and printing information. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkPointSetAlgorithm
static vtkPointSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPointSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- 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. More...
 
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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 
- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

adjust point positions to form a pleasing, packed arrangement

vtkPointSmoothingFilter modifies the coordinates of the input points of a vtkPointSet by adjusting their position to create a smooth distribution (and thereby form a pleasing packing of the points). Smoothing is performed by considering the effects of neighboring points on one another. Smoothing in its simplest form (geometric) is simply a variant of Laplacian smoothing where each point moves towards the average position of its neighboring points. Next, uniform smoothing uses a cubic cutoff function to produce repulsive forces between close points and attractive forces that are a little further away. Smoothing can be further controlled either by a scalar field, by a tensor field, or a frame field (the user can specify the nature of the smoothing operation). If controlled by a scalar field, then each input point is assumed to be surrounded by a isotropic sphere scaled by the scalar field; if controlled by a tensor field, then each input point is assumed to be surrounded by an anisotropic, oriented ellipsoid aligned to the the tensor eigenvectors and scaled by the determinate of the tensor. A frame field also assumes a surrounding, ellipsoidal shape except that the inversion of the ellipsoid tensor is already performed. Typical usage of this filter is to perform a smoothing (also referred to as packing) operation (i.e., first execute this filter) and then combine it with a glyph filter (e.g., vtkTensorGlyph or vtkGlyph3D) to visualize the packed points.

Smoothing depends on a local neighborhood of nearby points. In general, the larger the neighborhood size, the greater the reduction in high frequency information. (The memory and/or computational requirements of the algorithm may also significantly increase.) The PackingRadius (and PackingFactor) controls what points are considered close. The PackingRadius can be computed automatically, or specified by the user. (The product of PackingRadius*PackingFactor is referred to as the scaling factor alpha in the paper cited below. This provides a convenient way to combine automatic PackingRadius computation based on average between particle neighborhoods, and then adjust it with the PackingFactor.)

Any vtkPointSet type can be provided as input, and the output will contain the same number of new points each of which is adjusted to a new position.

Note that the algorithm requires the use of a spatial point locator. The point locator is used to build a local neighborhood of the points surrounding each point. It is also used to perform interpolation as the point positions are adjusted.

The algorithm incrementally adjusts the point positions through an iterative process. Basically points are moved due to the influence of neighboring points. Iterations continue until the specified number of iterations is reached, or convergence occurs. Convergence occurs when the maximum displacement of any point is less than the convergence value. As points move, both the local connectivity and data attributes associated with each point must be updated. Rather than performing these expensive operations after every iteration, a number of sub-iterations Si can be specified. If Si > 1, then the neighborhood and attribute value updates occur only every Si'th iteration. Using sub-iterations can improve performance significantly.

Warning
Geometric smoothing defines a one-sided attractive force between particles. Thus particles tend to clump together, and the entire set of points (with enough iterations and appropriate PackingRadius) can converge to a single position. This can be mitigated by turning on point constraints, which limit the movement of "boundary" points.
This class has been loosely inspired by the paper by Kindlmann and Westin "Diffusion Tensor Visualization with Glyph Packing". However, several computational shortcuts, and generalizations have been used for performance and utility reasons.
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.
See also
vtkTensorWidget vtkTensorGlyph vtkSmoothPolyDataFilter vtkGlyph3D
Tests:
vtkPointSmoothingFilter (Tests)

Definition at line 97 of file vtkPointSmoothingFilter.h.

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, obtaining type information, and printing information.

Definition at line 106 of file vtkPointSmoothingFilter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Specify how smoothing is to be controlled.

Enumerator
DEFAULT_SMOOTHING 
GEOMETRIC_SMOOTHING 
UNIFORM_SMOOTHING 
SCALAR_SMOOTHING 
TENSOR_SMOOTHING 
FRAME_FIELD_SMOOTHING 

Definition at line 122 of file vtkPointSmoothingFilter.h.

◆ anonymous enum

anonymous enum

Specify how point motion is to be constrained.

Enumerator
UNCONSTRAINED_MOTION 
PLANE_MOTION 

Definition at line 299 of file vtkPointSmoothingFilter.h.

Constructor & Destructor Documentation

◆ vtkPointSmoothingFilter()

vtkPointSmoothingFilter::vtkPointSmoothingFilter ( )
protected

◆ ~vtkPointSmoothingFilter()

vtkPointSmoothingFilter::~vtkPointSmoothingFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPointSmoothingFilter* vtkPointSmoothingFilter::New ( )
static

Standard methods for instantiation, obtaining type information, and printing information.

◆ IsTypeOf()

static vtkTypeBool vtkPointSmoothingFilter::IsTypeOf ( const char *  type)
static

Standard methods for instantiation, obtaining type information, and printing information.

◆ IsA()

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

Standard methods for instantiation, obtaining type information, and printing information.

Reimplemented from vtkPointSetAlgorithm.

◆ SafeDownCast()

static vtkPointSmoothingFilter* vtkPointSmoothingFilter::SafeDownCast ( vtkObjectBase o)
static

Standard methods for instantiation, obtaining type information, and printing information.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPointSmoothingFilter::NewInstanceInternal ( ) const
protectedvirtual

Standard methods for instantiation, obtaining type information, and printing information.

Reimplemented from vtkPointSetAlgorithm.

◆ NewInstance()

vtkPointSmoothingFilter* vtkPointSmoothingFilter::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing information.

◆ PrintSelf()

void vtkPointSmoothingFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

Standard methods for instantiation, obtaining type information, and printing information.

Reimplemented from vtkPointSetAlgorithm.

◆ SetNeighborhoodSize()

virtual void vtkPointSmoothingFilter::SetNeighborhoodSize ( int  )
virtual

Specify the neighborhood size.

This controls the number of surrounding points that can affect a point to be smoothed.

◆ GetNeighborhoodSize()

virtual int vtkPointSmoothingFilter::GetNeighborhoodSize ( )
virtual

Specify the neighborhood size.

This controls the number of surrounding points that can affect a point to be smoothed.

◆ SetSmoothingMode()

virtual void vtkPointSmoothingFilter::SetSmoothingMode ( int  )
virtual

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

◆ GetSmoothingMode()

virtual int vtkPointSmoothingFilter::GetSmoothingMode ( )
virtual

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

◆ SetSmoothingModeToDefault()

void vtkPointSmoothingFilter::SetSmoothingModeToDefault ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 145 of file vtkPointSmoothingFilter.h.

◆ SetSmoothingModeToGeometric()

void vtkPointSmoothingFilter::SetSmoothingModeToGeometric ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 146 of file vtkPointSmoothingFilter.h.

◆ SetSmoothingModeToUniform()

void vtkPointSmoothingFilter::SetSmoothingModeToUniform ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 147 of file vtkPointSmoothingFilter.h.

◆ SetSmoothingModeToScalars()

void vtkPointSmoothingFilter::SetSmoothingModeToScalars ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 148 of file vtkPointSmoothingFilter.h.

◆ SetSmoothingModeToTensors()

void vtkPointSmoothingFilter::SetSmoothingModeToTensors ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 149 of file vtkPointSmoothingFilter.h.

◆ SetSmoothingModeToFrameField()

void vtkPointSmoothingFilter::SetSmoothingModeToFrameField ( )
inline

Control how smoothing is to be performed.

By default, if a point frame field is available then frame field smoothing will be performed; then if point tensors are available then anisotropic tensor smoothing will be used; the next choice is to use isotropic scalar smoothing; and finally if no frame field, tensors, or scalars are available, uniform smoothing will be used. If both scalars, tensors, and /or a frame field are present, the user can specify which to use; or to use uniform or geometric smoothing.

Definition at line 150 of file vtkPointSmoothingFilter.h.

◆ SetFrameFieldArray()

virtual void vtkPointSmoothingFilter::SetFrameFieldArray ( vtkDataArray )
virtual

Specify the name of the frame field to use for smoothing.

This information is only necessary if a frame field smoothing is enabled.

◆ GetFrameFieldArray()

virtual vtkDataArray* vtkPointSmoothingFilter::GetFrameFieldArray ( )
virtual

Specify the name of the frame field to use for smoothing.

This information is only necessary if a frame field smoothing is enabled.

◆ SetNumberOfIterations()

virtual void vtkPointSmoothingFilter::SetNumberOfIterations ( int  )
virtual

Specify the number of smoothing iterations.

◆ GetNumberOfIterations()

virtual int vtkPointSmoothingFilter::GetNumberOfIterations ( )
virtual

Specify the number of smoothing iterations.

◆ SetNumberOfSubIterations()

virtual void vtkPointSmoothingFilter::SetNumberOfSubIterations ( int  )
virtual

Specify the number of smoothing subiterations.

This specifies the frequency of connectivity and data attribute updates.

◆ GetNumberOfSubIterations()

virtual int vtkPointSmoothingFilter::GetNumberOfSubIterations ( )
virtual

Specify the number of smoothing subiterations.

This specifies the frequency of connectivity and data attribute updates.

◆ SetMaximumStepSize()

virtual void vtkPointSmoothingFilter::SetMaximumStepSize ( double  )
virtual

Specify the maximum smoothing step size for each smoothing iteration.

This step size limits the the distance over which a point can move in each iteration. As in all iterative methods, the stability of the process is sensitive to this parameter. In general, small step size and large numbers of iterations are more stable than a larger step size and a smaller numbers of iterations.

◆ GetMaximumStepSize()

virtual double vtkPointSmoothingFilter::GetMaximumStepSize ( )
virtual

Specify the maximum smoothing step size for each smoothing iteration.

This step size limits the the distance over which a point can move in each iteration. As in all iterative methods, the stability of the process is sensitive to this parameter. In general, small step size and large numbers of iterations are more stable than a larger step size and a smaller numbers of iterations.

◆ SetConvergence()

virtual void vtkPointSmoothingFilter::SetConvergence ( double  )
virtual

Specify a convergence criterion for the iteration process.

Smaller numbers result in more smoothing iterations.

◆ GetConvergence()

virtual double vtkPointSmoothingFilter::GetConvergence ( )
virtual

Specify a convergence criterion for the iteration process.

Smaller numbers result in more smoothing iterations.

◆ SetEnableConstraints()

virtual void vtkPointSmoothingFilter::SetEnableConstraints ( bool  )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ GetEnableConstraints()

virtual bool vtkPointSmoothingFilter::GetEnableConstraints ( )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ EnableConstraintsOn()

virtual void vtkPointSmoothingFilter::EnableConstraintsOn ( )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ EnableConstraintsOff()

virtual void vtkPointSmoothingFilter::EnableConstraintsOff ( )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ SetFixedAngle()

virtual void vtkPointSmoothingFilter::SetFixedAngle ( double  )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ GetFixedAngle()

virtual double vtkPointSmoothingFilter::GetFixedAngle ( )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ SetBoundaryAngle()

virtual void vtkPointSmoothingFilter::SetBoundaryAngle ( double  )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ GetBoundaryAngle()

virtual double vtkPointSmoothingFilter::GetBoundaryAngle ( )
virtual

Enable or disable constraints on points.

Point constraints are used to prevent points from moving, or to move only on a plane. This can prevent shrinking or growing point clouds. If enabled, a local topological analysis is performed to determine whether a point should be marked "Fixed" i.e., never moves; "Plane", the point only moves on a plane; or "Unconstrained", the point can move freely. If all points in the neighborhood surrounding a point are in the cone defined by FixedAngle, then the point is classified "Fixed." If all points in the neighborhood surrounding a point are in the cone defined by BoundaryAngle, then the point is classified "Plane." (The angles are expressed in degrees.)

◆ SetGenerateConstraintScalars()

virtual void vtkPointSmoothingFilter::SetGenerateConstraintScalars ( bool  )
virtual

If point constraints are enabled, an output scalar indicating the classification of points can be generated.

◆ GetGenerateConstraintScalars()

virtual bool vtkPointSmoothingFilter::GetGenerateConstraintScalars ( )
virtual

If point constraints are enabled, an output scalar indicating the classification of points can be generated.

◆ GenerateConstraintScalarsOn()

virtual void vtkPointSmoothingFilter::GenerateConstraintScalarsOn ( )
virtual

If point constraints are enabled, an output scalar indicating the classification of points can be generated.

◆ GenerateConstraintScalarsOff()

virtual void vtkPointSmoothingFilter::GenerateConstraintScalarsOff ( )
virtual

If point constraints are enabled, an output scalar indicating the classification of points can be generated.

◆ SetGenerateConstraintNormals()

virtual void vtkPointSmoothingFilter::SetGenerateConstraintNormals ( bool  )
virtual

If point constraints are enabled, an output vector indicating the average normal at each point can be generated.

◆ GetGenerateConstraintNormals()

virtual bool vtkPointSmoothingFilter::GetGenerateConstraintNormals ( )
virtual

If point constraints are enabled, an output vector indicating the average normal at each point can be generated.

◆ GenerateConstraintNormalsOn()

virtual void vtkPointSmoothingFilter::GenerateConstraintNormalsOn ( )
virtual

If point constraints are enabled, an output vector indicating the average normal at each point can be generated.

◆ GenerateConstraintNormalsOff()

virtual void vtkPointSmoothingFilter::GenerateConstraintNormalsOff ( )
virtual

If point constraints are enabled, an output vector indicating the average normal at each point can be generated.

◆ SetComputePackingRadius()

virtual void vtkPointSmoothingFilter::SetComputePackingRadius ( bool  )
virtual

Enable / disable the computation of a packing radius.

By default, a packing radius is computed as one half of the average distance between neighboring points. (Point neighbors are defined by the neighborhood size.)

◆ GetComputePackingRadius()

virtual bool vtkPointSmoothingFilter::GetComputePackingRadius ( )
virtual

Enable / disable the computation of a packing radius.

By default, a packing radius is computed as one half of the average distance between neighboring points. (Point neighbors are defined by the neighborhood size.)

◆ ComputePackingRadiusOn()

virtual void vtkPointSmoothingFilter::ComputePackingRadiusOn ( )
virtual

Enable / disable the computation of a packing radius.

By default, a packing radius is computed as one half of the average distance between neighboring points. (Point neighbors are defined by the neighborhood size.)

◆ ComputePackingRadiusOff()

virtual void vtkPointSmoothingFilter::ComputePackingRadiusOff ( )
virtual

Enable / disable the computation of a packing radius.

By default, a packing radius is computed as one half of the average distance between neighboring points. (Point neighbors are defined by the neighborhood size.)

◆ SetPackingRadius()

virtual void vtkPointSmoothingFilter::SetPackingRadius ( double  )
virtual

Specify the packing radius R.

This only takes effect if ComputePackingRadius is off. Note that the for two points separated by radius r, a repulsive force is generated when 0<=r<=R, and a repulsive force when R<=r<=(1+AttractionFactor*R). By default, the PackingRadius is automatically computed, but when ComputePackingRadius is off, then manually setting the PackingRadius is allowed. Note that the PackingRadius is updated after the algorithm runs (useful to examine the computed packing radius).

◆ GetPackingRadius()

virtual double vtkPointSmoothingFilter::GetPackingRadius ( )
virtual

Specify the packing radius R.

This only takes effect if ComputePackingRadius is off. Note that the for two points separated by radius r, a repulsive force is generated when 0<=r<=R, and a repulsive force when R<=r<=(1+AttractionFactor*R). By default, the PackingRadius is automatically computed, but when ComputePackingRadius is off, then manually setting the PackingRadius is allowed. Note that the PackingRadius is updated after the algorithm runs (useful to examine the computed packing radius).

◆ SetPackingFactor()

virtual void vtkPointSmoothingFilter::SetPackingFactor ( double  )
virtual

Specify the packing factor.

Larger numbers tend to loosen the overall packing of points. Note however that if the point density in a region is high, then the packing factor may have little effect (due to mutual inter-particle constraints). The default value is 1.0. (Note that a characteristic inter-particle radius R is computed at the onset of the algorithm (or can be manually specified). Within 0<=r<=R*PackingFactor a repulsive force is generated.)

◆ GetPackingFactor()

virtual double vtkPointSmoothingFilter::GetPackingFactor ( )
virtual

Specify the packing factor.

Larger numbers tend to loosen the overall packing of points. Note however that if the point density in a region is high, then the packing factor may have little effect (due to mutual inter-particle constraints). The default value is 1.0. (Note that a characteristic inter-particle radius R is computed at the onset of the algorithm (or can be manually specified). Within 0<=r<=R*PackingFactor a repulsive force is generated.)

◆ SetAttractionFactor()

virtual void vtkPointSmoothingFilter::SetAttractionFactor ( double  )
virtual

Control the relative distance of inter-particle attraction.

A value of 1.0 means that the radius of the attraction region is the same as the radius of repulsion. By default, a value of 0.5 is used (e.g., in the region 0<=r<=R a repulsive force is generated, while in R<r<=R*1.5 an attractive force is generated).

◆ GetAttractionFactor()

virtual double vtkPointSmoothingFilter::GetAttractionFactor ( )
virtual

Control the relative distance of inter-particle attraction.

A value of 1.0 means that the radius of the attraction region is the same as the radius of repulsion. By default, a value of 0.5 is used (e.g., in the region 0<=r<=R a repulsive force is generated, while in R<r<=R*1.5 an attractive force is generated).

◆ SetMotionConstraint()

virtual void vtkPointSmoothingFilter::SetMotionConstraint ( int  )
virtual

Specify how to constrain the motion of points.

By default, point motion is unconstrained. Points can also be constrained to a plane. If constrained to a plane, then an instance of vtkPlane must be specified.

◆ GetMotionConstraint()

virtual int vtkPointSmoothingFilter::GetMotionConstraint ( )
virtual

Specify how to constrain the motion of points.

By default, point motion is unconstrained. Points can also be constrained to a plane. If constrained to a plane, then an instance of vtkPlane must be specified.

◆ SetMotionConstraintToUnconstrained()

void vtkPointSmoothingFilter::SetMotionConstraintToUnconstrained ( )
inline

Specify how to constrain the motion of points.

By default, point motion is unconstrained. Points can also be constrained to a plane. If constrained to a plane, then an instance of vtkPlane must be specified.

Definition at line 313 of file vtkPointSmoothingFilter.h.

◆ SetMotionConstraintToPlane()

void vtkPointSmoothingFilter::SetMotionConstraintToPlane ( )
inline

Specify how to constrain the motion of points.

By default, point motion is unconstrained. Points can also be constrained to a plane. If constrained to a plane, then an instance of vtkPlane must be specified.

Definition at line 314 of file vtkPointSmoothingFilter.h.

◆ SetPlane()

void vtkPointSmoothingFilter::SetPlane ( vtkPlane )

Specify the plane to which point motion is constrained.

Only required if MotionConstraint is set to UNCONSTRAINED_MOTION.

◆ GetPlane()

virtual vtkPlane* vtkPointSmoothingFilter::GetPlane ( )
virtual

Specify the plane to which point motion is constrained.

Only required if MotionConstraint is set to UNCONSTRAINED_MOTION.

◆ SetLocator()

void vtkPointSmoothingFilter::SetLocator ( vtkAbstractPointLocator locator)

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points around a sample point.

◆ GetLocator()

virtual vtkAbstractPointLocator* vtkPointSmoothingFilter::GetLocator ( )
virtual

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate points around a sample point.

◆ RequestData()

int vtkPointSmoothingFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPointSetAlgorithm.

◆ FillInputPortInformation()

int vtkPointSmoothingFilter::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

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

Member Data Documentation

◆ NeighborhoodSize

int vtkPointSmoothingFilter::NeighborhoodSize
protected

Definition at line 341 of file vtkPointSmoothingFilter.h.

◆ SmoothingMode

int vtkPointSmoothingFilter::SmoothingMode
protected

Definition at line 342 of file vtkPointSmoothingFilter.h.

◆ NumberOfIterations

int vtkPointSmoothingFilter::NumberOfIterations
protected

Definition at line 343 of file vtkPointSmoothingFilter.h.

◆ NumberOfSubIterations

int vtkPointSmoothingFilter::NumberOfSubIterations
protected

Definition at line 344 of file vtkPointSmoothingFilter.h.

◆ MaximumStepSize

double vtkPointSmoothingFilter::MaximumStepSize
protected

Definition at line 345 of file vtkPointSmoothingFilter.h.

◆ Convergence

double vtkPointSmoothingFilter::Convergence
protected

Definition at line 346 of file vtkPointSmoothingFilter.h.

◆ FrameFieldArray

vtkDataArray* vtkPointSmoothingFilter::FrameFieldArray
protected

Definition at line 347 of file vtkPointSmoothingFilter.h.

◆ Locator

vtkAbstractPointLocator* vtkPointSmoothingFilter::Locator
protected

Definition at line 350 of file vtkPointSmoothingFilter.h.

◆ EnableConstraints

bool vtkPointSmoothingFilter::EnableConstraints
protected

Definition at line 353 of file vtkPointSmoothingFilter.h.

◆ FixedAngle

double vtkPointSmoothingFilter::FixedAngle
protected

Definition at line 354 of file vtkPointSmoothingFilter.h.

◆ BoundaryAngle

double vtkPointSmoothingFilter::BoundaryAngle
protected

Definition at line 355 of file vtkPointSmoothingFilter.h.

◆ GenerateConstraintScalars

bool vtkPointSmoothingFilter::GenerateConstraintScalars
protected

Definition at line 356 of file vtkPointSmoothingFilter.h.

◆ GenerateConstraintNormals

bool vtkPointSmoothingFilter::GenerateConstraintNormals
protected

Definition at line 357 of file vtkPointSmoothingFilter.h.

◆ ComputePackingRadius

bool vtkPointSmoothingFilter::ComputePackingRadius
protected

Definition at line 360 of file vtkPointSmoothingFilter.h.

◆ PackingRadius

double vtkPointSmoothingFilter::PackingRadius
protected

Definition at line 361 of file vtkPointSmoothingFilter.h.

◆ PackingFactor

double vtkPointSmoothingFilter::PackingFactor
protected

Definition at line 362 of file vtkPointSmoothingFilter.h.

◆ AttractionFactor

double vtkPointSmoothingFilter::AttractionFactor
protected

Definition at line 363 of file vtkPointSmoothingFilter.h.

◆ MotionConstraint

int vtkPointSmoothingFilter::MotionConstraint
protected

Definition at line 366 of file vtkPointSmoothingFilter.h.

◆ Plane

vtkPlane* vtkPointSmoothingFilter::Plane
protected

Definition at line 367 of file vtkPointSmoothingFilter.h.


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