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

interpolate over point cloud using SPH kernels More...

#include <vtkSPHInterpolator.h>

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

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. More...
 
int GetNumberOfExcludedArrays ()
 Return the number of excluded arrays. More...
 
int GetNumberOfDerivativeArrays ()
 Return the number of derivative arrays. More...
 
vtkMTimeType GetMTime () override
 Get the MTime of this object also considering the locator and kernel. More...
 
void SetSourceData (vtkDataObject *source)
 Specify the dataset Pc that will be probed by the input points P. More...
 
vtkDataObjectGetSource ()
 Specify the dataset Pc that will be probed by the input points P. More...
 
void SetLocator (vtkAbstractPointLocator *locator)
 Specify a point locator. More...
 
virtual vtkAbstractPointLocatorGetLocator ()
 Specify a point locator. More...
 
void SetKernel (vtkSPHKernel *kernel)
 Specify an interpolation kernel. More...
 
virtual vtkSPHKernelGetKernel ()
 Specify an interpolation kernel. More...
 
virtual void SetCutoffArrayName (vtkStdString)
 Specify an (optional) cutoff distance for each point in the input P. More...
 
virtual vtkStdString GetCutoffArrayName ()
 Specify an (optional) cutoff distance for each point in the input P. More...
 
virtual void SetDensityArrayName (vtkStdString)
 Specify the density array name. More...
 
virtual vtkStdString GetDensityArrayName ()
 Specify the density array name. More...
 
virtual void SetMassArrayName (vtkStdString)
 Specify the mass array name. More...
 
virtual vtkStdString GetMassArrayName ()
 Specify the mass array name. More...
 
void AddExcludedArray (const vtkStdString &excludedArray)
 Adds an array to the list of arrays which are to be excluded from the interpolation process. More...
 
void ClearExcludedArrays ()
 Clears the contents of excluded array list. More...
 
const char * GetExcludedArray (int i)
 Return the name of the ith excluded array. More...
 
void AddDerivativeArray (const vtkStdString &derivArray)
 Adds an array to the list of arrays whose derivative is to be taken. More...
 
void ClearDerivativeArrays ()
 Clears the contents of derivative array list. More...
 
const char * GetDerivativeArray (int i)
 Return the name of the ith derivative array. More...
 
virtual void SetNullPointsStrategy (int)
 Specify a strategy to use when encountering a "null" point during the interpolation process. More...
 
virtual int GetNullPointsStrategy ()
 Specify a strategy to use when encountering a "null" point during the interpolation process. More...
 
void SetNullPointsStrategyToMaskPoints ()
 Specify a strategy to use when encountering a "null" point during the interpolation process. More...
 
void SetNullPointsStrategyToNullValue ()
 Specify a strategy to use when encountering a "null" point during the interpolation process. More...
 
virtual void SetValidPointsMaskArrayName (vtkStdString)
 If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point. More...
 
virtual vtkStdString GetValidPointsMaskArrayName ()
 If the NullPointsStrategy == MASK_POINTS, then an array is generated for each input point. More...
 
virtual void SetNullValue (double)
 Specify the null point value. More...
 
virtual double GetNullValue ()
 Specify the null point value. More...
 
virtual void SetComputeShepardSum (vtkTypeBool)
 Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum). More...
 
virtual void ComputeShepardSumOn ()
 Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum). More...
 
virtual void ComputeShepardSumOff ()
 Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum). More...
 
virtual vtkTypeBool GetComputeShepardSum ()
 Indicate whether to compute the summation of weighting coefficients (the so-called Shepard sum). More...
 
virtual void SetShepardSumArrayName (vtkStdString)
 If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. More...
 
virtual vtkStdString GetShepardSumArrayName ()
 If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual void SetPassPointArrays (vtkTypeBool)
 Indicate whether to shallow copy the input point data arrays to the output. More...
 
virtual void PassPointArraysOn ()
 Indicate whether to shallow copy the input point data arrays to the output. More...
 
virtual void PassPointArraysOff ()
 Indicate whether to shallow copy the input point data arrays to the output. More...
 
virtual vtkTypeBool GetPassPointArrays ()
 Indicate whether to shallow copy the input point data arrays to the output. More...
 
virtual void SetPassCellArrays (vtkTypeBool)
 Indicate whether to shallow copy the input cell data arrays to the output. More...
 
virtual void PassCellArraysOn ()
 Indicate whether to shallow copy the input cell data arrays to the output. More...
 
virtual void PassCellArraysOff ()
 Indicate whether to shallow copy the input cell data arrays to the output. More...
 
virtual vtkTypeBool GetPassCellArrays ()
 Indicate whether to shallow copy the input cell data arrays to the output. More...
 
