VTK  9.2.20220706
vtkPointDensityFilter Class Reference

produce density field from input point cloud More...

#include <vtkPointDensityFilter.h>

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

## Public Types

enum  FunctionClass { ZERO = 0 , NON_ZERO = 1 }
This enum is used to classify the behavior of the function gradient. More...

Public Types inherited from vtkImageAlgorithm
typedef vtkAlgorithm Superclass

Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION , DOUBLE_PRECISION , DEFAULT_PRECISION }
Values used for setting the desired output precision for various algorithms. More...

typedef vtkObject Superclass

## Public Member Functions

void SetSampleDimensions (int i, int j, int k)
Set / get the dimensions of the sampling volume. More...

void SetSampleDimensions (int dim[3])
Set / get the dimensions of the sampling volume. More...

virtual int * GetSampleDimensions ()
Set / get the dimensions of the sampling volume. More...

virtual void GetSampleDimensions (int data[3])
Set / get the dimensions of the sampling volume. More...

virtual void SetModelBounds (double, double, double, double, double, double)
Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...

virtual void SetModelBounds (double[6])
Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...

virtual double * GetModelBounds ()
Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...

virtual void GetModelBounds (double data[6])
Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. More...

Set / get the relative amount to pad the model bounds if automatic computation is performed. More...

Set / get the relative amount to pad the model bounds if automatic computation is performed. More...

virtual void SetDensityEstimate (int)
Specify the method to estimate point density. More...

virtual int GetDensityEstimate ()
Specify the method to estimate point density. More...

Specify the method to estimate point density. More...

Specify the method to estimate point density. More...

const char * GetDensityEstimateAsString ()
Specify the method to estimate point density. More...

virtual void SetDensityForm (int)
Specify the form by which the density is expressed. More...

virtual int GetDensityForm ()
Specify the form by which the density is expressed. More...

void SetDensityFormToVolumeNormalized ()
Specify the form by which the density is expressed. More...

void SetDensityFormToNumberOfPoints ()
Specify the form by which the density is expressed. More...

const char * GetDensityFormAsString ()
Specify the form by which the density is expressed. More...

Set / get the radius variable defining the local sphere used to estimate the density function. More...

Set / get the radius variable defining the local sphere used to estimate the density function. More...

Set / get the relative radius factor defining the local sphere used to estimate the density function. More...

Set / get the relative radius factor defining the local sphere used to estimate the density function. More...

virtual void SetScalarWeighting (bool)
Turn on/off the weighting of point density by a scalar array. More...

virtual bool GetScalarWeighting ()
Turn on/off the weighting of point density by a scalar array. More...

virtual void ScalarWeightingOn ()
Turn on/off the weighting of point density by a scalar array. More...

virtual void ScalarWeightingOff ()
Turn on/off the weighting of point density by a scalar array. More...

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar. More...

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar. More...

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar. More...

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar. More...

void SetLocator (vtkAbstractPointLocator *locator)
Specify a point locator. More...

virtual vtkAbstractPointLocatorGetLocator ()
Specify a point locator. More...

Public Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithmNewInstance () const

vtkTypeBool ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Process a request from the executive. More...

vtkImageDataGetOutput ()
Get the output data object for a port on this algorithm. More...

vtkImageDataGetOutput (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...

vtkDataObjectGetInput (int port)
Get a data object for one of the input port connections. More...

vtkDataObjectGetInput ()
Get a data object for one of the input port connections. More...

vtkImageDataGetImageDataInput (int port)
Get a data object for one of the input port connections. More...

Assign a data object as input. More...

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

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

bool UsesGarbageCollector () const override
Participate in garbage collection. More...

virtual void SetAbortExecute (vtkTypeBool)
Set/Get the AbortExecute flag for the process object. More...

virtual vtkTypeBool GetAbortExecute ()
Set/Get the AbortExecute flag for the process object. More...

virtual void AbortExecuteOn ()
Set/Get the AbortExecute flag for the process object. More...

virtual void AbortExecuteOff ()
Set/Get the AbortExecute flag for the process object. More...

virtual double GetProgress ()
Get the execution progress of a process object. More...

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

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)

std::string GetObjectDescription () const override
The object description printed in messages and PrintSelf output. More...

unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommandGetCommand (unsigned long tag)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void RemoveObserver (vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void RemoveObservers (unsigned long event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void RemoveObservers (const char *event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool HasObserver (const char *event, vtkCommand *)
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)

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

virtual void SetObjectName (const std::string &objectName)
Set/get the name of this object for reporting purposes. More...

virtual std::string GetObjectName () const
Set/get the name of this object for reporting purposes. More...

Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
Return the class name as a string. More...

virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void Delete ()
Delete a VTK object. More...

virtual void FastDelete ()
Delete a reference to this object. More...

void InitializeObjectBase ()

void Print (ostream &os)
Print an object to an ostream. More...

virtual void Register (vtkObjectBase *o)
Increase the reference count (mark as used by another object). More...

virtual void UnRegister (vtkObjectBase *o)
Decrease the reference count (release by another object). More...

int GetReferenceCount ()
Return the current reference count of this object. More...

void SetReferenceCount (int)
Sets the reference count. More...

bool GetIsInMemkind () const
A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void PrintHeader (ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses. More...

virtual void PrintTrailer (ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses. More...

## Protected Member Functions

vtkPointDensityFilter ()

~vtkPointDensityFilter () override

int FillInputPortInformation (int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single output. More...

int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
Subclasses can reimplement this method to collect information from their inputs and set information for their outputs. More...

int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
This is called in response to a REQUEST_DATA request from the executive. More...

void ComputeModelBounds (vtkDataSet *input, vtkImageData *output, vtkInformation *outInfo)

Protected Member Functions inherited from vtkImageAlgorithm
vtkImageAlgorithm ()

~vtkImageAlgorithm () override

virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Subclasses can reimplement this method to translate the update extent requests from each output port into update extent requests for the input connections. More...

virtual void CopyInputArrayAttributesToOutput (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
Convenience method to copy the scalar type and number of components from the input data to the output data. More...

virtual void ExecuteDataWithInformation (vtkDataObject *output, vtkInformation *outInfo)
This is a convenience method that is implemented in many subclasses instead of RequestData. More...

virtual void CopyAttributeData (vtkImageData *in, vtkImageData *out, vtkInformationVector **inputVector)
Copy the other point and cell data. More...

virtual void ExecuteData (vtkDataObject *output)
This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...

virtual void Execute ()
This method is the old style execute method, provided for the sake of backwards compatibility with older filters and readers. More...

virtual void AllocateOutputData (vtkImageData *out, vtkInformation *outInfo, int *uExtent)
Allocate the output data. More...

virtual vtkImageDataAllocateOutputData (vtkDataObject *out, vtkInformation *outInfo)
Allocate the output data. More...

int FillOutputPortInformation (int port, vtkInformation *info) override
These method should be reimplemented by subclasses that have more than a single input or single output. 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 association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...

virtual vtkExecutiveCreateDefaultExecutive ()
Create a default executive. More...

void ReportReferences (vtkGarbageCollector *) override

virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
Replace the Nth connection on the given input port. More...

virtual void SetNumberOfInputConnections (int port, int n)
Set the number of input connections on the given input port. More...

void SetInputDataInternal (int port, vtkDataObject *input)
These methods are used by subclasses to implement methods to set data objects directly as input. More...

void AddInputDataInternal (int port, vtkDataObject *input)

int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature. More...

int GetInputArrayAssociation (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature. More...

vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature. More...

vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature. More...

vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature. More...

vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
Filters that have multiple connections on one port can use this signature. More...

vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
Filters that have multiple connections on one port can use this signature. More...

virtual void SetErrorCode (unsigned long)
The error code contains a possible error that occurred while reading or writing the file. More...

Protected Member Functions inherited from vtkObject
vtkObject ()

~vtkObject () override

void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
These methods allow a command to exclusively grab all events. More...

void InternalReleaseFocus ()
These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
vtkObjectBase ()

virtual ~vtkObjectBase ()

vtkObjectBase (const vtkObjectBase &)

void operator= (const vtkObjectBase &)

## Protected Attributes

int SampleDimensions [3]

double ModelBounds [6]

double Origin [3]

double Spacing [3]

int DensityEstimate

int DensityForm

bool ScalarWeighting

vtkAbstractPointLocatorLocator

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

std::string ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount

vtkWeakPointerBase ** WeakPointers

typedef vtkImageAlgorithm Superclass
Standard methods for instantiating, obtaining type information, and printing information. More...

static vtkPointDensityFilterNew ()
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 vtkPointDensityFilterSafeDownCast (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...

vtkPointDensityFilterNewInstance () 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...

Static Public Member Functions inherited from vtkImageAlgorithm
static vtkTypeBool IsTypeOf (const char *type)

static vtkImageAlgorithmSafeDownCast (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

produce density field from input point cloud

vtkPointDensityFilter is a filter that generates a density field on a volume from a point cloud. Basically the density is computed as number of points in a local neighborhood per unit volume; or optionally, the number of points in a local neighborhood surrounding each voxel. The local neighborhood is specified as a radius around each sample position (i.e., each voxel) which can be of fixed value; or the radius can be relative to the voxel size. The density computation may be further weighted by a scalar value which is simply multiplied by each point's presumed density of 1.0.

To use this filter, specify an input of type vtkPointSet (i.e., has an explicit representation of points). Optionally a scalar weighting function can be provided (part of the input to the filter). Then specify how the local spherical neighborhood is to be defined, either by a fixed radius or a radius relative to the voxel size. Finally, specify how the density is specified, either as a points/volume, or as number of points. (The weighting scalar array will affect both of these results if provided and enabled.)

An optional capability of the filter is to compute the gradients of the resulting density function (a 3-component vector), which also includes the gradient magnitude (single component scalar) and classification (regions of zero function, a scalar with single unsigned char value per voxel).

Warning
A point locator is used to speed up searches. By default a fast vtkStaticPointLocator is used; however the user may specify an alternative locator. In some situations adaptive locators may run faster depending on the relative variation in point cloud density.
Note that the volume calculation can be affected by the boundary. The local spherical neighborhood around a "near volume boundary" voxel may extend beyond the volume extent, meaning that density computation may be reduced. To counter this effect, the volume may be increased in size and/or resolution so that the point cloud fits well within the volume.
While this class is very similar to many other of VTK's the point splatting and interpolation classes, the algorithm density computation is specialized to generate the density computation over a volume, does not require (scalar weighting) data attributes to run, and does not require multiple inputs. As an interesting side note: using the vtkPointInterpolation class with a vtkLinearKernel, a (scalar) weighting point attribute, a point cloud source, and an input volume produces the same result as this filter does (assuming that the input volume is the same).
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.
vtkCheckerboardSplatter vtkShepardMethod vtkGaussianSplatter vtkPointInterpolator vtkSPHInterpolator
Tests:
vtkPointDensityFilter (Tests)

Definition at line 94 of file vtkPointDensityFilter.h.

## ◆ Superclass

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

Definition at line 103 of file vtkPointDensityFilter.h.

## ◆ FunctionClass

This enum is used to classify the behavior of the function gradient.

Regions where all density values used in the calculation of the gradient are zero are referred to as ZERO regions. Otherwise NON_ZERO. This can be used to differentiate between regions where data is available and where it is not.

Enumerator
ZERO
NON_ZERO

Definition at line 235 of file vtkPointDensityFilter.h.

## ◆ vtkPointDensityFilter()

 vtkPointDensityFilter::vtkPointDensityFilter ( )
protected

## ◆ ~vtkPointDensityFilter()

 vtkPointDensityFilter::~vtkPointDensityFilter ( )
overrideprotected

## ◆ New()

 static vtkPointDensityFilter* vtkPointDensityFilter::New ( )
static

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

## ◆ IsTypeOf()

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

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

## ◆ IsA()

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

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

Reimplemented from vtkImageAlgorithm.

## ◆ SafeDownCast()

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

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

## ◆ NewInstanceInternal()

 virtual vtkObjectBase* vtkPointDensityFilter::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkImageAlgorithm.

## ◆ NewInstance()

 vtkPointDensityFilter* vtkPointDensityFilter::NewInstance ( ) const

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

## ◆ PrintSelf()

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

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

Reimplemented from vtkImageAlgorithm.

## ◆ SetSampleDimensions() [1/2]

 void vtkPointDensityFilter::SetSampleDimensions ( int i, int j, int k )

Set / get the dimensions of the sampling volume.

Higher values generally produce better results but may be much slower. Note however that too high a resolution can generate excessive noise; too low and data can be excessively smoothed.

## ◆ SetSampleDimensions() [2/2]

 void vtkPointDensityFilter::SetSampleDimensions ( int dim[3] )

Set / get the dimensions of the sampling volume.

Higher values generally produce better results but may be much slower. Note however that too high a resolution can generate excessive noise; too low and data can be excessively smoothed.

## ◆ GetSampleDimensions() [1/2]

 virtual int* vtkPointDensityFilter::GetSampleDimensions ( )
virtual

Set / get the dimensions of the sampling volume.

Higher values generally produce better results but may be much slower. Note however that too high a resolution can generate excessive noise; too low and data can be excessively smoothed.

## ◆ GetSampleDimensions() [2/2]

 virtual void vtkPointDensityFilter::GetSampleDimensions ( int data[3] )
virtual

Set / get the dimensions of the sampling volume.

Higher values generally produce better results but may be much slower. Note however that too high a resolution can generate excessive noise; too low and data can be excessively smoothed.

## ◆ SetModelBounds() [1/2]

 virtual void vtkPointDensityFilter::SetModelBounds ( double , double , double , double , double , double )
virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed.

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

## ◆ SetModelBounds() [2/2]

 virtual void vtkPointDensityFilter::SetModelBounds ( double [6] )
virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed.

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

## ◆ GetModelBounds() [1/2]

 virtual double* vtkPointDensityFilter::GetModelBounds ( )
virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed.

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

## ◆ GetModelBounds() [2/2]

 virtual void vtkPointDensityFilter::GetModelBounds ( double data[6] )
virtual

Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed.

If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used.

 virtual void vtkPointDensityFilter::SetAdjustDistance ( double )
virtual

Set / get the relative amount to pad the model bounds if automatic computation is performed.

The padding is the fraction to scale the model bounds in each of the x-y-z directions. By default the padding is 0.10 (i.e., 10% larger in each direction).

virtual

Set / get the relative amount to pad the model bounds if automatic computation is performed.

The padding is the fraction to scale the model bounds in each of the x-y-z directions. By default the padding is 0.10 (i.e., 10% larger in each direction).

## ◆ SetDensityEstimate()

 virtual void vtkPointDensityFilter::SetDensityEstimate ( int )
virtual

Specify the method to estimate point density.

The density can be calculated using a fixed sphere radius; or a sphere radius that is relative to voxel size.

## ◆ GetDensityEstimate()

 virtual int vtkPointDensityFilter::GetDensityEstimate ( )
virtual

Specify the method to estimate point density.

The density can be calculated using a fixed sphere radius; or a sphere radius that is relative to voxel size.

inline

Specify the method to estimate point density.

The density can be calculated using a fixed sphere radius; or a sphere radius that is relative to voxel size.

Definition at line 150 of file vtkPointDensityFilter.h.

inline

Specify the method to estimate point density.

The density can be calculated using a fixed sphere radius; or a sphere radius that is relative to voxel size.

Definition at line 154 of file vtkPointDensityFilter.h.

## ◆ GetDensityEstimateAsString()

 const char* vtkPointDensityFilter::GetDensityEstimateAsString ( )

Specify the method to estimate point density.

The density can be calculated using a fixed sphere radius; or a sphere radius that is relative to voxel size.

## ◆ SetDensityForm()

 virtual void vtkPointDensityFilter::SetDensityForm ( int )
virtual

Specify the form by which the density is expressed.

Either the density is expressed as (number of points/local sphere volume), or as simply the (number of points) within the local sphere.

## ◆ GetDensityForm()

 virtual int vtkPointDensityFilter::GetDensityForm ( )
virtual

Specify the form by which the density is expressed.

Either the density is expressed as (number of points/local sphere volume), or as simply the (number of points) within the local sphere.

## ◆ SetDensityFormToVolumeNormalized()

 void vtkPointDensityFilter::SetDensityFormToVolumeNormalized ( )
inline

Specify the form by which the density is expressed.

Either the density is expressed as (number of points/local sphere volume), or as simply the (number of points) within the local sphere.

Definition at line 169 of file vtkPointDensityFilter.h.

## ◆ SetDensityFormToNumberOfPoints()

 void vtkPointDensityFilter::SetDensityFormToNumberOfPoints ( )
inline

Specify the form by which the density is expressed.

Either the density is expressed as (number of points/local sphere volume), or as simply the (number of points) within the local sphere.

Definition at line 170 of file vtkPointDensityFilter.h.

## ◆ GetDensityFormAsString()

 const char* vtkPointDensityFilter::GetDensityFormAsString ( )

Specify the form by which the density is expressed.

Either the density is expressed as (number of points/local sphere volume), or as simply the (number of points) within the local sphere.

 virtual void vtkPointDensityFilter::SetRadius ( double )
virtual

Set / get the radius variable defining the local sphere used to estimate the density function.

The Radius is used when the density estimate is ^ set to a fixed radius (i.e., the radius doesn't change).

virtual

Set / get the radius variable defining the local sphere used to estimate the density function.

The Radius is used when the density estimate is ^ set to a fixed radius (i.e., the radius doesn't change).

 virtual void vtkPointDensityFilter::SetRelativeRadius ( double )
virtual

Set / get the relative radius factor defining the local sphere used to estimate the density function.

The relative sphere radius is equal to the diagonal length of a voxel times the radius factor. The RelativeRadius is used when the density estimate is set to relative radius (i.e., relative to voxel size).

virtual

Set / get the relative radius factor defining the local sphere used to estimate the density function.

The relative sphere radius is equal to the diagonal length of a voxel times the radius factor. The RelativeRadius is used when the density estimate is set to relative radius (i.e., relative to voxel size).

## ◆ SetScalarWeighting()

 virtual void vtkPointDensityFilter::SetScalarWeighting ( bool )
virtual

Turn on/off the weighting of point density by a scalar array.

By default scalar weighting is off.

## ◆ GetScalarWeighting()

 virtual bool vtkPointDensityFilter::GetScalarWeighting ( )
virtual

Turn on/off the weighting of point density by a scalar array.

By default scalar weighting is off.

## ◆ ScalarWeightingOn()

 virtual void vtkPointDensityFilter::ScalarWeightingOn ( )
virtual

Turn on/off the weighting of point density by a scalar array.

By default scalar weighting is off.

## ◆ ScalarWeightingOff()

 virtual void vtkPointDensityFilter::ScalarWeightingOff ( )
virtual

Turn on/off the weighting of point density by a scalar array.

By default scalar weighting is off.

 virtual void vtkPointDensityFilter::SetComputeGradient ( bool )
virtual

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar.

By default this is off. Note that this will increase execution time and the size of the output. (The names of these point data arrays are: "Gradient", "Gradient Magnitude", and "Classification".)

virtual

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar.

By default this is off. Note that this will increase execution time and the size of the output. (The names of these point data arrays are: "Gradient", "Gradient Magnitude", and "Classification".)

virtual

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar.

By default this is off. Note that this will increase execution time and the size of the output. (The names of these point data arrays are: "Gradient", "Gradient Magnitude", and "Classification".)

virtual

Turn on/off the generation of the gradient vector, gradient magnitude scalar, and function classification scalar.

By default this is off. Note that this will increase execution time and the size of the output. (The names of these point data arrays are: "Gradient", "Gradient Magnitude", and "Classification".)

## ◆ SetLocator()

 void vtkPointDensityFilter::SetLocator ( vtkAbstractPointLocator * locator )

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate near a specified interpolation position.

## ◆ GetLocator()

 virtual vtkAbstractPointLocator* vtkPointDensityFilter::GetLocator ( )
virtual

Specify a point locator.

By default a vtkStaticPointLocator is used. The locator performs efficient searches to locate near a specified interpolation position.

## ◆ FillInputPortInformation()

 int vtkPointDensityFilter::FillInputPortInformation ( int port, vtkInformation * info )
overrideprotectedvirtual

These method should be reimplemented by subclasses that have more than a single input or single output.

Reimplemented from vtkImageAlgorithm.

## ◆ RequestInformation()

 int vtkPointDensityFilter::RequestInformation ( vtkInformation * request, vtkInformationVector ** inputVector, vtkInformationVector * outputVector )
overrideprotectedvirtual

Subclasses can reimplement this method to collect information from their inputs and set information for their outputs.

Reimplemented from vtkImageAlgorithm.

## ◆ RequestData()

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

This is called in response to a REQUEST_DATA request from the executive.

Subclasses should override either this method or the ExecuteDataWithInformation method in order to generate data for their outputs. For images, the output arrays will already be allocated, so all that is necessary is to fill in the voxel values.

Reimplemented from vtkImageAlgorithm.

## ◆ ComputeModelBounds()

 void vtkPointDensityFilter::ComputeModelBounds ( vtkDataSet * input, vtkImageData * output, vtkInformation * outInfo )
protected

## ◆ SampleDimensions

 int vtkPointDensityFilter::SampleDimensions[3]
protected

Definition at line 245 of file vtkPointDensityFilter.h.

## ◆ ModelBounds

 double vtkPointDensityFilter::ModelBounds[6]
protected

Definition at line 246 of file vtkPointDensityFilter.h.

protected

Definition at line 247 of file vtkPointDensityFilter.h.

## ◆ Origin

 double vtkPointDensityFilter::Origin[3]
protected

Definition at line 248 of file vtkPointDensityFilter.h.

## ◆ Spacing

 double vtkPointDensityFilter::Spacing[3]
protected

Definition at line 248 of file vtkPointDensityFilter.h.

## ◆ DensityEstimate

 int vtkPointDensityFilter::DensityEstimate
protected

Definition at line 249 of file vtkPointDensityFilter.h.

## ◆ DensityForm

 int vtkPointDensityFilter::DensityForm
protected

Definition at line 250 of file vtkPointDensityFilter.h.

protected

Definition at line 251 of file vtkPointDensityFilter.h.

protected

Definition at line 252 of file vtkPointDensityFilter.h.

## ◆ ScalarWeighting

 bool vtkPointDensityFilter::ScalarWeighting
protected

Definition at line 253 of file vtkPointDensityFilter.h.