interpolate over point cloud using SPH kernels More...

#include <vtkSPHInterpolator.h>

Inheritance diagram for vtkSPHInterpolator:

Collaboration diagram for vtkSPHInterpolator:

Public Types
enum	NullStrategy { MASK_POINTS = 0 , NULL_VALUE = 1 }

Public Types inherited from vtkDataSetAlgorithm
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	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify the dataset Pc that will be probed by the input points P.

int	GetNumberOfExcludedArrays ()
	Return the number of excluded arrays.

int	GetNumberOfDerivativeArrays ()
	Return the number of derivative arrays.

vtkMTimeType	GetMTime () override
	Get the MTime of this object also considering the locator and kernel.


void	SetSourceData (vtkDataObject *source)
	Specify the dataset Pc that will be probed by the input points P.

vtkDataObject *	GetSource ()
	Specify the dataset Pc that will be probed by the input points P.


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

virtual vtkAbstractPointLocator *	GetLocator ()
	Specify a point locator.


void	SetKernel (vtkSPHKernel *kernel)
	Specify an interpolation kernel.

virtual vtkSPHKernel *	GetKernel ()
	Specify an interpolation kernel.


virtual void	SetCutoffArrayName (vtkStdString)
	Specify an (optional) cutoff distance for each point in the input P.

virtual vtkStdString	GetCutoffArrayName ()
	Specify an (optional) cutoff distance for each point in the input P.


virtual void	SetDensityArrayName (vtkStdString)
	Specify the density array name.

virtual vtkStdString	GetDensityArrayName ()
	Specify the density array name.


virtual void	SetMassArrayName (vtkStdString)
	Specify the mass array name.

virtual vtkStdString	GetMassArrayName ()
	Specify the mass array name.


void	AddExcludedArray (const vtkStdString &excludedArray)
	Adds an array to the list of arrays which are to be excluded from the interpolation process.


void	ClearExcludedArrays ()
	Clears the contents of excluded array list.


const char *	GetExcludedArray (int i)
	Return the name of the ith excluded array.


void	AddDerivativeArray (const vtkStdString &derivArray)
	Adds an array to the list of arrays whose derivative is to be taken.


void	ClearDerivativeArrays ()
	Clears the contents of derivative array list.


const char *	GetDerivativeArray (int i)
	Return the name of the ith derivative array.


virtual void	SetNullPointsStrategy (int)
	Specify a strategy to use when encountering a "null" point during the interpolation process.

virtual int	GetNullPointsStrategy ()
	Specify a strategy to use when encountering a "null" point during the interpolation process.

void	SetNullPointsStrategyToMaskPoints ()
	Specify a strategy to use when encountering a "null" point during the interpolation process.

void	SetNullPointsStrategyToNullValue ()
	Specify a strategy to use when encountering a "null" point during the interpolation process.


virtual void	SetValidPointsMaskArrayName (vtkStdString)
	If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point.

virtual vtkStdString	GetValidPointsMaskArrayName ()
	If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point.


virtual void	SetNullValue (double)
	Specify the null point value.

virtual double	GetNullValue ()
	Specify the null point value.


virtual void	SetComputeShepardSum (vtkTypeBool)
	Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

virtual void	ComputeShepardSumOn ()
	Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

virtual void	ComputeShepardSumOff ()
	Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

virtual vtkTypeBool	GetComputeShepardSum ()
	Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).


virtual void	SetShepardSumArrayName (vtkStdString)
	If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point.

virtual vtkStdString	GetShepardSumArrayName ()
	If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point.


virtual void	SetPromoteOutputArrays (vtkTypeBool)
	If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

virtual void	PromoteOutputArraysOn ()
	If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

virtual void	PromoteOutputArraysOff ()
	If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

virtual vtkTypeBool	GetPromoteOutputArrays ()
	If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.


virtual void	SetPassPointArrays (vtkTypeBool)
	Indicate whether to shallow copy the input point data arrays to the output.

virtual void	PassPointArraysOn ()
	Indicate whether to shallow copy the input point data arrays to the output.

virtual void	PassPointArraysOff ()
	Indicate whether to shallow copy the input point data arrays to the output.

virtual vtkTypeBool	GetPassPointArrays ()
	Indicate whether to shallow copy the input point data arrays to the output.


virtual void	SetPassCellArrays (vtkTypeBool)
	Indicate whether to shallow copy the input cell data arrays to the output.

virtual void	PassCellArraysOn ()
	Indicate whether to shallow copy the input cell data arrays to the output.

virtual void	PassCellArraysOff ()
	Indicate whether to shallow copy the input cell data arrays to the output.

virtual vtkTypeBool	GetPassCellArrays ()
	Indicate whether to shallow copy the input cell data arrays to the output.


virtual void	SetPassFieldArrays (vtkTypeBool)
	Indicate whether to pass the field-data arrays from the input to the output.