virtual void SetPassFieldArrays (vtkTypeBool)
 Indicate whether to pass the field-data arrays from the input to the output. More...
 
virtual void PassFieldArraysOn ()
 Indicate whether to pass the field-data arrays from the input to the output. More...
 
virtual void PassFieldArraysOff ()
 Indicate whether to pass the field-data arrays from the input to the output. More...
 
virtual vtkTypeBool GetPassFieldArrays ()
 Indicate whether to pass the field-data arrays from the input to the output. More...
 
virtual void SetShepardNormalization (vtkTypeBool)
 Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array). More...
 
virtual void ShepardNormalizationOn ()
 Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array). More...
 
virtual void ShepardNormalizationOff ()
 Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array). More...
 
virtual vtkTypeBool GetShepardNormalization ()
 Indicate whether to normalize all arrays with the Shepard coefficients (except the density array and the Shepard sum array). More...
 
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as vtkPolyData. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as vtkStructuredPoints. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as vtkStructuredGrid. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as vtkUnstructuredGrid. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as vtkRectilinearGrid. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataSetGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataSet *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual int Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual int Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Protected Member Functions

 vtkSPHInterpolator ()
 
 ~vtkSPHInterpolator () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks the algorithm to do its work. More...
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 This is called within ProcessRequest when a request asks for Information. More...
 
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. More...
 
virtual void Probe (vtkDataSet *input, vtkDataSet *source, vtkDataSet *output)
 Virtual for specialized subclass(es) More...
 
virtual void PassAttributeData (vtkDataSet *input, vtkDataObject *source, vtkDataSet *output)
 Call at end of RequestData() to pass attribute data respecting the PassCellArrays, PassPointArrays, PassFieldArrays flags. More...
 
- Protected Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 
 ~vtkDataSetAlgorithm () override
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAbstractPointLocatorLocator
 
vtkSPHKernelKernel
 
vtkStdString CutoffArrayName
 
vtkStdString DensityArrayName
 
vtkStdString MassArrayName
 
std::vector< vtkStdStringExcludedArrays
 
std::vector< vtkStdStringDerivArrays
 
vtkTypeBool ShepardNormalization
 
int NullPointsStrategy
 
double NullValue
 
vtkStdString ValidPointsMaskArrayName
 
vtkCharArrayValidPointsMask
 
vtkTypeBool ComputeShepardSum
 
vtkStdString ShepardSumArrayName
 
vtkFloatArrayShepardSumArray
 
vtkTypeBool PromoteOutputArrays
 
vtkTypeBool PassCellArrays
 
vtkTypeBool PassPointArrays
 
vtkTypeBool PassFieldArrays
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 
typedef vtkDataSetAlgorithm Superclass
 Standard methods for instantiating, obtaining type information, and printing. More...
 
static vtkSPHInterpolatorNew ()
 Standard methods for instantiating, obtaining type information, and printing. More...
 
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiating, obtaining type information, and printing. More...
 
static vtkSPHInterpolatorSafeDownCast (vtkObjectBase *o)
 Standard methods for instantiating, obtaining type information, and printing. More...
 
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiating, obtaining type information, and printing. More...
 
vtkSPHInterpolatorNewInstance () const
 Standard methods for instantiating, obtaining type information, and printing. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiating, obtaining type information, and printing. More...
 
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiating, obtaining type information, and printing. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataSetAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

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 when the local neighborhood around each 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
Tests:
vtkSPHInterpolator (Tests)

Definition at line 96 of file vtkSPHInterpolator.h.

Member Typedef Documentation

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

Definition at line 105 of file vtkSPHInterpolator.h.

Member Enumeration Documentation

Enumerator
MASK_POINTS 
NULL_VALUE 

Definition at line 269 of file vtkSPHInterpolator.h.

Constructor & Destructor Documentation

vtkSPHInterpolator::vtkSPHInterpolator ( )
protected
vtkSPHInterpolator::~vtkSPHInterpolator ( )
overrideprotected

Member Function Documentation

static vtkSPHInterpolator* vtkSPHInterpolator::New ( )
static

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

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

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

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

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

Reimplemented from vtkDataSetAlgorithm.

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

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

virtual vtkObjectBase* vtkSPHInterpolator::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkDataSetAlgorithm.

vtkSPHInterpolator* vtkSPHInterpolator::NewInstance ( ) const

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

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

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

Reimplemented from vtkDataSetAlgorithm.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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 186 of file vtkSPHInterpolator.h.

void vtkSPHInterpolator::ClearExcludedArrays ( )
inline

Clears the contents of excluded array list.

Definition at line 197 of file vtkSPHInterpolator.h.

