VTK  9.3.20240319
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCleanPolyData Class Reference

merge duplicate points, and/or remove unused points and/or remove degenerate cells More...

#include <vtkCleanPolyData.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- Public Types inherited from vtkPolyDataAlgorithm
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

void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCleanPolyDataNewInstance () const
 
void CreateDefaultLocator (vtkPolyData *input=nullptr)
 Create default locator. More...
 
void ReleaseLocator ()
 Release locator. More...
 
vtkMTimeType GetMTime () override
 Get the MTime of this object also considering the locator. More...
 
virtual void OperateOnPoint (double in[3], double out[3])
 Perform operation on a point. More...
 
virtual void OperateOnBounds (double in[6], double out[6])
 Perform operation on bounds. More...
 
virtual void SetPieceInvariant (vtkTypeBool)
 
virtual vtkTypeBool GetPieceInvariant ()
 
virtual void PieceInvariantOn ()
 
virtual void PieceInvariantOff ()
 
virtual void SetToleranceIsAbsolute (vtkTypeBool)
 By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging) More...
 
virtual void ToleranceIsAbsoluteOn ()
 By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging) More...
 
virtual void ToleranceIsAbsoluteOff ()
 By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging) More...
 
virtual vtkTypeBool GetToleranceIsAbsolute ()
 By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging) More...
 
virtual void SetTolerance (double)
 Specify tolerance in terms of fraction of bounding box length. More...
 
virtual double GetTolerance ()
 Specify tolerance in terms of fraction of bounding box length. More...
 
virtual void SetAbsoluteTolerance (double)
 Specify tolerance in absolute terms. More...
 
virtual double GetAbsoluteTolerance ()
 Specify tolerance in absolute terms. More...
 
virtual void SetConvertLinesToPoints (vtkTypeBool)
 Turn on/off conversion of degenerate lines to points. More...
 
virtual void ConvertLinesToPointsOn ()
 Turn on/off conversion of degenerate lines to points. More...
 
virtual void ConvertLinesToPointsOff ()
 Turn on/off conversion of degenerate lines to points. More...
 
virtual vtkTypeBool GetConvertLinesToPoints ()
 Turn on/off conversion of degenerate lines to points. More...
 
virtual void SetConvertPolysToLines (vtkTypeBool)
 Turn on/off conversion of degenerate polys to lines. More...
 
virtual void ConvertPolysToLinesOn ()
 Turn on/off conversion of degenerate polys to lines. More...
 
virtual void ConvertPolysToLinesOff ()
 Turn on/off conversion of degenerate polys to lines. More...
 
virtual vtkTypeBool GetConvertPolysToLines ()
 Turn on/off conversion of degenerate polys to lines. More...
 
virtual void SetConvertStripsToPolys (vtkTypeBool)
 Turn on/off conversion of degenerate strips to polys. More...
 
virtual void ConvertStripsToPolysOn ()
 Turn on/off conversion of degenerate strips to polys. More...
 
virtual void ConvertStripsToPolysOff ()
 Turn on/off conversion of degenerate strips to polys. More...
 
virtual vtkTypeBool GetConvertStripsToPolys ()
 Turn on/off conversion of degenerate strips to polys. More...
 
virtual void SetPointMerging (vtkTypeBool)
 Set/Get a boolean value that controls whether point merging is performed. More...
 
virtual vtkTypeBool GetPointMerging ()
 Set/Get a boolean value that controls whether point merging is performed. More...
 
virtual void PointMergingOn ()
 Set/Get a boolean value that controls whether point merging is performed. More...
 
virtual void PointMergingOff ()
 Set/Get a boolean value that controls whether point merging is performed. More...
 
virtual void SetLocator (vtkIncrementalPointLocator *locator)
 Set/Get a spatial locator for speeding the search process. More...
 
virtual vtkIncrementalPointLocatorGetLocator ()
 Set/Get a spatial locator for speeding the search process. More...
 
virtual void SetOutputPointsPrecision (int)
 Set/get the desired precision for the output types. More...
 
virtual int GetOutputPointsPrecision ()
 Set/get the desired precision for the output types. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
virtual void SetOutput (vtkDataObject *d)
 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 AddInputData (vtkDataObject *)
 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...
 
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...
 

Static Public Member Functions

static vtkCleanPolyDataNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCleanPolyDataSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCleanPolyData ()
 
 ~vtkCleanPolyData () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called by the superclass. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. 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

