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

uniform binning of points into a hierarchical structure More...

#include <vtkHierarchicalBinningFilter.h>

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

Public Member Functions

int GetNumberOfGlobalBins ()
 Convenience methods for extracting useful information about this bin tree. More...
 
int GetNumberOfBins (int level)
 Convenience methods for extracting useful information about this bin tree. More...
 
vtkIdType GetLevelOffset (int level, vtkIdType &npts)
 Convenience methods for extracting useful information about this bin tree. More...
 
vtkIdType GetBinOffset (int globalBin, vtkIdType &npts)
 Convenience methods for extracting useful information about this bin tree. More...
 
vtkIdType GetLocalBinOffset (int level, int localBin, vtkIdType &npts)
 Convenience methods for extracting useful information about this bin tree. More...
 
void GetBinBounds (int globalBin, double bounds[6])
 Convenience methods for extracting useful information about a bin tree. More...
 
void GetLocalBinBounds (int level, int localBin, double bounds[6])
 Convenience methods for extracting useful information about a bin tree. More...
 
virtual void SetNumberOfLevels (int)
 Specify the number of levels in the spatial hierarchy. More...
 
virtual int GetNumberOfLevels ()
 Specify the number of levels in the spatial hierarchy. More...
 
virtual void SetAutomatic (bool)
 Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on). More...
 
virtual bool GetAutomatic ()
 Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on). More...
 
virtual void AutomaticOn ()
 Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on). More...
 
virtual void AutomaticOff ()
 Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on). More...
 
virtual void SetDivisions (int, int, int)
 Set the number of branching divisions in each binning direction. More...
 
virtual void SetDivisions (int[3])
 Set the number of branching divisions in each binning direction. More...
 
virtual intGetDivisions ()
 Set the number of branching divisions in each binning direction. More...
 
virtual void GetDivisions (int data[3])
 Set the number of branching divisions in each binning direction. More...
 
virtual void SetBounds (double, double, double, double, double, double)
 Set the bounding box of the point cloud. More...
 
virtual void SetBounds (double[6])
 Set the bounding box of the point cloud. More...
 
virtual doubleGetBounds ()
 Set the bounding box of the point cloud. More...
 
