VTK  9.0.20210924
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkBinnedDecimation Class Reference

reduce the number of triangles in a vtkPolyData mesh More...

#include <vtkBinnedDecimation.h>

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

Public Member Functions

bool GetLargeIds ()
 Return a flag indicating whether large ids were used during execution. More...
 
void SetNumberOfXDivisions (int num)
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
void SetNumberOfYDivisions (int num)
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
void SetNumberOfZDivisions (int num)
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
virtual int GetNumberOfXDivisions ()
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
virtual int GetNumberOfYDivisions ()
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
virtual int GetNumberOfZDivisions ()
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
void SetNumberOfDivisions (int div[3])
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
void SetNumberOfDivisions (int div0, int div1, int div2)
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
int * GetNumberOfDivisions ()
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
void GetNumberOfDivisions (int div[3])
 Set/Get the number of divisions along each axis for the spatial bins. More...
 
virtual void SetAutoAdjustNumberOfDivisions (bool)
 Enable automatic adjustment of number of divisions. More...
 
virtual bool GetAutoAdjustNumberOfDivisions ()
 Enable automatic adjustment of number of divisions. More...
 
virtual void AutoAdjustNumberOfDivisionsOn ()
 Enable automatic adjustment of number of divisions. More...
 
virtual void AutoAdjustNumberOfDivisionsOff ()
 Enable automatic adjustment of number of divisions. More...
 
void SetDivisionOrigin (double x, double y, double z)
 This is an alternative way to set up the bins. More...
 
void SetDivisionOrigin (double o[3])
 This is an alternative way to set up the bins. More...
 
virtual double * GetDivisionOrigin ()
 This is an alternative way to set up the bins. More...
 
virtual void GetDivisionOrigin (double &, double &, double &)
 This is an alternative way to set up the bins. More...
 
virtual void GetDivisionOrigin (double[3])
 This is an alternative way to set up the bins. More...
 
void SetDivisionSpacing (double x, double y, double z)
 This is an alternative way to set up the bins. More...
 
void SetDivisionSpacing (double s[3])
 This is an alternative way to set up the bins. More...
 
virtual double * GetDivisionSpacing ()
 This is an alternative way to set up the bins. More...
 
virtual void GetDivisionSpacing (double &, double &, double &)
 This is an alternative way to set up the bins. More...
 
virtual void GetDivisionSpacing (double[3])
 This is an alternative way to set up the bins. More...
 
virtual void SetProducePointData (bool)
 This flag directs the filter to produce output point data from the input point data (on by default). More...
 
virtual bool GetProducePointData ()
 This flag directs the filter to produce output point data from the input point data (on by default). More...
 
virtual void ProducePointDataOn ()
 This flag directs the filter to produce output point data from the input point data (on by default). More...
 
virtual void ProducePointDataOff ()
 This flag directs the filter to produce output point data from the input point data (on by default). More...
 
virtual void SetProduceCellData (bool)
 This flag directs the filter to copy cell data from input to output. More...
 
virtual bool GetProduceCellData ()
 This flag directs the filter to copy cell data from input to output. More...
 
virtual void ProduceCellDataOn ()
 This flag directs the filter to copy cell data from input to output. More...
 
virtual void ProduceCellDataOff ()
 This flag directs the filter to copy cell data from input to output. 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
 
int 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 SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. 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...
 
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...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) 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 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 (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int 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...
 
- 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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. 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...
 
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

 vtkBinnedDecimation ()
 
 ~vtkBinnedDecimation () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int, vtkInformation *) override
 Fill the input port information objects for this algorithm. More...
 