virtual void	PassFieldArraysOn ()
	Indicate whether to pass the field-data arrays from the input to the output.

virtual void	PassFieldArraysOff ()
	Indicate whether to pass the field-data arrays from the input to the output.

virtual vtkTypeBool	GetPassFieldArrays ()
	Indicate whether to pass the field-data arrays from the input to the output.


virtual void	SetShepardNormalization (vtkTypeBool)
	Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

virtual void	ShepardNormalizationOn ()
	Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

virtual void	ShepardNormalizationOff ()
	Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

virtual vtkTypeBool	GetShepardNormalization ()
	Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

Public Member Functions inherited from vtkDataSetAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkDataSetAlgorithm *	NewInstance () const

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

vtkDataObject *	GetInput ()
	Get the input data object.

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints.

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints.

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector) override
	see vtkAlgorithm for details

vtkDataSet *	GetOutput ()
	Get the output data object for a port on this algorithm.

vtkDataSet *	GetOutput (int)
	Get the output data object for a port on this algorithm.

void	SetInputData (vtkDataObject *)
	Assign a data object as input.

void	SetInputData (int, vtkDataObject *)
	Assign a data object as input.

void	SetInputData (vtkDataSet *)
	Assign a data object as input.

void	SetInputData (int, vtkDataSet *)
	Assign a data object as input.

void	AddInputData (vtkDataObject *)
	Assign a data object as input.

void	AddInputData (vtkDataSet *)
	Assign a data object as input.

void	AddInputData (int, vtkDataSet *)
	Assign a data object as input.

void	AddInputData (int, vtkDataObject *)
	Assign a data object as input.

Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAlgorithm *	NewInstance () const

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

int	HasExecutive ()
	Check whether this algorithm has an assigned executive.

vtkExecutive *	GetExecutive ()
	Get this algorithm's executive.

virtual void	SetExecutive (vtkExecutive *executive)
	Set this algorithm's executive.

virtual vtkTypeBool	ProcessRequest (vtkInformation request, vtkInformationVector inInfo, vtkInformationVector outInfo)
	Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.

vtkTypeBool	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)
	Version of ProcessRequest() that is wrapped.

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.

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.

vtkInformation *	GetInputPortInformation (int port)
	Get the information object associated with an input port.

vtkInformation *	GetOutputPortInformation (int port)
	Get the information object associated with an output port.

int	GetNumberOfInputPorts ()
	Get the number of input ports used by the algorithm.

int	GetNumberOfOutputPorts ()
	Get the number of output ports provided by the algorithm.

void	SetProgress (double)
	`SetProgress` is deprecated.

void	UpdateProgress (double amount)
	Update the progress of the process object.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)
	String based versions of SetInputArrayToProcess().

vtkInformation *	GetInputArrayInformation (int idx)
	Get the info object for the specified input array to this algorithm.

void	RemoveAllInputs ()
	Remove all the input data.

vtkDataObject *	GetOutputDataObject (int port)
	Get the data object that will contain the algorithm output for the given port.

vtkDataObject *	GetInputDataObject (int port, int connection)
	Get the data object that will contain the algorithm input for the given port and given connection.

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
	Remove a connection from the given input port index.

virtual void	RemoveInputConnection (int port, int idx)
	Remove a connection given by index idx.

virtual void	RemoveAllInputConnections (int port)
	Removes all input connections.

virtual void	SetInputDataObject (int port, vtkDataObject *data)
	Sets the data-object as an input on the given port index.

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)
	Add the data-object as an input to this given port.

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)
	Get a proxy object corresponding to the given output port of this algorithm.

vtkAlgorithmOutput *	GetOutputPort ()

int	GetNumberOfInputConnections (int port)
	Get the number of inputs currently connected to a port.

int	GetTotalNumberOfInputConnections ()
	Get the total number of inputs for this algorithm.

vtkAlgorithmOutput *	GetInputConnection (int port, int index)
	Get the algorithm output port connected to an input port.

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
	Returns the algorithm and the output port index of that algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm (int port, int index)
	Returns the algorithm connected to a port-index pair.

vtkAlgorithm *	GetInputAlgorithm ()
	Equivalent to GetInputAlgorithm(0, 0).

vtkExecutive *	GetInputExecutive (int port, int index)
	Returns the executive associated with a particular input connection.

vtkExecutive *	GetInputExecutive ()
	Equivalent to GetInputExecutive(0, 0)

vtkInformation *	GetInputInformation (int port, int index)
	Return the information object that is associated with a particular input connection.

vtkInformation *	GetInputInformation ()
	Equivalent to GetInputInformation(0, 0)

vtkInformation *	GetOutputInformation (int port)
	Return the information object that is associated with a particular output port.

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

virtual vtkTypeBool	Update (vtkInformation *requests)
	Convenience method to update an algorithm after passing requests to its first output port.

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.