virtual void GetBounds (double data[6])
 Set the bounding box of the point cloud. More...
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
int 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...
 
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...
 
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 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]=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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (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 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

 vtkHierarchicalBinningFilter ()
 
 ~vtkHierarchicalBinningFilter () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called by the superclass. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
- Protected Member Functions inherited from 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 ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

int NumberOfLevels
 
bool Automatic
 
int Divisions [3]
 
double Bounds [6]
 
vtkBinTree * Tree
 
- 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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkPolyDataAlgorithm Superclass
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
static vtkHierarchicalBinningFilterNew ()
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
static vtkHierarchicalBinningFilterSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
vtkHierarchicalBinningFilterNewInstance () const
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiating, obtaining type information, and printing information. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiating, obtaining type information, and printing information. 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

uniform binning of points into a hierarchical structure

vtkHierarchicalBinningFilter creates a spatial, hierarchical ordering of input points. This hierarchy is suitable for level-of-detail rendering, or multiresolution processing. Each level of the hierarchy is based on uniform binning of space, where deeper levels (and its bins) are repeatedly subdivided by a given branching factor. Points are associated with bins at different levels, with the number of points in each level proportional to the number of bins in that level. The output points are sorted according to a bin number, where the bin number is unique, monotonically increasing number representing the breadth first ordering of all of the levels and their bins. Thus all points in a bin (or even a level) are segmented into contiguous runs.

Note that points are associated with different bins using a pseudo random process. No points are repeated, and no new points are created, thus the effect of executing this filter is simply to reorder the input points.

The algorithm proceeds as follows: Given an initial bounding box, the space is uniformally subdivided into bins of (M x N x O) dimensions; in turn each subsequent level in the tree is further divided into (M x N x O) bins (note that level 0 is a single, root bin). Thus the number of bins at level L of the hierarchical tree is: Nbins=(M^L x N^L x O^L). Once the binning is created to a specified depth, then points are placed in the bins using a pseudo-random sampling proportional to the number of bins in each level. All input points are sorted in the order described above, with no points repeated.

The output of this filter are sorted points and associated point attributes represented by a vtkPolyData. In addition, an offset integral array is associated with the field data of the output, providing offsets into the points list via a breadth-first traversal order. Metadata describing the output is provided in the field data. Convenience functions are also provided here to access the data in a particular bin or across a level. (Using the offset array directly may result in higher performance.)

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
vtkPointCloudFilter vtkQuadricClustering vtkStaticPointLocator
Tests:
vtkHierarchicalBinningFilter (Tests)

Definition at line 83 of file vtkHierarchicalBinningFilter.h.

Member Typedef Documentation

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

Definition at line 92 of file vtkHierarchicalBinningFilter.h.

Constructor & Destructor Documentation

vtkHierarchicalBinningFilter::vtkHierarchicalBinningFilter ( )
protected
vtkHierarchicalBinningFilter::~vtkHierarchicalBinningFilter ( )
overrideprotected

Member Function Documentation

static vtkHierarchicalBinningFilter* vtkHierarchicalBinningFilter::New ( )
static

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

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

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

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

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

Reimplemented from vtkPolyDataAlgorithm.

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

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

virtual vtkObjectBase* vtkHierarchicalBinningFilter::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

vtkHierarchicalBinningFilter* vtkHierarchicalBinningFilter::NewInstance ( ) const

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

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

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

Reimplemented from vtkPolyDataAlgorithm.

virtual void vtkHierarchicalBinningFilter::SetNumberOfLevels ( int  )
virtual

Specify the number of levels in the spatial hierarchy.

By default, the number of levels is three.

virtual int vtkHierarchicalBinningFilter::GetNumberOfLevels ( )
virtual

Specify the number of levels in the spatial hierarchy.

By default, the number of levels is three.

virtual void vtkHierarchicalBinningFilter::SetAutomatic ( bool  )
virtual

Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on).

If off, then the user must specify both the bounding box and bin divisions. (Computing the bounding box can be slow for large point clouds, manual specification can save time.)

virtual bool vtkHierarchicalBinningFilter::GetAutomatic ( )
virtual

Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on).

If off, then the user must specify both the bounding box and bin divisions. (Computing the bounding box can be slow for large point clouds, manual specification can save time.)

virtual void vtkHierarchicalBinningFilter::AutomaticOn ( )
virtual

Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on).

If off, then the user must specify both the bounding box and bin divisions. (Computing the bounding box can be slow for large point clouds, manual specification can save time.)

virtual void vtkHierarchicalBinningFilter::AutomaticOff ( )
virtual

Specify whether to determine the determine the level divisions, and the bounding box automatically (by default this is on).

If off, then the user must specify both the bounding box and bin divisions. (Computing the bounding box can be slow for large point clouds, manual specification can save time.)

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

Set the number of branching divisions in each binning direction.

Each level of the tree is subdivided by this factor. The Divisions[i] must be >= 1. Note: if Automatic subdivision is specified, the Divisions are set by the filter.

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

Set the number of branching divisions in each binning direction.

Each level of the tree is subdivided by this factor. The Divisions[i] must be >= 1. Note: if Automatic subdivision is specified, the Divisions are set by the filter.

virtual int* vtkHierarchicalBinningFilter::GetDivisions ( )
virtual

Set the number of branching divisions in each binning direction.

Each level of the tree is subdivided by this factor. The Divisions[i] must be >= 1. Note: if Automatic subdivision is specified, the Divisions are set by the filter.

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

Set the number of branching divisions in each binning direction.

Each level of the tree is subdivided by this factor. The Divisions[i] must be >= 1. Note: if Automatic subdivision is specified, the Divisions are set by the filter.

virtual void vtkHierarchicalBinningFilter::SetBounds ( double  ,
double  ,
double  ,
double  ,
double  ,
double   
)
virtual

Set the bounding box of the point cloud.

If Automatic is enabled, then this is computed during filter execution. If manually specified (Automatic is off) then make sure the bounds is represented as (xmin,xmax, ymin,ymax, zmin,zmax). If the bounds specified is does not enclose the points, then points are clamped to lie in the bounding box.