void ConfigureBinning (vtkPolyData *input, vtkIdType numPts)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm () override
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int RequestUpdateExtent (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...
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
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 assocition 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 NumberOfXDivisions
 
int NumberOfYDivisions
 
int NumberOfZDivisions
 
int NumberOfDivisions [3]
 
int ComputeNumberOfDivisions
 
bool AutoAdjustNumberOfDivisions
 
double DivisionOrigin [3]
 
double DivisionSpacing [3]
 
double Bounds [6]
 
int PointGenerationMode
 
bool ProducePointData
 
bool ProduceCellData
 
bool LargeIds
 
- Protected Attributes inherited from vtkAlgorithm
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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkPolyDataAlgorithm Superclass
 Standard instantiation, type and print methods. More...
 
static vtkBinnedDecimationNew ()
 Standard instantiation, type and print methods. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard instantiation, type and print methods. More...
 
static vtkBinnedDecimationSafeDownCast (vtkObjectBase *o)
 Standard instantiation, type and print methods. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard instantiation, type and print methods. More...
 
vtkBinnedDecimationNewInstance () const
 Standard instantiation, type and print methods. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard instantiation, type and print methods. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard instantiation, type and print methods. More...
 
enum  { INPUT_POINTS = 1, BIN_POINTS = 2, BIN_CENTERS = 3, BIN_AVERAGES = 4 }
 Four options exist for generating output points. More...
 
virtual void SetPointGenerationMode (int)
 Four options exist for generating output points. More...
 
virtual int GetPointGenerationMode ()
 Four options exist for generating output points. More...
 
void SetPointGenerationModeToUseInputPoints ()
 Four options exist for generating output points. More...
 
void SetPointGenerationModeToBinPoints ()
 Four options exist for generating output points. More...
 
void SetPointGenerationModeToBinCenters ()
 Four options exist for generating output points. More...
 
void SetPointGenerationModeToBinAverages ()
 Four options exist for generating output points. More...
 

Additional Inherited Members

- 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
 
- 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 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 (int 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 int 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
vtkTypeBool AbortExecute
 
- 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 vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

reduce the number of triangles in a vtkPolyData mesh

vtkBinnedDecimation is a filter to reduce the number of triangles in a triangle mesh represented by vtkPolyData. It is similar to vtkQuadricClustering in concept, although it is performance accelerated: it does not use quadric error metrics to position points in the bins, plus it is threaded. (See vtkQuadricClustering for more information.) It also takes some short cuts in the interest of speed: it limits the binning resolution to no more than 2^31 bins; and it can (optionally) reuse the input points in the output (to save memory and computational costs).

A high-level overview of the algorithm is as follows. Points are binned into a regular grid subdivided in the x-y-z directions. The idea is to combine all the points within each bin into a single point which is then used by the output triangles. Four options are available to generate the output points. If the input points are to be reused as the output points, then all points in the same bin simply adopt the coordinates of one of the selected points in the bin (and thus all points in the bin take on the same output point id). Alternatively, if new output points are to be generated, then either one point is selected; the centers of occupied bins can be used as the output point coordinates; or an average position of all points falling into the bin can be used to generate the bin point. Finally, triangles are inserted into the output: triangles whose three, binned points lie in separate bins are sent to the output, while all others are discarded (i.e., triangles with two or more points in the same bin are not sent to the output).

To use this filter, specify the divisions defining the spatial subdivision in the x, y, and z directions. Of course you must also specify an input vtkPolyData / filter connection. Higher division levels generally produce results closer to the original mesh. Note that for performance reasons (i.e., related to memory), the maximum divisions in the x-y-z directions is limited in such a way (i.e., proportional scaling of divisions is used) so as to ensure that no more than 2^31 bins are used. Higher divisions have modest impact on the overall performance of the algorithm, although the resolution of the output vtkPolyData is affected significantly (i.e., many more triangles may be generated).

Warning
This filter can drastically affect mesh topology, i.e., topology is not preserved.
This filter and vtkQuadricClustering produce similar results, with vtkQuadricClustering theoretically producing better results. In practice however, vtkBinnedDecimation produces results that are visually close to vtkQuadricClustering at speeds approaching 10-100x faster (depending on the bin divisions, and how the output points are generated), and the algorithm requires much less memory. Note that the API of this filter is a subset of vtkQuadricClustering and can often be used interchangeably with vtkQuadricClustering.
Algorithm 4) BIN_CENTERS uses a very different implementation strategy requiring a sort of all points. It scales better as the number of bins increases.
For certain types of geometry (e.g., a mostly 2D plane with jitter in the normal direction), this decimator can perform badly. In this situation, set the number of bins in the normal direction to one.
This class has been threaded with vtkSMPTools. Using TBB or other non-sequential execution type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.
See also
vtkQuadricClustering vtkDecimatePro vtkDecimate vtkQuadricLODActor vtkTriangleFilter

Definition at line 95 of file vtkBinnedDecimation.h.

Member Typedef Documentation

◆ Superclass

Standard instantiation, type and print methods.

Definition at line 103 of file vtkBinnedDecimation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

Enumerator
INPUT_POINTS 
BIN_POINTS 
BIN_CENTERS 
BIN_AVERAGES 

Definition at line 177 of file vtkBinnedDecimation.h.

Constructor & Destructor Documentation

◆ vtkBinnedDecimation()

vtkBinnedDecimation::vtkBinnedDecimation ( )
protected

◆ ~vtkBinnedDecimation()

vtkBinnedDecimation::~vtkBinnedDecimation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkBinnedDecimation* vtkBinnedDecimation::New ( )
static

Standard instantiation, type and print methods.

◆ IsTypeOf()

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

Standard instantiation, type and print methods.

◆ IsA()

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

Standard instantiation, type and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ SafeDownCast()

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

Standard instantiation, type and print methods.

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBinnedDecimation::NewInstanceInternal ( ) const
protectedvirtual

Standard instantiation, type and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ NewInstance()

vtkBinnedDecimation* vtkBinnedDecimation::NewInstance ( ) const

Standard instantiation, type and print methods.

◆ PrintSelf()

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

Standard instantiation, type and print methods.

Reimplemented from vtkPolyDataAlgorithm.

◆ SetNumberOfXDivisions()

void vtkBinnedDecimation::SetNumberOfXDivisions ( int  num)

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ SetNumberOfYDivisions()

void vtkBinnedDecimation::SetNumberOfYDivisions ( int  num)

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ SetNumberOfZDivisions()

void vtkBinnedDecimation::SetNumberOfZDivisions ( int  num)

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ GetNumberOfXDivisions()

virtual int vtkBinnedDecimation::GetNumberOfXDivisions ( )
virtual

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ GetNumberOfYDivisions()

virtual int vtkBinnedDecimation::GetNumberOfYDivisions ( )
virtual

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ GetNumberOfZDivisions()

virtual int vtkBinnedDecimation::GetNumberOfZDivisions ( )
virtual

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ SetNumberOfDivisions() [1/2]

void vtkBinnedDecimation::SetNumberOfDivisions ( int  div[3])
inline

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

Definition at line 125 of file vtkBinnedDecimation.h.

◆ SetNumberOfDivisions() [2/2]

void vtkBinnedDecimation::SetNumberOfDivisions ( int  div0,
int  div1,
int  div2 
)

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ GetNumberOfDivisions() [1/2]

int* vtkBinnedDecimation::GetNumberOfDivisions ( )

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ GetNumberOfDivisions() [2/2]

void vtkBinnedDecimation::GetNumberOfDivisions ( int  div[3])

Set/Get the number of divisions along each axis for the spatial bins.

The number of spatial bins is NumberOfXDivisions*NumberOfYDivisions* NumberOfZDivisions. The filter may choose to ignore large numbers of divisions if the input has few points and AutoAdjustNumberOfDivisions is enabled. Also, the maximum number of divisions is controlled so that no more than 2^31 bins are created. (If bin adjustment due to the limit on the number of bins is necessary, then a proportional scaling of the divisions in the x-y-z directions is used.) This API has been adopted to be consistent with vtkQuadricClustering.

◆ SetAutoAdjustNumberOfDivisions()

virtual void vtkBinnedDecimation::SetAutoAdjustNumberOfDivisions ( bool  )
virtual

Enable automatic adjustment of number of divisions.

If disabled, the number of divisions specified by the user is always used (as long as it is valid). The default is On.

◆ GetAutoAdjustNumberOfDivisions()

virtual bool vtkBinnedDecimation::GetAutoAdjustNumberOfDivisions ( )
virtual

Enable automatic adjustment of number of divisions.

If disabled, the number of divisions specified by the user is always used (as long as it is valid). The default is On.

◆ AutoAdjustNumberOfDivisionsOn()

virtual void vtkBinnedDecimation::AutoAdjustNumberOfDivisionsOn ( )
virtual

Enable automatic adjustment of number of divisions.

If disabled, the number of divisions specified by the user is always used (as long as it is valid). The default is On.

◆ AutoAdjustNumberOfDivisionsOff()

virtual void vtkBinnedDecimation::AutoAdjustNumberOfDivisionsOff ( )
virtual

Enable automatic adjustment of number of divisions.

If disabled, the number of divisions specified by the user is always used (as long as it is valid). The default is On.

◆ SetDivisionOrigin() [1/2]

void vtkBinnedDecimation::SetDivisionOrigin ( double  x,
double  y,
double  z 
)

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ SetDivisionOrigin() [2/2]

void vtkBinnedDecimation::SetDivisionOrigin ( double  o[3])
inline

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

Definition at line 150 of file vtkBinnedDecimation.h.

◆ GetDivisionOrigin() [1/3]

virtual double* vtkBinnedDecimation::GetDivisionOrigin ( )
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ GetDivisionOrigin() [2/3]

virtual void vtkBinnedDecimation::GetDivisionOrigin ( double &  ,
double &  ,
double &   
)
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ GetDivisionOrigin() [3/3]

virtual void vtkBinnedDecimation::GetDivisionOrigin ( double  [3])
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ SetDivisionSpacing() [1/2]

void vtkBinnedDecimation::SetDivisionSpacing ( double  x,
double  y,
double  z 
)

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ SetDivisionSpacing() [2/2]

void vtkBinnedDecimation::SetDivisionSpacing ( double  s[3])
inline

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

Definition at line 153 of file vtkBinnedDecimation.h.

◆ GetDivisionSpacing() [1/3]

virtual double* vtkBinnedDecimation::GetDivisionSpacing ( )
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ GetDivisionSpacing() [2/3]

virtual void vtkBinnedDecimation::GetDivisionSpacing ( double &  ,
double &  ,
double &   
)
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ GetDivisionSpacing() [3/3]

virtual void vtkBinnedDecimation::GetDivisionSpacing ( double  [3])
virtual

This is an alternative way to set up the bins.

If you are trying to match boundaries between pieces, then you should use these methods rather than SetNumberOfDivisions(). To use these methods, specify the origin and spacing of the spatial binning.

◆ SetPointGenerationMode()

virtual void vtkBinnedDecimation::SetPointGenerationMode ( int  )
virtual

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

◆ GetPointGenerationMode()

virtual int vtkBinnedDecimation::GetPointGenerationMode ( )
virtual

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

◆ SetPointGenerationModeToUseInputPoints()

void vtkBinnedDecimation::SetPointGenerationModeToUseInputPoints ( )
inline

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

Definition at line 186 of file vtkBinnedDecimation.h.

◆ SetPointGenerationModeToBinPoints()

void vtkBinnedDecimation::SetPointGenerationModeToBinPoints ( )
inline

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

Definition at line 187 of file vtkBinnedDecimation.h.

◆ SetPointGenerationModeToBinCenters()

void vtkBinnedDecimation::SetPointGenerationModeToBinCenters ( )
inline

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

Definition at line 188 of file vtkBinnedDecimation.h.

◆ SetPointGenerationModeToBinAverages()

void vtkBinnedDecimation::SetPointGenerationModeToBinAverages ( )
inline

Four options exist for generating output points.

1) Pass the input points through to the output; 2) select one of the input points in the bin and use that; 3) generate new points at the center of bins (only center bin points used by the output triangles are generated); and 4) generate new points from the average of all points falling into a bin and used by output triangles. Note that 1) can result in many, unused output points, but tends to be fastest for small numbers of bins. This can impact rendering memory usage as all points are typically pushed into the graphics hardware. Options 2-4 produce only points used by the output triangles but generally take longer (for small numbers of bins), with speeds slowing in order from options 2 through 4. In terms of quality, option 4 (BIN_AVERAGES) produces the best output; options 1) and 2) produce decent output, with option 3) (BIN_CENTERS) producing a voxelized-like result (which is quite useful for illustrative purposes). Note that for very large numbers of bins (say number of divisions > 500^3), then algorithm 4) BIN_AVERAGES scales better, i.e., is likely faster and produces better results.