virtual int	UpdateExtent (const int extents[6])
	Convenience method to update an algorithm after passing requests to its first output port.

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.

virtual void	UpdateInformation ()
	Bring the algorithm's information up-to-date.

virtual void	UpdateDataObject ()
	Create output object(s).

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

virtual void	UpdateWholeExtent ()
	Bring this algorithm's outputs up-to-date.

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
	Convenience routine to convert from a linear ordering of input connections to a port/connection pair.

virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this algorithm.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this algorithm.

void	Register (vtkObjectBase *o) override
	Participate in garbage collection.

void	UnRegister (vtkObjectBase *o) override
	Participate in garbage collection.

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

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

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

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

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

void	SetProgressShiftScale (double shift, double scale)
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressShift ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

virtual double	GetProgressScale ()
	Specify the shift and scale values to use to apply to the progress amount when `UpdateProgress` is called.

void	SetProgressText (const char *ptext)
	Set the current text message associated with the progress state.

virtual char *	GetProgressText ()
	Set the current text message associated with the progress state.

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

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
	Set the input data arrays that this algorithm will process.

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	SetInputConnection (vtkAlgorithmOutput *input)
	Set the connection for the given input port index.

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	AddInputConnection (vtkAlgorithmOutput *input)
	Add a connection to the given input port index.

virtual void	Update (int port)
	Bring this algorithm's outputs up-to-date.

virtual void	Update ()
	Bring this algorithm's outputs up-to-date.

virtual void	SetReleaseDataFlag (int)
	Turn release data flag on or off for all output ports.

virtual int	GetReleaseDataFlag ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOn ()
	Turn release data flag on or off for all output ports.

void	ReleaseDataFlagOff ()
	Turn release data flag on or off for all output ports.

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.

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.

int *	GetUpdateExtent ()
	These functions return the update extent for output ports that use 3D extents.

int *	GetUpdateExtent (int port)
	These functions return the update extent for output ports that use 3D extents.

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.

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.

void	GetUpdateExtent (int extent[6])
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int extent[6])
	These functions return the update extent for output ports that use 3D extents.

int	GetUpdatePiece ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdatePiece (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateNumberOfPieces (int port)
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel ()
	These functions return the update extent for output ports that use piece extents.

int	GetUpdateGhostLevel (int port)
	These functions return the update extent for output ports that use piece extents.

void	SetProgressObserver (vtkProgressObserver *)
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

virtual vtkProgressObserver *	GetProgressObserver ()
	If an ProgressObserver is set, the algorithm will report progress through it rather than directly.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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

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.

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

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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

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

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

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

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

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.

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.

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.

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

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

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Protected Member Functions
	vtkSPHInterpolator ()

	~vtkSPHInterpolator () override

int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks the algorithm to do its work.

int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when a request asks for Information.

int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector ) override
	This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

virtual void	Probe (vtkDataSet input, vtkDataSet source, vtkDataSet *output)
	Virtual for specialized subclass(es)

virtual void	PassAttributeData (vtkDataSet input, vtkDataObject source, vtkDataSet *output)
	Call at end of RequestData() to pass attribute data respecting the PassCellArrays, PassPointArrays, PassFieldArrays flags.

Protected Member Functions inherited from vtkDataSetAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () override=default

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)
	This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.

virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks for Information.

virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
	This is called within ProcessRequest when a request asks the algorithm to do its work.

int	FillOutputPortInformation (int port, vtkInformation *info) override
	Fill the output port information objects for this algorithm.

int	FillInputPortInformation (int port, vtkInformation *info) override
	Fill the input port information objects for this algorithm.

vtkDataObject *	GetInput (int port)

Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAlgorithm ()

	~vtkAlgorithm () override

virtual int	FillInputPortInformation (int port, vtkInformation *info)
	Fill the input port information objects for this algorithm.

virtual int	FillOutputPortInformation (int port, vtkInformation *info)
	Fill the output port information objects for this algorithm.

virtual void	SetNumberOfInputPorts (int n)
	Set the number of input ports used by the algorithm.

virtual void	SetNumberOfOutputPorts (int n)
	Set the number of output ports provided by the algorithm.

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.

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkAbstractPointLocator *	Locator

vtkSPHKernel *	Kernel

vtkStdString	CutoffArrayName

vtkStdString	DensityArrayName

vtkStdString	MassArrayName

std::vector< vtkStdString >	ExcludedArrays

std::vector< vtkStdString >	DerivArrays

vtkTypeBool	ShepardNormalization

int	NullPointsStrategy

double	NullValue

vtkStdString	ValidPointsMaskArrayName

vtkCharArray *	ValidPointsMask

vtkTypeBool	ComputeShepardSum

vtkStdString	ShepardSumArrayName

vtkTypeBool	PromoteOutputArrays

