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

interpolate over point cloud using various kernels More...

#include <vtkPointInterpolator.h>

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

Public Types

enum  Strategy { MASK_POINTS =0, NULL_VALUE =1, CLOSEST_POINT =2 }
 
- 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...
 
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 (vtkInterpolationKernel *kernel)
 Specify an interpolation kernel. More...
 
virtual vtkInterpolationKernelGetKernel ()
 Specify an interpolation kernel. 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...
 
void SetNullPointsStrategyToClosestPoint ()
 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...
 
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...
 
virtual void SetPromoteOutputArrays (bool)
 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 bool 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 (bool)
 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 bool GetPassPointArrays ()
 Indicate whether to shallow copy the input point data arrays to the output. More...
 
virtual void SetPassCellArrays (bool)
 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 bool GetPassCellArrays ()
 Indicate whether to shallow copy the input cell data arrays to the output. More...
 
virtual void SetPassFieldArrays (bool)
 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 bool GetPassFieldArrays ()
 Indicate whether to pass the field-data arrays from the input to the output. 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 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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
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

 vtkPointInterpolator ()
 
 ~vtkPointInterpolator () 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...
 
void ExtractImageDescription (vtkImageData *input, int dims[3], double origin[3], double spacing[3])
 Internal method to extract image metadata. 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
 
vtkInterpolationKernelKernel
 
int NullPointsStrategy
 
double NullValue
 
vtkStdString ValidPointsMaskArrayName
 
vtkCharArrayValidPointsMask
 
std::vector< vtkStdStringExcludedArrays
 
bool PromoteOutputArrays
 
bool PassCellArrays
 
bool PassPointArrays
 
bool 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 vtkPointInterpolatorNew ()
 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 vtkPointInterpolatorSafeDownCast (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...
 
vtkPointInterpolatorNewInstance () 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 various kernels

vtkPointInterpolator probes a point cloud Pc (the filter Source) with a set of points P (the filter Input), interpolating the data values from Pc onto P. Note however that the descriptive phrase "point cloud" is a misnomer: Pc can be represented by any vtkDataSet type, with the points of the dataset forming Pc. Similarly, the output P can also be represented by any vtkDataSet type; and the topology/geometry structure of P is passed through to the output along with the newly interpolated arrays.

A key input to this filter is the specification of the interpolation kernel, and the parameters which control the associated interpolation process. Interpolation kernels include Voronoi, Gaussian, Shepard, and SPH (smoothed particle hydrodynamics), with additional kernels to be added in the future.

An overview of the algorithm is as follows. For each p from P, Np "close" points to p are found. (The meaning of what is "close" can be specified as either the N closest points, or all points within a given radius Rp. This depends on how the kernel is defined.) Once the Np close points are found, then the interpolation kernel is applied to compute new data values located on p. Note that for reasonable performance, finding the Np closest points requires a point locator. The locator may be specified as input to the algorithm. (By default, a vtkStaticPointLocator is used because generally it is much faster to build, delete, and search with. However, with highly non-uniform point distributions, octree- or kd-tree based locators may perform better.)

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).
See also
vtkPointInterpolator2D vtkProbeFilter vtkGaussianSplatter vtkCheckerboardSplatter vtkShepardMethod vtkVoronoiKernel vtkShepardKernel vtkGaussianKernel vtkSPHKernel
Tests:
vtkPointInterpolator (Tests)

Definition at line 83 of file vtkPointInterpolator.h.

Member Typedef Documentation

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

Definition at line 92 of file vtkPointInterpolator.h.

Member Enumeration Documentation

Enumerator
MASK_POINTS 
NULL_VALUE 
CLOSEST_POINT 

Definition at line 136 of file vtkPointInterpolator.h.

Constructor & Destructor Documentation

vtkPointInterpolator::vtkPointInterpolator ( )
protected
vtkPointInterpolator::~vtkPointInterpolator ( )
overrideprotected

Member Function Documentation

static vtkPointInterpolator* vtkPointInterpolator::New ( )
static

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

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

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

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

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

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPointInterpolator2D.

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

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

virtual vtkObjectBase* vtkPointInterpolator::NewInstanceInternal ( ) const
protectedvirtual

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

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPointInterpolator2D.

vtkPointInterpolator* vtkPointInterpolator::NewInstance ( ) const

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

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

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

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPointInterpolator2D.

void vtkPointInterpolator::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* vtkPointInterpolator::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 vtkPointInterpolator::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 vtkPointInterpolator::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* vtkPointInterpolator::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 vtkPointInterpolator::SetKernel ( vtkInterpolationKernel kernel)

Specify an interpolation kernel.

By default a vtkLinearKernel is used (i.e., linear combination of closest points). The interpolation kernel changes the basis of the interpolation.

virtual vtkInterpolationKernel* vtkPointInterpolator::GetKernel ( )
virtual

Specify an interpolation kernel.

By default a vtkLinearKernel is used (i.e., linear combination of closest points). The interpolation kernel changes the basis of the interpolation.

