vtkVoxelGrid Class Reference

subsample points using uniform binning More...

#include <vtkVoxelGrid.h>

Inheritance diagram for vtkVoxelGrid:

Collaboration diagram for vtkVoxelGrid:

Public Types
enum	Style { MANUAL =0, SPECIFY_LEAF_SIZE =1, AUTOMATIC =2 }
	This enum is used to configure the operation of the filter. More...
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
virtual void	SetConfigurationStyle (int)
	Configure how the filter is to operate. More...
virtual int	GetConfigurationStyle ()
	Configure how the filter is to operate. More...
void	SetConfigurationStyleToManual ()
	Configure how the filter is to operate. More...
void	SetConfigurationStyleToLeafSize ()
	Configure how the filter is to operate. More...
void	SetConfigurationStyleToAutomatic ()
	Configure how the filter is to operate. More...
virtual void	SetDivisions (int, int, int)
	Set the number of divisions in x-y-z directions (the binning volume dimensions). More...
virtual void	SetDivisions (int[3])
	Set the number of divisions in x-y-z directions (the binning volume dimensions). More...
virtual int *	GetDivisions ()
	Set the number of divisions in x-y-z directions (the binning volume dimensions). More...
virtual void	GetDivisions (int data[3])
	Set the number of divisions in x-y-z directions (the binning volume dimensions). More...
virtual void	SetLeafSize (double, double, double)
	Set the bin size in the x-y-z directions. More...
virtual void	SetLeafSize (double[3])
	Set the bin size in the x-y-z directions. More...
virtual double *	GetLeafSize ()
	Set the bin size in the x-y-z directions. More...
virtual void	GetLeafSize (double data[3])
	Set the bin size in the x-y-z directions. More...
virtual void	SetNumberOfPointsPerBin (int)
	Specify the average number of points in each bin. More...
virtual int	GetNumberOfPointsPerBin ()
	Specify the average number of points in each bin. More...
void	SetKernel (vtkInterpolationKernel *kernel)
	Specify an interpolation kernel to combine the point attributes. More...
virtual vtkInterpolationKernel *	GetKernel ()
	Specify an interpolation kernel to combine the point attributes. More...
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const
int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
	see vtkAlgorithm for details More...
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
vtkPolyData *	GetOutput ()
	Get the output data object for a port on this algorithm. More...
vtkPolyData *	GetOutput (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
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
	Check whether this algorithm has an assigned executive. More...
vtkExecutive *	GetExecutive ()
	Get this algorithm's executive. More...
virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive. More...
int	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...
vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port. More...
vtkInformation *	GetOutputPortInformation (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	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...
vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm. More...
void	RemoveAllInputs ()
	Remove all the input data. More...
vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port. More...
vtkDataObject *	GetInputDataObject (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)
vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm. More...
vtkAlgorithmOutput *	GetOutputPort ()
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...
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair. More...
vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0). More...
vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection. More...
vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0) More...
vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection. More...
vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0) More...
vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port. More...
virtual int	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 int	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]=0)
	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]=0)
	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...
int	SetUpdateExtentToWholeExtent (int port)
	If the whole output extent is required, this method can be called to set the output update extent to the whole extent. More...
int	SetUpdateExtentToWholeExtent ()
	Convenience function equivalent to SetUpdateExtentToWholeExtent(0) This method assumes that the whole extent is known (that UpdateInformation has been called). More...
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
	Set the output update extent in terms of piece and ghost levels. More...
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
	Convenience function equivalent to SetUpdateExtent(0, piece, numPieces, ghostLevel) More...
void	SetUpdateExtent (int port, int extent[6])
	Set the output update extent for data objects that use 3D extents. More...
void	SetUpdateExtent (int extent[6])
	Convenience function equivalent to SetUpdateExtent(0, extent) More...
virtual vtkInformation *	GetInformation ()
	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 (int)
	Set/Get the AbortExecute flag for the process object. More...
virtual int	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 void	SetProgress (double)
	Set/Get the execution progress of a process object. More...
virtual double	GetProgress ()
	Set/Get the execution progress of a process object. 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 vtkProgressObserver *	GetProgressObserver ()
	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 ()