vtkTypeBool	PassCellArrays

vtkTypeBool	PassPointArrays

vtkTypeBool	PassFieldArrays

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode
	The error code contains a possible error that occurred while reading or writing the file.

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

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

static vtkSPHInterpolator *	New ()
	Standard methods for instantiating, obtaining type information, and printing.

static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instantiating, obtaining type information, and printing.

static vtkSPHInterpolator *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instantiating, obtaining type information, and printing.

virtual vtkTypeBool	IsA (const char *type)
	Standard methods for instantiating, obtaining type information, and printing.

vtkSPHInterpolator *	NewInstance () const
	Standard methods for instantiating, obtaining type information, and printing.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instantiating, obtaining type information, and printing.

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard methods for instantiating, obtaining type information, and printing.

Additional Inherited Members
Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
	Keys used to specify input port requirements.

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
	This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent.

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
	Key that tells the pipeline that a particular algorithm can or cannot handle piece request.

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
	If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Public Attributes inherited from vtkAlgorithm
vtkTypeBool	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_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 vtkExecutive *	DefaultExecutivePrototype

Detailed Description

interpolate over point cloud using SPH kernels

This filter uses SPH (smooth particle hydrodynamics) kernels to interpolate a data source onto an input structure. For example, while the data source is a set of particles, the data from these particles can be interpolated onto an input object such as a line, plane or volume. Then the output (which consists of the input structure plus interpolated data) can then be visualized using classical visualization techniques such as isocontouring, slicing, heat maps and so on.

To use this filter, besides setting the input P and source Pc, specify a point locator (which accelerates queries about points and their neighbors) and an interpolation kernel (a subclass of vtkSPHKernel). In addition, the name of the source's density and mass arrays can optionally be provided; however if not provided then the local volume is computed from the kernel's spatial step. Finally, a cutoff distance array can optionally be provided (as part of the input P point data) when the local neighborhood around each sample point varies. The cutoff distance defines a local neighborhood in which the points in that neighborhood are used to interpolate values. If not provided, then the cutoff distance is computed from the spatial step size times the cutoff factor (see vtkSPHKernel).

Other options to the filter include specifying which data attributes to interpolate from the source. By default, all data attributes contained in the source are interpolated. However, by adding array names to the exclusion list, these arrays will not be interpolated. Also, it is possible to use a SPH derivative formulation to interpolate from the source data attributes. This requires adding arrays (by name) to the derivative list, in which case the derivative formulation will be applied to create a new output array named "X_deriv" where X is the name of a source point attribute array.

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.; For widely spaced points in Pc, or when p is located outside the bounding region of Pc, the interpolation may behave badly and the interpolation process will adapt as necessary to produce output. For example, if the N closest points within R are requested to interpolate p, if N=0 then the interpolation will switch to a different strategy (which can be controlled as in the NullPointsStrategy).; For more information and technical reference, see D.J. Price, Smoothed particle hydrodynamics and magnetohydrodynamics, J. Comput. Phys. 231:759-794, 2012. Especially equation 49.

Acknowledgments:: The following work has been generously supported by Altair Engineering and FluiDyna GmbH. Please contact Steve Cosgrove or Milos Stanic for more information.

See also: vtkPointInterpolator vtkSPHKernel vtkSPHQuinticKernel

Definition at line 92 of file vtkSPHInterpolator.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSetAlgorithm vtkSPHInterpolator::Superclass

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

Definition at line 101 of file vtkSPHInterpolator.h.

Member Enumeration Documentation

◆ NullStrategy

enum vtkSPHInterpolator::NullStrategy

Enumerator
MASK_POINTS
NULL_VALUE

Definition at line 263 of file vtkSPHInterpolator.h.

Constructor & Destructor Documentation

◆ vtkSPHInterpolator()

vtkSPHInterpolator::vtkSPHInterpolator ( )

protected

◆ ~vtkSPHInterpolator()

vtkSPHInterpolator::~vtkSPHInterpolator ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkSPHInterpolator * vtkSPHInterpolator::New ( )

static

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

◆ IsTypeOf()

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

static

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

◆ IsA()

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

virtual

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

Reimplemented from vtkDataSetAlgorithm.

◆ SafeDownCast()

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

static

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkSPHInterpolator::NewInstanceInternal ( ) const

protectedvirtual

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

Reimplemented from vtkDataSetAlgorithm.

◆ NewInstance()

vtkSPHInterpolator * vtkSPHInterpolator::NewInstance ( ) const

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

◆ PrintSelf()

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

overridevirtual

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

Reimplemented from vtkDataSetAlgorithm.

◆ SetSourceData()

void vtkSPHInterpolator::SetSourceData ( vtkDataObject * source )

Specify the dataset Pc that will be probed by the input points P.

The Input P defines the dataset structure (the points and cells) for the output, while the Source Pc is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ GetSource()