virtual void vtkPointInterpolator::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 (this is the default), then the output data value(s) are set to the NullPoint value (specified in the output point data). Finally, the strategy ClosestPoint is to simply use the closest point to perform the interpolation.

virtual int vtkPointInterpolator::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 (this is the default), then the output data value(s) are set to the NullPoint value (specified in the output point data). Finally, the strategy ClosestPoint is to simply use the closest point to perform the interpolation.

void vtkPointInterpolator::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 (this is the default), then the output data value(s) are set to the NullPoint value (specified in the output point data). Finally, the strategy ClosestPoint is to simply use the closest point to perform the interpolation.

Definition at line 157 of file vtkPointInterpolator.h.

void vtkPointInterpolator::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 (this is the default), then the output data value(s) are set to the NullPoint value (specified in the output point data). Finally, the strategy ClosestPoint is to simply use the closest point to perform the interpolation.

Definition at line 159 of file vtkPointInterpolator.h.

void vtkPointInterpolator::SetNullPointsStrategyToClosestPoint ( )
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 (this is the default), then the output data value(s) are set to the NullPoint value (specified in the output point data). Finally, the strategy ClosestPoint is to simply use the closest point to perform the interpolation.

Definition at line 161 of file vtkPointInterpolator.h.

virtual void vtkPointInterpolator::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 vtkPointInterpolator::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 vtkPointInterpolator::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 vtkPointInterpolator::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.

void vtkPointInterpolator::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 191 of file vtkPointInterpolator.h.

void vtkPointInterpolator::ClearExcludedArrays ( )
inline

Clears the contents of excluded array list.

Definition at line 202 of file vtkPointInterpolator.h.

int vtkPointInterpolator::GetNumberOfExcludedArrays ( )
inline

Return the number of excluded arrays.

Definition at line 212 of file vtkPointInterpolator.h.

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

Return the name of the ith excluded array.

Definition at line 219 of file vtkPointInterpolator.h.

virtual void vtkPointInterpolator::SetPromoteOutputArrays ( bool  )
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 vtkPointInterpolator::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 vtkPointInterpolator::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 bool vtkPointInterpolator::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 vtkPointInterpolator::SetPassPointArrays ( bool  )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassPointArraysOn ( )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassPointArraysOff ( )
virtual

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

On by default.

virtual bool vtkPointInterpolator::GetPassPointArrays ( )
virtual

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

On by default.

virtual void vtkPointInterpolator::SetPassCellArrays ( bool  )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassCellArraysOn ( )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassCellArraysOff ( )
virtual

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

On by default.

virtual bool vtkPointInterpolator::GetPassCellArrays ( )
virtual

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

On by default.

virtual void vtkPointInterpolator::SetPassFieldArrays ( bool  )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassFieldArraysOn ( )
virtual

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

On by default.

virtual void vtkPointInterpolator::PassFieldArraysOff ( )
virtual

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

On by default.

virtual bool vtkPointInterpolator::GetPassFieldArrays ( )
virtual

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

On by default.

vtkMTimeType vtkPointInterpolator::GetMTime ( )
overridevirtual

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

Reimplemented from vtkObject.

int vtkPointInterpolator::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 vtkPointInterpolator::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 vtkPointInterpolator::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 vtkPointInterpolator::Probe ( vtkDataSet input,
vtkDataSet source,
vtkDataSet output 
)
protectedvirtual

Virtual for specialized subclass(es)

Reimplemented in vtkPointInterpolator2D.

virtual void vtkPointInterpolator::PassAttributeData ( vtkDataSet input,
vtkDataObject source,
vtkDataSet output 
)
protectedvirtual

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

void vtkPointInterpolator::ExtractImageDescription ( vtkImageData input,
int  dims[3],
double  origin[3],
double  spacing[3] 
)
protected

Internal method to extract image metadata.

Member Data Documentation

vtkAbstractPointLocator* vtkPointInterpolator::Locator
protected

Definition at line 280 of file vtkPointInterpolator.h.

vtkInterpolationKernel* vtkPointInterpolator::Kernel
protected

Definition at line 281 of file vtkPointInterpolator.h.

int vtkPointInterpolator::NullPointsStrategy
protected

Definition at line 283 of file vtkPointInterpolator.h.

double vtkPointInterpolator::NullValue
protected

Definition at line 284 of file vtkPointInterpolator.h.

vtkStdString vtkPointInterpolator::ValidPointsMaskArrayName
protected

Definition at line 285 of file vtkPointInterpolator.h.

vtkCharArray* vtkPointInterpolator::ValidPointsMask
protected

Definition at line 286 of file vtkPointInterpolator.h.

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

Definition at line 288 of file vtkPointInterpolator.h.

bool vtkPointInterpolator::PromoteOutputArrays
protected

Definition at line 290 of file vtkPointInterpolator.h.

bool vtkPointInterpolator::PassCellArrays
protected

Definition at line 292 of file vtkPointInterpolator.h.

bool vtkPointInterpolator::PassPointArrays
protected

Definition at line 293 of file vtkPointInterpolator.h.

bool vtkPointInterpolator::PassFieldArrays
protected

Definition at line 294 of file vtkPointInterpolator.h.


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