virtual void vtkHierarchicalBinningFilter::SetBounds ( double  [6])
virtual

Set the bounding box of the point cloud.

If Automatic is enabled, then this is computed during filter execution. If manually specified (Automatic is off) then make sure the bounds is represented as (xmin,xmax, ymin,ymax, zmin,zmax). If the bounds specified is does not enclose the points, then points are clamped to lie in the bounding box.

virtual double* vtkHierarchicalBinningFilter::GetBounds ( )
virtual

Set the bounding box of the point cloud.

If Automatic is enabled, then this is computed during filter execution. If manually specified (Automatic is off) then make sure the bounds is represented as (xmin,xmax, ymin,ymax, zmin,zmax). If the bounds specified is does not enclose the points, then points are clamped to lie in the bounding box.

virtual void vtkHierarchicalBinningFilter::GetBounds ( double  data[6])
virtual

Set the bounding box of the point cloud.

If Automatic is enabled, then this is computed during filter execution. If manually specified (Automatic is off) then make sure the bounds is represented as (xmin,xmax, ymin,ymax, zmin,zmax). If the bounds specified is does not enclose the points, then points are clamped to lie in the bounding box.

int vtkHierarchicalBinningFilter::GetNumberOfGlobalBins ( )

Convenience methods for extracting useful information about this bin tree.

Return the number of total bins across all levels (i.e., the total global bins). Invoke this method after the bin tree has been built.

int vtkHierarchicalBinningFilter::GetNumberOfBins ( int  level)

Convenience methods for extracting useful information about this bin tree.

Return the number of bins in a particular level of the tree. Invoke this method after the bin tree has been built.

vtkIdType vtkHierarchicalBinningFilter::GetLevelOffset ( int  level,
vtkIdType npts 
)

Convenience methods for extracting useful information about this bin tree.

Given a level, return the beginning point id and number of points that level. Invoke this method after the bin tree has been built.

vtkIdType vtkHierarchicalBinningFilter::GetBinOffset ( int  globalBin,
vtkIdType npts 
)

Convenience methods for extracting useful information about this bin tree.

Given a global bin number, return the point id and number of points for that bin. Invoke this method after the bin tree has been built.

vtkIdType vtkHierarchicalBinningFilter::GetLocalBinOffset ( int  level,
int  localBin,
vtkIdType npts 
)

Convenience methods for extracting useful information about this bin tree.

Given a level, and the bin number in that level, return the offset point id and number of points for that bin. Invoke this method after the bin tree has been built.

void vtkHierarchicalBinningFilter::GetBinBounds ( int  globalBin,
double  bounds[6] 
)

Convenience methods for extracting useful information about a bin tree.

Given a global bin number, return the bounds (xmin,xmax,ymin,ymax,zmin,zmax) for that bin. Invoke this method after the bin tree has been built.

void vtkHierarchicalBinningFilter::GetLocalBinBounds ( int  level,
int  localBin,
double  bounds[6] 
)

Convenience methods for extracting useful information about a bin tree.

Given a level, and a local bin number, return the bounds (xmin,xmax,ymin,ymax,zmin,zmax) for that bin. Invoke this method after the bin tree has been built.

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

This is called by the superclass.

This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkHierarchicalBinningFilter::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.

Member Data Documentation

int vtkHierarchicalBinningFilter::NumberOfLevels
protected

Definition at line 198 of file vtkHierarchicalBinningFilter.h.

bool vtkHierarchicalBinningFilter::Automatic
protected

Definition at line 199 of file vtkHierarchicalBinningFilter.h.

int vtkHierarchicalBinningFilter::Divisions[3]
protected

Definition at line 200 of file vtkHierarchicalBinningFilter.h.

double vtkHierarchicalBinningFilter::Bounds[6]
protected

Definition at line 201 of file vtkHierarchicalBinningFilter.h.

vtkBinTree* vtkHierarchicalBinningFilter::Tree
protected

Definition at line 205 of file vtkHierarchicalBinningFilter.h.


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