Definition at line 189 of file vtkBinnedDecimation.h.

◆ SetProducePointData()

virtual void vtkBinnedDecimation::SetProducePointData ( bool  )
virtual

This flag directs the filter to produce output point data from the input point data (on by default).

If the ProducePointData is set to INPUT_POINTS, point data is simply passed from input to output (since the points don't change). If the point generation mode is set to BIN_AVERAGES, then the average of all point data values withing a bin are associated with the point generated in the bin. If the point generation mode is either BIN_POINTS or BIN_CENTERS, then the point data values from one of the points falling into the bin is used.

◆ GetProducePointData()

virtual bool vtkBinnedDecimation::GetProducePointData ( )
virtual

This flag directs the filter to produce output point data from the input point data (on by default).

If the ProducePointData is set to INPUT_POINTS, point data is simply passed from input to output (since the points don't change). If the point generation mode is set to BIN_AVERAGES, then the average of all point data values withing a bin are associated with the point generated in the bin. If the point generation mode is either BIN_POINTS or BIN_CENTERS, then the point data values from one of the points falling into the bin is used.

◆ ProducePointDataOn()

virtual void vtkBinnedDecimation::ProducePointDataOn ( )
virtual

This flag directs the filter to produce output point data from the input point data (on by default).

If the ProducePointData is set to INPUT_POINTS, point data is simply passed from input to output (since the points don't change). If the point generation mode is set to BIN_AVERAGES, then the average of all point data values withing a bin are associated with the point generated in the bin. If the point generation mode is either BIN_POINTS or BIN_CENTERS, then the point data values from one of the points falling into the bin is used.

◆ ProducePointDataOff()

virtual void vtkBinnedDecimation::ProducePointDataOff ( )
virtual

This flag directs the filter to produce output point data from the input point data (on by default).

If the ProducePointData is set to INPUT_POINTS, point data is simply passed from input to output (since the points don't change). If the point generation mode is set to BIN_AVERAGES, then the average of all point data values withing a bin are associated with the point generated in the bin. If the point generation mode is either BIN_POINTS or BIN_CENTERS, then the point data values from one of the points falling into the bin is used.

◆ SetProduceCellData()

virtual void vtkBinnedDecimation::SetProduceCellData ( bool  )
virtual

This flag directs the filter to copy cell data from input to output.

This flag is off by default.

◆ GetProduceCellData()

virtual bool vtkBinnedDecimation::GetProduceCellData ( )
virtual

This flag directs the filter to copy cell data from input to output.

This flag is off by default.

◆ ProduceCellDataOn()

virtual void vtkBinnedDecimation::ProduceCellDataOn ( )
virtual

This flag directs the filter to copy cell data from input to output.

This flag is off by default.

◆ ProduceCellDataOff()

virtual void vtkBinnedDecimation::ProduceCellDataOff ( )
virtual

This flag directs the filter to copy cell data from input to output.

This flag is off by default.

◆ GetLargeIds()

bool vtkBinnedDecimation::GetLargeIds ( )
inline

Return a flag indicating whether large ids were used during execution.

The value of this flag is only valid after filter execution. The filter may use a smaller id type unless it must use vtkIdType to represent points and cell ids.

Definition at line 224 of file vtkBinnedDecimation.h.

◆ RequestData()

int vtkBinnedDecimation::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

◆ FillInputPortInformation()

int vtkBinnedDecimation::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 vtkPolyDataAlgorithm.

◆ ConfigureBinning()

void vtkBinnedDecimation::ConfigureBinning ( vtkPolyData input,
vtkIdType  numPts 
)
protected

Member Data Documentation

◆ NumberOfXDivisions

int vtkBinnedDecimation::NumberOfXDivisions
protected

Definition at line 233 of file vtkBinnedDecimation.h.

◆ NumberOfYDivisions

int vtkBinnedDecimation::NumberOfYDivisions
protected

Definition at line 234 of file vtkBinnedDecimation.h.

◆ NumberOfZDivisions

int vtkBinnedDecimation::NumberOfZDivisions
protected

Definition at line 235 of file vtkBinnedDecimation.h.

◆ NumberOfDivisions

int vtkBinnedDecimation::NumberOfDivisions[3]
protected

Definition at line 236 of file vtkBinnedDecimation.h.

◆ ComputeNumberOfDivisions

int vtkBinnedDecimation::ComputeNumberOfDivisions
protected

Definition at line 241 of file vtkBinnedDecimation.h.

◆ AutoAdjustNumberOfDivisions

bool vtkBinnedDecimation::AutoAdjustNumberOfDivisions
protected

Definition at line 243 of file vtkBinnedDecimation.h.

◆ DivisionOrigin

double vtkBinnedDecimation::DivisionOrigin[3]
protected

Definition at line 244 of file vtkBinnedDecimation.h.

◆ DivisionSpacing

double vtkBinnedDecimation::DivisionSpacing[3]
protected

Definition at line 245 of file vtkBinnedDecimation.h.

◆ Bounds

double vtkBinnedDecimation::Bounds[6]
protected

Definition at line 246 of file vtkBinnedDecimation.h.

◆ PointGenerationMode

int vtkBinnedDecimation::PointGenerationMode
protected

Definition at line 248 of file vtkBinnedDecimation.h.

◆ ProducePointData

bool vtkBinnedDecimation::ProducePointData
protected

Definition at line 249 of file vtkBinnedDecimation.h.

◆ ProduceCellData

bool vtkBinnedDecimation::ProduceCellData
protected

Definition at line 250 of file vtkBinnedDecimation.h.

◆ LargeIds

bool vtkBinnedDecimation::LargeIds
protected

Definition at line 251 of file vtkBinnedDecimation.h.


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