int vtkSPHInterpolator::GetNumberOfExcludedArrays ( )
inline

Return the number of excluded arrays.

Definition at line 207 of file vtkSPHInterpolator.h.

const char* vtkSPHInterpolator::GetExcludedArray ( int  i)
inline

Return the name of the ith excluded array.

Definition at line 214 of file vtkSPHInterpolator.h.

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 230 of file vtkSPHInterpolator.h.

void vtkSPHInterpolator::ClearDerivativeArrays ( )
inline

Clears the contents of derivative array list.

Definition at line 241 of file vtkSPHInterpolator.h.

int vtkSPHInterpolator::GetNumberOfDerivativeArrays ( )
inline

Return the number of derivative arrays.

Definition at line 251 of file vtkSPHInterpolator.h.

const char* vtkSPHInterpolator::GetDerivativeArray ( int  i)
inline

Return the name of the ith derivative array.

Definition at line 258 of file vtkSPHInterpolator.h.

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.

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.

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 287 of file vtkSPHInterpolator.h.

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 289 of file vtkSPHInterpolator.h.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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.

virtual void vtkSPHInterpolator::SetPassPointArrays ( vtkTypeBool  )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassPointArraysOn ( )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassPointArraysOff ( )
virtual

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

On by default.

virtual vtkTypeBool vtkSPHInterpolator::GetPassPointArrays ( )
virtual

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

On by default.

virtual void vtkSPHInterpolator::SetPassCellArrays ( vtkTypeBool  )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassCellArraysOn ( )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassCellArraysOff ( )
virtual

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

On by default.

virtual vtkTypeBool vtkSPHInterpolator::GetPassCellArrays ( )
virtual

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

On by default.

virtual void vtkSPHInterpolator::SetPassFieldArrays ( vtkTypeBool  )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassFieldArraysOn ( )
virtual

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

On by default.

virtual void vtkSPHInterpolator::PassFieldArraysOff ( )
virtual

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

On by default.

virtual vtkTypeBool vtkSPHInterpolator::GetPassFieldArrays ( )
virtual

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

On by default.

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.

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.

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.

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.

vtkMTimeType vtkSPHInterpolator::GetMTime ( )
overridevirtual

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

Reimplemented from vtkObject.

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 fourth pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

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 in the first pass of the pipeline execution.

Reimplemented from vtkDataSetAlgorithm.

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 during the second pass in the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

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

Virtual for specialized subclass(es)

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

vtkAbstractPointLocator* vtkSPHInterpolator::Locator
protected

Definition at line 402 of file vtkSPHInterpolator.h.

vtkSPHKernel* vtkSPHInterpolator::Kernel
protected

Definition at line 403 of file vtkSPHInterpolator.h.

vtkStdString vtkSPHInterpolator::CutoffArrayName
protected

Definition at line 405 of file vtkSPHInterpolator.h.

vtkStdString vtkSPHInterpolator::DensityArrayName
protected

Definition at line 407 of file vtkSPHInterpolator.h.

vtkStdString vtkSPHInterpolator::MassArrayName
protected

Definition at line 408 of file vtkSPHInterpolator.h.

std::vector<vtkStdString> vtkSPHInterpolator::ExcludedArrays
protected

Definition at line 410 of file vtkSPHInterpolator.h.

std::vector<vtkStdString> vtkSPHInterpolator::DerivArrays
protected

Definition at line 411 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::ShepardNormalization
protected

Definition at line 413 of file vtkSPHInterpolator.h.

int vtkSPHInterpolator::NullPointsStrategy
protected

Definition at line 415 of file vtkSPHInterpolator.h.

double vtkSPHInterpolator::NullValue
protected

Definition at line 416 of file vtkSPHInterpolator.h.

vtkStdString vtkSPHInterpolator::ValidPointsMaskArrayName
protected

Definition at line 417 of file vtkSPHInterpolator.h.

vtkCharArray* vtkSPHInterpolator::ValidPointsMask
protected

Definition at line 418 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::ComputeShepardSum
protected

Definition at line 420 of file vtkSPHInterpolator.h.

vtkStdString vtkSPHInterpolator::ShepardSumArrayName
protected

Definition at line 421 of file vtkSPHInterpolator.h.

vtkFloatArray* vtkSPHInterpolator::ShepardSumArray
protected

Definition at line 422 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::PromoteOutputArrays
protected

Definition at line 424 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::PassCellArrays
protected

Definition at line 426 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::PassPointArrays
protected

Definition at line 427 of file vtkSPHInterpolator.h.

vtkTypeBool vtkSPHInterpolator::PassFieldArrays
protected

Definition at line 428 of file vtkSPHInterpolator.h.


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