vtkDataObject * vtkSPHInterpolator::GetSource ( )

Specify the dataset Pc that will be probed by the input points P.

The Input P defines the dataset structure (the points and cells) for the output, while the Source Pc is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ SetSourceConnection()

void vtkSPHInterpolator::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

Specify the dataset Pc that will be probed by the input points P.

The Input P defines the structure (the points and cells) for the output, while the Source Pc is probed (interpolated) to generate the scalars, vectors, etc. for the output points based on the point locations.

◆ SetLocator()

void vtkSPHInterpolator::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 * vtkSPHInterpolator::GetLocator ( )

virtual

Specify a point locator.

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

◆ SetKernel()

void vtkSPHInterpolator::SetKernel ( vtkSPHKernel * kernel )

Specify an interpolation kernel.

By default a vtkSPHQuinticKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation.

◆ GetKernel()

virtual vtkSPHKernel * vtkSPHInterpolator::GetKernel ( )

virtual

Specify an interpolation kernel.

By default a vtkSPHQuinticKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation.

◆ SetCutoffArrayName()

virtual void vtkSPHInterpolator::SetCutoffArrayName ( vtkStdString )

virtual

Specify an (optional) cutoff distance for each point in the input P.

If not specified, then the kernel cutoff is used.

◆ GetCutoffArrayName()

virtual vtkStdString vtkSPHInterpolator::GetCutoffArrayName ( )

virtual

Specify an (optional) cutoff distance for each point in the input P.

If not specified, then the kernel cutoff is used.

◆ SetDensityArrayName()

virtual void vtkSPHInterpolator::SetDensityArrayName ( vtkStdString )

virtual

Specify the density array name.

This is optional. Typically both the density and mass arrays are specified together (in order to compute the local volume). Both the mass and density arrays must consist of tuples of 1-component. (Note that the density array name specifies a point array found in the Pc source.)

◆ GetDensityArrayName()

virtual vtkStdString vtkSPHInterpolator::GetDensityArrayName ( )

virtual

Specify the density array name.

This is optional. Typically both the density and mass arrays are specified together (in order to compute the local volume). Both the mass and density arrays must consist of tuples of 1-component. (Note that the density array name specifies a point array found in the Pc source.)

◆ SetMassArrayName()

virtual void vtkSPHInterpolator::SetMassArrayName ( vtkStdString )

virtual

Specify the mass array name.

This is optional. Typically both the density and mass arrays are specified together (in order to compute the local volume). Both the mass and density arrays must consist of tuples of 1-component. (Note that the mass array name specifies a point array found in the Pc source.)

◆ GetMassArrayName()

virtual vtkStdString vtkSPHInterpolator::GetMassArrayName ( )

virtual

Specify the mass array name.

This is optional. Typically both the density and mass arrays are specified together (in order to compute the local volume). Both the mass and density arrays must consist of tuples of 1-component. (Note that the mass array name specifies a point array found in the Pc source.)

◆ AddExcludedArray()

void vtkSPHInterpolator::AddExcludedArray ( const vtkStdString & excludedArray )

inline

Adds an array to the list of arrays which are to be excluded from the interpolation process.

Definition at line 182 of file vtkSPHInterpolator.h.

◆ ClearExcludedArrays()

void vtkSPHInterpolator::ClearExcludedArrays ( )

inline

Clears the contents of excluded array list.

Definition at line 193 of file vtkSPHInterpolator.h.

◆ GetNumberOfExcludedArrays()

int vtkSPHInterpolator::GetNumberOfExcludedArrays ( )

inline

Return the number of excluded arrays.

Definition at line 203 of file vtkSPHInterpolator.h.

◆ GetExcludedArray()

const char * vtkSPHInterpolator::GetExcludedArray ( int i )

inline

Return the name of the ith excluded array.

Definition at line 209 of file vtkSPHInterpolator.h.

◆ AddDerivativeArray()

void vtkSPHInterpolator::AddDerivativeArray ( const vtkStdString & derivArray )

inline

Adds an array to the list of arrays whose derivative is to be taken.

If the name of the array is "derivArray" this will produce an output array with the name "derivArray_deriv" (after filter execution).

Definition at line 225 of file vtkSPHInterpolator.h.

◆ ClearDerivativeArrays()

void vtkSPHInterpolator::ClearDerivativeArrays ( )

inline

Clears the contents of derivative array list.

Definition at line 236 of file vtkSPHInterpolator.h.

◆ GetNumberOfDerivativeArrays()

int vtkSPHInterpolator::GetNumberOfDerivativeArrays ( )

inline

Return the number of derivative arrays.

Definition at line 246 of file vtkSPHInterpolator.h.

◆ GetDerivativeArray()

const char * vtkSPHInterpolator::GetDerivativeArray ( int i )

inline

Return the name of the ith derivative array.