vtkTypeBool PointMerging
 
double Tolerance
 
double AbsoluteTolerance
 
vtkTypeBool ConvertLinesToPoints
 
vtkTypeBool ConvertPolysToLines
 
vtkTypeBool ConvertStripsToPolys
 
vtkTypeBool ToleranceIsAbsolute
 
vtkIncrementalPointLocatorLocator
 
vtkTypeBool PieceInvariant
 
int OutputPointsPrecision
 
- 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
 

Additional Inherited Members

- 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

merge duplicate points, and/or remove unused points and/or remove degenerate cells

vtkCleanPolyData is a filter that takes polygonal data as input and generates polygonal data as output. vtkCleanPolyData will merge duplicate points (within specified tolerance and if enabled), eliminate points that are not used in any cell, and if enabled, transform degenerate cells into appropriate forms (for example, a triangle is converted into a line if two points of triangle are merged).

Conversion of degenerate cells is controlled by the flags ConvertLinesToPoints, ConvertPolysToLines, ConvertStripsToPolys which act cumulatively such that a degenerate strip may become a poly. The full set is Line with 1 points -> Vert (if ConvertLinesToPoints) Poly with 2 points -> Line (if ConvertPolysToLines) Poly with 1 points -> Vert (if ConvertPolysToLines && ConvertLinesToPoints) Strp with 3 points -> Poly (if ConvertStripsToPolys) Strp with 2 points -> Line (if ConvertStripsToPolys && ConvertPolysToLines) Strp with 1 points -> Vert (if ConvertStripsToPolys && ConvertPolysToLines && ConvertLinesToPoints)

Cells of type VTK_POLY_LINE will be converted to a vertex only if ConvertLinesToPoints is on and all points are merged into one. Degenerate line segments (with two identical end points) will be removed.

If tolerance is specified precisely=0.0, then vtkCleanPolyData will use the vtkMergePoints object to merge points (which is faster). Otherwise the slower vtkIncrementalPointLocator is used. Before inserting points into the point locator, this class calls a function OperateOnPoint which can be used (in subclasses) to further refine the cleaning process. See vtkQuantizePolyDataPoints.

In addition, if a point global id array is available, then two points are merged if and only if they share the same global id.

Note that merging of points can be disabled. In this case, a point locator will not be used, and points that are not used by any cells will be eliminated, but never merged.

Warning
Merging points can alter topology, including introducing non-manifold forms. The tolerance should be chosen carefully to avoid these problems. Subclasses should handle OperateOnBounds as well as OperateOnPoint to ensure that the locator is correctly initialized (i.e. all modified points must lie inside modified bounds).
If you wish to operate on a set of point coordinates that has no cells, you must add a vtkPolyVertex cell with all of the points to the PolyData (or use a vtkVertexGlyphFilter) before using the vtkCleanPolyData filter.
The vtkStaticCleanPolyData filter is similar in operation to vtkCleanPolyData. However, vtkStaticCleanPolyData is non-incremental and uses a much faster threading approach (especially for larger datasets, and when merging points with a non-zero tolerance). However because of the difference in the traversal order in the point merging process, the output of the filters may be different.
See also
vtkQuantizePolyDataPoints vtkStaticCleanPolyData vtkStaticCleanUnstructuredGrid
Examples:
vtkCleanPolyData (Examples)
Online Examples:

Tests:
vtkCleanPolyData (Tests)

Definition at line 193 of file vtkCleanPolyData.h.

Member Typedef Documentation

◆ Superclass

Definition at line 198 of file vtkCleanPolyData.h.

Constructor & Destructor Documentation

◆ vtkCleanPolyData()

vtkCleanPolyData::vtkCleanPolyData ( )
protected

◆ ~vtkCleanPolyData()

vtkCleanPolyData::~vtkCleanPolyData ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkCleanPolyData* vtkCleanPolyData::New ( )
static

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkQuantizePolyDataPoints.

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkCleanPolyData::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkQuantizePolyDataPoints.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkCleanPolyData::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented in vtkQuantizePolyDataPoints.

◆ NewInstance()

vtkCleanPolyData* vtkCleanPolyData::NewInstance ( ) const

◆ SetToleranceIsAbsolute()

virtual void vtkCleanPolyData::SetToleranceIsAbsolute ( vtkTypeBool  )
virtual