int	HasObserver (unsigned long event)
int	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...
vtkCommand *	GetCommand (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...
int	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
int	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 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...
void	PrintRevisions (ostream &)
	Legacy. 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
	vtkVoxelGrid ()
	~vtkVoxelGrid ()
virtual int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
	This is called by the superclass. More...
virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm. More...
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...
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
	This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
virtual vtkExecutive *	CreateDefaultExecutive ()
	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...
vtkDataArray *	GetInputArrayToProcess (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...
vtkDataArray *	GetInputArrayToProcess (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...
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (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...
vtkAbstractArray *	GetInputAbstractArrayToProcess (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...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
	Filters that have multiple connections on one port can use this signature. More...
vtkAbstractArray *	GetInputAbstractArrayToProcess (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=NULL)
	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 ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
vtkStaticPointLocator *	Locator
int	ConfigurationStyle
int	Divisions [3]
double	LeafSize [3]
int	NumberOfPointsPerBin
vtkInterpolationKernel *	Kernel
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
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
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkPolyDataAlgorithm	Superclass
	Standard methods for instantiating, obtaining type information, and printing information. More...
static vtkVoxelGrid *	New ()
	Standard methods for instantiating, obtaining type information, and printing information. More...
static int	IsTypeOf (const char *type)
	Standard methods for instantiating, obtaining type information, and printing information. More...
static vtkVoxelGrid *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiating, obtaining type information, and printing information. More...
virtual int	IsA (const char *type)
	Standard methods for instantiating, obtaining type information, and printing information. More...
vtkVoxelGrid *	NewInstance () const
	Standard methods for instantiating, obtaining type information, and printing information. More...
void	PrintSelf (ostream &os, vtkIndent indent)
	Standard methods for instantiating, obtaining type information, and printing information. More...
virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiating, obtaining type information, and printing information. More...

Additional Inherited Members
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements. More...
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
static vtkInformationIntegerKey *	CAN_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 vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

Detailed Description

subsample points using uniform binning

vtkVoxelGrid is a filter that subsamples a point cloud based on a regular binning of space. Basically the algorithm operates by dividing space into a volume of M x N x O bins, and then for each bin averaging all of the points positions into a single representive point. Several strategies for computing the binning can be used: 1) manual configuration of a requiring specifying bin dimensions (the bounds are calculated from the data); 2) by explicit specification of the bin size in world coordinates (x-y-z lengths); and 3) an automatic process in which the user specifies an approximate, average number of points per bin and dimensions and bin size are computed automatically. (Note that under the hood a vtkStaticPointLocator is used.)

While any vtkPointSet type can be provided as input, the output is represented by an explicit representation of points via a vtkPolyData. This output polydata will populate its instance of vtkPoints, but no cells will be defined (i.e., no vtkVertex or vtkPolyVertex are contained in the output).

Warning

This class has been threaded with vtkSMPTools. Using TBB or other non-sequential type (set in the CMake variable VTK_SMP_IMPLEMENTATION_TYPE) may improve performance significantly.

See also

vtkStaticPointLocator vtkPointCloudFilter vtkQuadricClustering

Tests:

vtkVoxelGrid (Tests)

Definition at line 60 of file vtkVoxelGrid.h.

Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkVoxelGrid::Superclass

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

Definition at line 69 of file vtkVoxelGrid.h.

Member Enumeration Documentation

enum vtkVoxelGrid::Style

This enum is used to configure the operation of the filter.

Enumerator
MANUAL
SPECIFY_LEAF_SIZE
AUTOMATIC

Definition at line 76 of file vtkVoxelGrid.h.

Constructor & Destructor Documentation

vtkVoxelGrid::vtkVoxelGrid ( )

protected

vtkVoxelGrid::~vtkVoxelGrid ( )

protected

Member Function Documentation

static vtkVoxelGrid* vtkVoxelGrid::New ( )

static

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

static int vtkVoxelGrid::IsTypeOf ( const char *  type )

static

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

virtual int vtkVoxelGrid::IsA ( const char *  type )

virtual

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

Reimplemented from vtkPolyDataAlgorithm.

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

static

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

virtual vtkObjectBase* vtkVoxelGrid::NewInstanceInternal ( ) const

protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

vtkVoxelGrid* vtkVoxelGrid::NewInstance

(

)

const

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

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

virtual

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

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkVoxelGrid::SetConfigurationStyle ( int  )

virtual

Configure how the filter is to operate.

The user can choose to manually specify the binning volume (by setting its dimensions via MANUAL style); or specify a leaf bin size in the x-y-z directions (SPECIFY_LEAF_SIZE); or in AUTOMATIC style, use a rough average number of points in each bin guide the bin size and binning volume dimensions. By default, AUTOMATIC configuration style is used.

virtual int vtkVoxelGrid::GetConfigurationStyle ( )

virtual

Configure how the filter is to operate.

The user can choose to manually specify the binning volume (by setting its dimensions via MANUAL style); or specify a leaf bin size in the x-y-z directions (SPECIFY_LEAF_SIZE); or in AUTOMATIC style, use a rough average number of points in each bin guide the bin size and binning volume dimensions. By default, AUTOMATIC configuration style is used.

void vtkVoxelGrid::SetConfigurationStyleToManual ( )

inline

Configure how the filter is to operate.

The user can choose to manually specify the binning volume (by setting its dimensions via MANUAL style); or specify a leaf bin size in the x-y-z directions (SPECIFY_LEAF_SIZE); or in AUTOMATIC style, use a rough average number of points in each bin guide the bin size and binning volume dimensions. By default, AUTOMATIC configuration style is used.

Definition at line 94 of file vtkVoxelGrid.h.

void vtkVoxelGrid::SetConfigurationStyleToLeafSize ( )

inline

Configure how the filter is to operate.

The user can choose to manually specify the binning volume (by setting its dimensions via MANUAL style); or specify a leaf bin size in the x-y-z directions (SPECIFY_LEAF_SIZE); or in AUTOMATIC style, use a rough average number of points in each bin guide the bin size and binning volume dimensions. By default, AUTOMATIC configuration style is used.

Definition at line 96 of file vtkVoxelGrid.h.

void vtkVoxelGrid::SetConfigurationStyleToAutomatic ( )

inline

Configure how the filter is to operate.

The user can choose to manually specify the binning volume (by setting its dimensions via MANUAL style); or specify a leaf bin size in the x-y-z directions (SPECIFY_LEAF_SIZE); or in AUTOMATIC style, use a rough average number of points in each bin guide the bin size and binning volume dimensions. By default, AUTOMATIC configuration style is used.

Definition at line 98 of file vtkVoxelGrid.h.

virtual void vtkVoxelGrid::SetDivisions ( int  , int  , int    )

virtual

Set the number of divisions in x-y-z directions (the binning volume dimensions).

This data member is used when the configuration style is set to MANUAL.

virtual void vtkVoxelGrid::SetDivisions ( int  [3] )

virtual

Set the number of divisions in x-y-z directions (the binning volume dimensions).

This data member is used when the configuration style is set to MANUAL.

virtual int* vtkVoxelGrid::GetDivisions ( )

virtual

Set the number of divisions in x-y-z directions (the binning volume dimensions).

This data member is used when the configuration style is set to MANUAL.

virtual void vtkVoxelGrid::GetDivisions ( int  data[3] )

virtual

Set the number of divisions in x-y-z directions (the binning volume dimensions).

This data member is used when the configuration style is set to MANUAL.

virtual void vtkVoxelGrid::SetLeafSize ( double  , double  , double    )

virtual

Set the bin size in the x-y-z directions.

This data member is used when the configuration style is set to SPECIFY_LEAF_SIZE. The class will use these x-y-z lengths, within the bounding box of the point cloud, to determine the binning dimensions.

virtual void vtkVoxelGrid::SetLeafSize ( double  [3] )

virtual

Set the bin size in the x-y-z directions.

This data member is used when the configuration style is set to SPECIFY_LEAF_SIZE. The class will use these x-y-z lengths, within the bounding box of the point cloud, to determine the binning dimensions.

virtual double* vtkVoxelGrid::GetLeafSize ( )

virtual

Set the bin size in the x-y-z directions.

This data member is used when the configuration style is set to SPECIFY_LEAF_SIZE. The class will use these x-y-z lengths, within the bounding box of the point cloud, to determine the binning dimensions.

virtual void vtkVoxelGrid::GetLeafSize ( double  data[3] )

virtual

Set the bin size in the x-y-z directions.

This data member is used when the configuration style is set to SPECIFY_LEAF_SIZE. The class will use these x-y-z lengths, within the bounding box of the point cloud, to determine the binning dimensions.

virtual void vtkVoxelGrid::SetNumberOfPointsPerBin ( int  )

virtual

Specify the average number of points in each bin.

Larger values result in higher rates of subsampling. This data member is used when the configuration style is set to AUTOMATIC. The class will automatically determine the binning dimensions in the x-y-z directions.

virtual int vtkVoxelGrid::GetNumberOfPointsPerBin ( )

virtual

Specify the average number of points in each bin.

Larger values result in higher rates of subsampling. This data member is used when the configuration style is set to AUTOMATIC. The class will automatically determine the binning dimensions in the x-y-z directions.

void vtkVoxelGrid::SetKernel

(

vtkInterpolationKernel *

kernel

)

Specify an interpolation kernel to combine the point attributes.

By default a vtkLinearKernel is used (i.e., average values). The interpolation kernel changes the basis of the interpolation.

virtual vtkInterpolationKernel* vtkVoxelGrid::GetKernel ( )

virtual

Specify an interpolation kernel to combine the point attributes.

By default a vtkLinearKernel is used (i.e., average values). The interpolation kernel changes the basis of the interpolation.

virtual int vtkVoxelGrid::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkVoxelGrid::FillInputPortInformation ( int  port, vtkInformation *  info  )

protectedvirtual

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.

Member Data Documentation

vtkStaticPointLocator* vtkVoxelGrid::Locator

protected

Definition at line 148 of file vtkVoxelGrid.h.

int vtkVoxelGrid::ConfigurationStyle

protected

Definition at line 149 of file vtkVoxelGrid.h.

int vtkVoxelGrid::Divisions[3]

protected

Definition at line 151 of file vtkVoxelGrid.h.

double vtkVoxelGrid::LeafSize[3]

protected

Definition at line 152 of file vtkVoxelGrid.h.

int vtkVoxelGrid::NumberOfPointsPerBin

protected

Definition at line 153 of file vtkVoxelGrid.h.

vtkInterpolationKernel* vtkVoxelGrid::Kernel

protected

Definition at line 154 of file vtkVoxelGrid.h.

---

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

• /home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Filters/Points/vtkVoxelGrid.h