Definition at line 252 of file vtkSPHInterpolator.h.

◆ SetNullPointsStrategy()

virtual void vtkSPHInterpolator::SetNullPointsStrategy ( int )

virtual

Specify a strategy to use when encountering a "null" point during the interpolation process.

Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value.

◆ GetNullPointsStrategy()

virtual int vtkSPHInterpolator::GetNullPointsStrategy ( )

virtual

Specify a strategy to use when encountering a "null" point during the interpolation process.

Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value.

◆ SetNullPointsStrategyToMaskPoints()

void vtkSPHInterpolator::SetNullPointsStrategyToMaskPoints ( )

inline

Specify a strategy to use when encountering a "null" point during the interpolation process.

Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value.

Definition at line 281 of file vtkSPHInterpolator.h.

◆ SetNullPointsStrategyToNullValue()

void vtkSPHInterpolator::SetNullPointsStrategyToNullValue ( )

inline

Specify a strategy to use when encountering a "null" point during the interpolation process.

Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value.

Definition at line 282 of file vtkSPHInterpolator.h.

◆ SetValidPointsMaskArrayName()

virtual void vtkSPHInterpolator::SetValidPointsMaskArrayName ( vtkStdString )

virtual

If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point.

This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here.

◆ GetValidPointsMaskArrayName()

virtual vtkStdString vtkSPHInterpolator::GetValidPointsMaskArrayName ( )

virtual

If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point.

This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here.

◆ SetNullValue()

virtual void vtkSPHInterpolator::SetNullValue ( double )

virtual

Specify the null point value.

When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero.

◆ GetNullValue()

virtual double vtkSPHInterpolator::GetNullValue ( )

virtual

Specify the null point value.

When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero.

◆ SetComputeShepardSum()

virtual void vtkSPHInterpolator::SetComputeShepardSum ( vtkTypeBool )

virtual

Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

In the interior of a SPH point cloud, the Shepard summation value should be ~1.0. Towards the boundary, the Shepard summation generally falls off <1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. On by default.

◆ ComputeShepardSumOn()

virtual void vtkSPHInterpolator::ComputeShepardSumOn ( )

virtual

Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

In the interior of a SPH point cloud, the Shepard summation value should be ~1.0. Towards the boundary, the Shepard summation generally falls off <1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. On by default.

◆ ComputeShepardSumOff()

virtual void vtkSPHInterpolator::ComputeShepardSumOff ( )

virtual

Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

In the interior of a SPH point cloud, the Shepard summation value should be ~1.0. Towards the boundary, the Shepard summation generally falls off <1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. On by default.

◆ GetComputeShepardSum()

virtual vtkTypeBool vtkSPHInterpolator::GetComputeShepardSum ( )

virtual

Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum).

In the interior of a SPH point cloud, the Shepard summation value should be ~1.0. Towards the boundary, the Shepard summation generally falls off <1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. On by default.

◆ SetShepardSumArrayName()

virtual void vtkSPHInterpolator::SetShepardSumArrayName ( vtkStdString )

virtual

If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point.

This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation".

◆ GetShepardSumArrayName()

virtual vtkStdString vtkSPHInterpolator::GetShepardSumArrayName ( )

virtual

If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point.

This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation".

◆ SetPromoteOutputArrays()

virtual void vtkSPHInterpolator::SetPromoteOutputArrays ( vtkTypeBool )

virtual

If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

This is because the interpolation process may not be well behaved when integral types are combined using interpolation weights.

◆ PromoteOutputArraysOn()

virtual void vtkSPHInterpolator::PromoteOutputArraysOn ( )

virtual

If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

This is because the interpolation process may not be well behaved when integral types are combined using interpolation weights.

◆ PromoteOutputArraysOff()

virtual void vtkSPHInterpolator::PromoteOutputArraysOff ( )

virtual

If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

This is because the interpolation process may not be well behaved when integral types are combined using interpolation weights.

◆ GetPromoteOutputArrays()

virtual vtkTypeBool vtkSPHInterpolator::GetPromoteOutputArrays ( )

virtual

If enabled, then input arrays that are non-real types (i.e., not float or double) are promoted to float type on output.

This is because the interpolation process may not be well behaved when integral types are combined using interpolation weights.

◆ SetPassPointArrays()

virtual void vtkSPHInterpolator::SetPassPointArrays ( vtkTypeBool )

virtual

Indicate whether to shallow copy the input point data arrays to the output.

On by default.

◆ PassPointArraysOn()

virtual void vtkSPHInterpolator::PassPointArraysOn ( )

virtual

Indicate whether to shallow copy the input point data arrays to the output.

On by default.

◆ PassPointArraysOff()

virtual void vtkSPHInterpolator::PassPointArraysOff ( )

virtual

Indicate whether to shallow copy the input point data arrays to the output.

On by default.

◆ GetPassPointArrays()