By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)

◆ ToleranceIsAbsoluteOn()

virtual void vtkCleanPolyData::ToleranceIsAbsoluteOn ( )
virtual

By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)

◆ ToleranceIsAbsoluteOff()

virtual void vtkCleanPolyData::ToleranceIsAbsoluteOff ( )
virtual

By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)

◆ GetToleranceIsAbsolute()

virtual vtkTypeBool vtkCleanPolyData::GetToleranceIsAbsolute ( )
virtual

By default ToleranceIsAbsolute is false and Tolerance is a fraction of Bounding box diagonal, if true, AbsoluteTolerance is used when adding points to locator (merging)

◆ SetTolerance()

virtual void vtkCleanPolyData::SetTolerance ( double  )
virtual

Specify tolerance in terms of fraction of bounding box length.

Default is 0.0.

◆ GetTolerance()

virtual double vtkCleanPolyData::GetTolerance ( )
virtual

Specify tolerance in terms of fraction of bounding box length.

Default is 0.0.

◆ SetAbsoluteTolerance()

virtual void vtkCleanPolyData::SetAbsoluteTolerance ( double  )
virtual

Specify tolerance in absolute terms.

Default is 1.0.

◆ GetAbsoluteTolerance()

virtual double vtkCleanPolyData::GetAbsoluteTolerance ( )
virtual

Specify tolerance in absolute terms.

Default is 1.0.

◆ SetConvertLinesToPoints()

virtual void vtkCleanPolyData::SetConvertLinesToPoints ( vtkTypeBool  )
virtual

Turn on/off conversion of degenerate lines to points.

Default is On.

◆ ConvertLinesToPointsOn()

virtual void vtkCleanPolyData::ConvertLinesToPointsOn ( )
virtual

Turn on/off conversion of degenerate lines to points.

Default is On.

◆ ConvertLinesToPointsOff()

virtual void vtkCleanPolyData::ConvertLinesToPointsOff ( )
virtual

Turn on/off conversion of degenerate lines to points.

Default is On.

◆ GetConvertLinesToPoints()

virtual vtkTypeBool vtkCleanPolyData::GetConvertLinesToPoints ( )
virtual

Turn on/off conversion of degenerate lines to points.

Default is On.

◆ SetConvertPolysToLines()

virtual void vtkCleanPolyData::SetConvertPolysToLines ( vtkTypeBool  )
virtual

Turn on/off conversion of degenerate polys to lines.

Default is On.

◆ ConvertPolysToLinesOn()

virtual void vtkCleanPolyData::ConvertPolysToLinesOn ( )
virtual

Turn on/off conversion of degenerate polys to lines.

Default is On.

◆ ConvertPolysToLinesOff()

virtual void vtkCleanPolyData::ConvertPolysToLinesOff ( )
virtual

Turn on/off conversion of degenerate polys to lines.

Default is On.

◆ GetConvertPolysToLines()

virtual vtkTypeBool vtkCleanPolyData::GetConvertPolysToLines ( )
virtual

Turn on/off conversion of degenerate polys to lines.

Default is On.

◆ SetConvertStripsToPolys()

virtual void vtkCleanPolyData::SetConvertStripsToPolys ( vtkTypeBool  )
virtual

Turn on/off conversion of degenerate strips to polys.

Default is On.

◆ ConvertStripsToPolysOn()

virtual void vtkCleanPolyData::ConvertStripsToPolysOn ( )
virtual

Turn on/off conversion of degenerate strips to polys.

Default is On.

◆ ConvertStripsToPolysOff()

virtual void vtkCleanPolyData::ConvertStripsToPolysOff ( )
virtual

Turn on/off conversion of degenerate strips to polys.

Default is On.

◆ GetConvertStripsToPolys()

virtual vtkTypeBool vtkCleanPolyData::GetConvertStripsToPolys ( )
virtual

Turn on/off conversion of degenerate strips to polys.

Default is On.

◆ SetPointMerging()

virtual void vtkCleanPolyData::SetPointMerging ( vtkTypeBool  )
virtual

Set/Get a boolean value that controls whether point merging is performed.

If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points are never merged. By default, merging is on.

◆ GetPointMerging()

virtual vtkTypeBool vtkCleanPolyData::GetPointMerging ( )
virtual

Set/Get a boolean value that controls whether point merging is performed.

If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points are never merged. By default, merging is on.