virtual vtkTypeBool vtkSPHInterpolator::GetPassPointArrays ( )

virtual

Indicate whether to shallow copy the input point data arrays to the output.

On by default.

◆ SetPassCellArrays()

virtual void vtkSPHInterpolator::SetPassCellArrays ( vtkTypeBool )

virtual

Indicate whether to shallow copy the input cell data arrays to the output.

On by default.

◆ PassCellArraysOn()

virtual void vtkSPHInterpolator::PassCellArraysOn ( )

virtual

Indicate whether to shallow copy the input cell data arrays to the output.

On by default.

◆ PassCellArraysOff()

virtual void vtkSPHInterpolator::PassCellArraysOff ( )

virtual

Indicate whether to shallow copy the input cell data arrays to the output.

On by default.

◆ GetPassCellArrays()

virtual vtkTypeBool vtkSPHInterpolator::GetPassCellArrays ( )

virtual

Indicate whether to shallow copy the input cell data arrays to the output.

On by default.

◆ SetPassFieldArrays()

virtual void vtkSPHInterpolator::SetPassFieldArrays ( vtkTypeBool )

virtual

Indicate whether to pass the field-data arrays from the input to the output.

On by default.

◆ PassFieldArraysOn()

virtual void vtkSPHInterpolator::PassFieldArraysOn ( )

virtual

Indicate whether to pass the field-data arrays from the input to the output.

On by default.

◆ PassFieldArraysOff()

virtual void vtkSPHInterpolator::PassFieldArraysOff ( )

virtual

Indicate whether to pass the field-data arrays from the input to the output.

On by default.

◆ GetPassFieldArrays()

virtual vtkTypeBool vtkSPHInterpolator::GetPassFieldArrays ( )

virtual

Indicate whether to pass the field-data arrays from the input to the output.

On by default.

◆ SetShepardNormalization()

virtual void vtkSPHInterpolator::SetShepardNormalization ( vtkTypeBool )

virtual

Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

If the Shepard coefficient is 0, then the data value is set to zero. Note that enabling ShepardNormalization forces the computation of the ShepardSum array.

◆ ShepardNormalizationOn()

virtual void vtkSPHInterpolator::ShepardNormalizationOn ( )

virtual

Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

If the Shepard coefficient is 0, then the data value is set to zero. Note that enabling ShepardNormalization forces the computation of the ShepardSum array.

◆ ShepardNormalizationOff()

virtual void vtkSPHInterpolator::ShepardNormalizationOff ( )

virtual

Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

If the Shepard coefficient is 0, then the data value is set to zero. Note that enabling ShepardNormalization forces the computation of the ShepardSum array.

◆ GetShepardNormalization()

virtual vtkTypeBool vtkSPHInterpolator::GetShepardNormalization ( )

virtual

Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array).

If the Shepard coefficient is 0, then the data value is set to zero. Note that enabling ShepardNormalization forces the computation of the ShepardSum array.

◆ GetMTime()

vtkMTimeType vtkSPHInterpolator::GetMTime ( )

overridevirtual

Get the MTime of this object also considering the locator and kernel.

Reimplemented from vtkObject.

◆ RequestData()

int vtkSPHInterpolator::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called within ProcessRequest when a request asks the algorithm to do its work.

This is the method you should override to do whatever the algorithm is designed to do. This happens during the final pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ RequestInformation()

int vtkSPHInterpolator::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called within ProcessRequest when a request asks for Information.

Typically an algorithm provides whatever lightweight information about its output that it can here without doing any lengthy computations. This happens after the RequestDataObject pass of the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ RequestUpdateExtent()

int vtkSPHInterpolator::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)

overrideprotectedvirtual

This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for.

This happens after the RequestInformation pass of the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ Probe()

virtual void vtkSPHInterpolator::Probe	(	vtkDataSet *	input,
		vtkDataSet *	source,
		vtkDataSet *	output
	)

protectedvirtual

Virtual for specialized subclass(es)

◆ PassAttributeData()

virtual void vtkSPHInterpolator::PassAttributeData	(	vtkDataSet *	input,
		vtkDataObject *	source,
		vtkDataSet *	output
	)

protectedvirtual

Call at end of RequestData() to pass attribute data respecting the PassCellArrays, PassPointArrays, PassFieldArrays flags.

Member Data Documentation

◆ Locator

vtkAbstractPointLocator* vtkSPHInterpolator::Locator

protected

Definition at line 394 of file vtkSPHInterpolator.h.

◆ Kernel

vtkSPHKernel* vtkSPHInterpolator::Kernel

protected

Definition at line 395 of file vtkSPHInterpolator.h.

◆ CutoffArrayName

vtkStdString vtkSPHInterpolator::CutoffArrayName

protected

Definition at line 397 of file vtkSPHInterpolator.h.

◆ DensityArrayName

vtkStdString vtkSPHInterpolator::DensityArrayName

protected

Definition at line 399 of file vtkSPHInterpolator.h.

◆ MassArrayName

vtkStdString vtkSPHInterpolator::MassArrayName

protected

Definition at line 400 of file vtkSPHInterpolator.h.

◆ ExcludedArrays

std::vector<vtkStdString> vtkSPHInterpolator::ExcludedArrays

protected

Definition at line 402 of file vtkSPHInterpolator.h.

◆ DerivArrays

std::vector<vtkStdString> vtkSPHInterpolator::DerivArrays

protected

Definition at line 403 of file vtkSPHInterpolator.h.

◆ ShepardNormalization

vtkTypeBool vtkSPHInterpolator::ShepardNormalization

protected

Definition at line 405 of file vtkSPHInterpolator.h.

◆ NullPointsStrategy

int vtkSPHInterpolator::NullPointsStrategy

protected

Definition at line 407 of file vtkSPHInterpolator.h.

◆ NullValue

double vtkSPHInterpolator::NullValue

protected

Definition at line 408 of file vtkSPHInterpolator.h.

◆ ValidPointsMaskArrayName

vtkStdString vtkSPHInterpolator::ValidPointsMaskArrayName

protected

Definition at line 409 of file vtkSPHInterpolator.h.

◆ ValidPointsMask

vtkCharArray* vtkSPHInterpolator::ValidPointsMask

protected

Definition at line 410 of file vtkSPHInterpolator.h.

◆ ComputeShepardSum

vtkTypeBool vtkSPHInterpolator::ComputeShepardSum

protected

Definition at line 412 of file vtkSPHInterpolator.h.

◆ ShepardSumArrayName

vtkStdString vtkSPHInterpolator::ShepardSumArrayName

protected

Definition at line 413 of file vtkSPHInterpolator.h.

◆ PromoteOutputArrays

vtkTypeBool vtkSPHInterpolator::PromoteOutputArrays

protected

Definition at line 415 of file vtkSPHInterpolator.h.

◆ PassCellArrays

vtkTypeBool vtkSPHInterpolator::PassCellArrays

protected

Definition at line 417 of file vtkSPHInterpolator.h.

◆ PassPointArrays

vtkTypeBool vtkSPHInterpolator::PassPointArrays

protected

Definition at line 418 of file vtkSPHInterpolator.h.

◆ PassFieldArrays

vtkTypeBool vtkSPHInterpolator::PassFieldArrays

protected

Definition at line 419 of file vtkSPHInterpolator.h.

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

Filters/Points/vtkSPHInterpolator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ NullStrategy

Constructor & Destructor Documentation

◆ vtkSPHInterpolator()

◆ ~vtkSPHInterpolator()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSourceData()

◆ GetSource()

◆ SetSourceConnection()

◆ SetLocator()

◆ GetLocator()

◆ SetKernel()

◆ GetKernel()

◆ SetCutoffArrayName()

◆ GetCutoffArrayName()

◆ SetDensityArrayName()

◆ GetDensityArrayName()

◆ SetMassArrayName()

◆ GetMassArrayName()

◆ AddExcludedArray()

◆ ClearExcludedArrays()

◆ GetNumberOfExcludedArrays()

◆ GetExcludedArray()

◆ AddDerivativeArray()

◆ ClearDerivativeArrays()

◆ GetNumberOfDerivativeArrays()

◆ GetDerivativeArray()

◆ SetNullPointsStrategy()

◆ GetNullPointsStrategy()

◆ SetNullPointsStrategyToMaskPoints()

◆ SetNullPointsStrategyToNullValue()

◆ SetValidPointsMaskArrayName()

◆ GetValidPointsMaskArrayName()

◆ SetNullValue()

◆ GetNullValue()

◆ SetComputeShepardSum()

◆ ComputeShepardSumOn()

◆ ComputeShepardSumOff()

◆ GetComputeShepardSum()

◆ SetShepardSumArrayName()

◆ GetShepardSumArrayName()

◆ SetPromoteOutputArrays()

◆ PromoteOutputArraysOn()

◆ PromoteOutputArraysOff()

◆ GetPromoteOutputArrays()

◆ SetPassPointArrays()

◆ PassPointArraysOn()

◆ PassPointArraysOff()

◆ GetPassPointArrays()

◆ SetPassCellArrays()

◆ PassCellArraysOn()

◆ PassCellArraysOff()

◆ GetPassCellArrays()

◆ SetPassFieldArrays()

◆ PassFieldArraysOn()

◆ PassFieldArraysOff()

◆ GetPassFieldArrays()

◆ SetShepardNormalization()

◆ ShepardNormalizationOn()

◆ ShepardNormalizationOff()

◆ GetShepardNormalization()

◆ GetMTime()

◆ RequestData()

◆ RequestInformation()

◆ RequestUpdateExtent()