◆ PointMergingOn()

virtual void vtkCleanPolyData::PointMergingOn ( )
virtual

Set/Get a boolean value that controls whether point merging is performed.

If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points are never merged. By default, merging is on.

◆ PointMergingOff()

virtual void vtkCleanPolyData::PointMergingOff ( )
virtual

Set/Get a boolean value that controls whether point merging is performed.

If on, a locator will be used, and points laying within the appropriate tolerance may be merged. If off, points are never merged. By default, merging is on.

◆ SetLocator()

virtual void vtkCleanPolyData::SetLocator ( vtkIncrementalPointLocator locator)
virtual

Set/Get a spatial locator for speeding the search process.

By default an instance of vtkMergePoints is used.

◆ GetLocator()

virtual vtkIncrementalPointLocator* vtkCleanPolyData::GetLocator ( )
virtual

Set/Get a spatial locator for speeding the search process.

By default an instance of vtkMergePoints is used.

◆ CreateDefaultLocator()

void vtkCleanPolyData::CreateDefaultLocator ( vtkPolyData input = nullptr)

Create default locator.

Used to create one when none is specified.

◆ ReleaseLocator()

void vtkCleanPolyData::ReleaseLocator ( )
inline

Release locator.

Definition at line 284 of file vtkCleanPolyData.h.

◆ GetMTime()

vtkMTimeType vtkCleanPolyData::GetMTime ( )
overridevirtual

Get the MTime of this object also considering the locator.

Reimplemented from vtkObject.

◆ OperateOnPoint()

virtual void vtkCleanPolyData::OperateOnPoint ( double  in[3],
double  out[3] 
)
virtual

Perform operation on a point.

Reimplemented in vtkQuantizePolyDataPoints.

◆ OperateOnBounds()

virtual void vtkCleanPolyData::OperateOnBounds ( double  in[6],
double  out[6] 
)
virtual

Perform operation on bounds.

Reimplemented in vtkQuantizePolyDataPoints.

◆ SetPieceInvariant()

virtual void vtkCleanPolyData::SetPieceInvariant ( vtkTypeBool  )
virtual

◆ GetPieceInvariant()

virtual vtkTypeBool vtkCleanPolyData::GetPieceInvariant ( )
virtual

◆ PieceInvariantOn()

virtual void vtkCleanPolyData::PieceInvariantOn ( )
virtual

◆ PieceInvariantOff()

virtual void vtkCleanPolyData::PieceInvariantOff ( )
virtual

◆ SetOutputPointsPrecision()

virtual void vtkCleanPolyData::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 vtkCleanPolyData::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 vtkCleanPolyData::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ RequestUpdateExtent()

int vtkCleanPolyData::RequestUpdateExtent ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

◆ PointMerging

vtkTypeBool vtkCleanPolyData::PointMerging
protected

Definition at line 328 of file vtkCleanPolyData.h.

◆ Tolerance

double vtkCleanPolyData::Tolerance
protected

Definition at line 329 of file vtkCleanPolyData.h.

◆ AbsoluteTolerance

double vtkCleanPolyData::AbsoluteTolerance
protected

Definition at line 330 of file vtkCleanPolyData.h.

◆ ConvertLinesToPoints

vtkTypeBool vtkCleanPolyData::ConvertLinesToPoints
protected

Definition at line 331 of file vtkCleanPolyData.h.

◆ ConvertPolysToLines

vtkTypeBool vtkCleanPolyData::ConvertPolysToLines
protected

Definition at line 332 of file vtkCleanPolyData.h.

◆ ConvertStripsToPolys

vtkTypeBool vtkCleanPolyData::ConvertStripsToPolys
protected

Definition at line 333 of file vtkCleanPolyData.h.

◆ ToleranceIsAbsolute

vtkTypeBool vtkCleanPolyData::ToleranceIsAbsolute
protected

Definition at line 334 of file vtkCleanPolyData.h.

◆ Locator

vtkIncrementalPointLocator* vtkCleanPolyData::Locator
protected

Definition at line 335 of file vtkCleanPolyData.h.

◆ PieceInvariant

vtkTypeBool vtkCleanPolyData::PieceInvariant
protected

Definition at line 337 of file vtkCleanPolyData.h.

◆ OutputPointsPrecision

int vtkCleanPolyData::OutputPointsPrecision
protected

Definition at line 338 of file vtkCleanPolyData.h.


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