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

sample data values at specified point locations More...

#include <vtkProbeFilter.h>

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

Public Types

typedef vtkDataSetAlgorithm Superclass
 
- 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

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkProbeFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetSourceData (vtkDataObject *source)
 Specify the data set that will be probed at the input points. More...
 
vtkDataObjectGetSource ()
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 Specify the data set that will be probed at the input points. More...
 
virtual void SetCategoricalData (vtkTypeBool)
 Control whether the source point data is to be treated as categorical. More...
 
virtual vtkTypeBool GetCategoricalData ()
 
virtual void CategoricalDataOn ()
 
virtual void CategoricalDataOff ()
 
virtual void SetSpatialMatch (vtkTypeBool)
 This flag is used only when a piece is requested to update. More...
 
virtual vtkTypeBool GetSpatialMatch ()
 
virtual void SpatialMatchOn ()
 
virtual void SpatialMatchOff ()
 
vtkIdTypeArrayGetValidPoints ()
 Get the list of point ids in the output that contain attribute data interpolated from the source. More...
 
virtual void SetValidPointMaskArrayName (const char *)
 Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points. More...
 
virtual char * GetValidPointMaskArrayName ()
 
virtual void SetPassCellArrays (vtkTypeBool)
 Shallow copy the input cell data arrays to the output. More...
 
virtual void PassCellArraysOn ()
 
virtual void PassCellArraysOff ()
 
virtual vtkTypeBool GetPassCellArrays ()
 
virtual void SetPassPointArrays (vtkTypeBool)
 Shallow copy the input point data arrays to the output Off by default. More...
 
virtual void PassPointArraysOn ()
 
virtual void PassPointArraysOff ()
 
virtual vtkTypeBool GetPassPointArrays ()
 
virtual void SetPassFieldArrays (vtkTypeBool)
 Set whether to pass the field-data arrays from the Input i.e. More...
 
virtual void PassFieldArraysOn ()
 
virtual void PassFieldArraysOff ()
 
virtual vtkTypeBool GetPassFieldArrays ()
 
virtual void SetTolerance (double)
 Set the tolerance used to compute whether a point in the source is in a cell of the input. More...
 
virtual double GetTolerance ()
 
virtual void SetComputeTolerance (bool)
 Set whether to use the Tolerance field or precompute the tolerance. More...
 
virtual void ComputeToleranceOn ()
 
virtual void ComputeToleranceOff ()
 
virtual bool GetComputeTolerance ()
 
virtual void SetFindCellStrategy (vtkFindCellStrategy *)
 Set / get the strategy used to perform the FindCell() operation. More...
 
virtual vtkFindCellStrategyGetFindCellStrategy ()
 
virtual void SetCellLocatorPrototype (vtkAbstractCellLocator *)
 Set/Get the prototype cell locator to perform the FindCell() operation. More...
 
virtual vtkAbstractCellLocatorGetCellLocatorPrototype ()
 
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithmNewInstance () const
 
vtkDataSetGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataSetGetOutput (int)
 
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...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void SetInputData (vtkDataSet *)
 
void SetInputData (int, vtkDataSet *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataSet *)
 
void AddInputData (int, vtkDataSet *)
 
void AddInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
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 Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the 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 ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
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)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
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 SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
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 void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
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)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkProbeFilterNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkProbeFilterSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkProbeFilter ()
 
 ~vtkProbeFilter () 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...
 
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 Probe (vtkDataSet *input, vtkDataSet *source, vtkDataSet *output)
 Equivalent to calling BuildFieldList(); InitializeForProbing(); DoProbing(). More...
 
void BuildFieldList (vtkDataSet *source)
 Build the field lists. More...
 
virtual void InitializeForProbing (vtkDataSet *input, vtkDataSet *output)
 Initializes output and various arrays which keep track for probing status. More...
 
virtual void InitializeOutputArrays (vtkPointData *outPD, vtkIdType numPts)
 
void DoProbing (vtkDataSet *input, int srcIdx, vtkDataSet *source, vtkDataSet *output)
 Probe appropriate points srcIdx is the index in the PointList for the given source. 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...
 
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)
 
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)
 
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)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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)
 
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)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
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...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkTypeBool CategoricalData
 
vtkTypeBool PassCellArrays
 
vtkTypeBool PassPointArrays
 
vtkTypeBool PassFieldArrays
 
vtkTypeBool SpatialMatch
 
double Tolerance
 
bool ComputeTolerance
 
char * ValidPointMaskArrayName
 
vtkIdTypeArrayValidPoints
 
vtkCharArrayMaskPoints
 
vtkAbstractCellLocatorCellLocatorPrototype
 
vtkFindCellStrategyFindCellStrategy
 
vtkDataSetAttributes::FieldListCellList
 
vtkDataSetAttributes::FieldListPointList
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- 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

sample data values at specified point locations

vtkProbeFilter is a filter that computes point attributes (e.g., scalars, vectors, etc.) at specified point positions. The filter has two inputs: the Input and Source. The Input geometric structure is passed through the filter. The point attributes are computed at the Input point positions by interpolating into the source data. For example, we can compute data values on a plane (plane specified as Input) from a volume (Source). The cell data of the source data is copied to the output based on in which source cell each input point is. If an array of the same name exists both in source's point and cell data, only the one from the point data is probed.

This filter can be used to resample data, or convert one dataset form into another. For example, an unstructured grid (vtkUnstructuredGrid) can be probed with a volume (three-dimensional vtkImageData), and then volume rendering techniques can be used to visualize the results. Another example: a line or curve can be used to probe data to produce x-y plots along that line or curve.

Warning
A critical algorithmic component of vtkProbeFilter is the manner in which it finds the cell containing a probe point. By default, the vtkDataSet::FindCell() method is used, which in turn uses a vtkPointLocator to perform an accelerated search. However, using a vtkPointLocator may fail to identify an enclosing cell in some cases. A more robust but slower approach is to use a vtkCellLocator to perform the the FindCell() operation (via specification of the CellLocatorPrototype). Finally, more advanced searches can be configured by specifying an instance of vtkFindCellStrategy. (Note: image data probing never uses a locator since finding a containing cell is a simple, fast operation. This specifying a vtkFindCellStrategy or cell locator prototype has no effect.)
The vtkProbeFilter, once it finds the cell containing a query point, uses the cell's interpolation functions to perform the interpolate / compute the point attributes. Note that other interpolation processes with different kernels are available: vtkPointInterpolator and vtkSPHInterpolator. vtkPointInterpolator supports a variety of generalized kernels, while vtkSPHInterpolator supports a variety of SPH interpolation kernels.
See also
vtkFindCellStrategy vtkPointLocator vtkCellLocator vtkStaticPointLocator vtkStaticCellLocator vtkPointInterpolator vtkSPHInterpolator

Definition at line 80 of file vtkProbeFilter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 84 of file vtkProbeFilter.h.

Constructor & Destructor Documentation

◆ vtkProbeFilter()

vtkProbeFilter::vtkProbeFilter ( )
protected

◆ ~vtkProbeFilter()

vtkProbeFilter::~vtkProbeFilter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkProbeFilter* vtkProbeFilter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkProbeFilter::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkProbeFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

◆ NewInstance()

vtkProbeFilter* vtkProbeFilter::NewInstance ( ) const

◆ PrintSelf()

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

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPProbeFilter.

◆ SetSourceData()

void vtkProbeFilter::SetSourceData ( vtkDataObject source)

Specify the data set that will be probed at the input points.

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

◆ GetSource()

vtkDataObject* vtkProbeFilter::GetSource ( )

◆ SetSourceConnection()

void vtkProbeFilter::SetSourceConnection ( vtkAlgorithmOutput algOutput)

Specify the data set that will be probed at the input points.

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

◆ SetCategoricalData()

virtual void vtkProbeFilter::SetCategoricalData ( vtkTypeBool  )
virtual

Control whether the source point data is to be treated as categorical.

If the data is categorical, then the resultant data will be determined by a nearest neighbor interpolation scheme.

◆ GetCategoricalData()

virtual vtkTypeBool vtkProbeFilter::GetCategoricalData ( )
virtual

◆ CategoricalDataOn()

virtual void vtkProbeFilter::CategoricalDataOn ( )
virtual

◆ CategoricalDataOff()

virtual void vtkProbeFilter::CategoricalDataOff ( )
virtual

◆ SetSpatialMatch()

virtual void vtkProbeFilter::SetSpatialMatch ( vtkTypeBool  )
virtual

This flag is used only when a piece is requested to update.

By default the flag is off. Because no spatial correspondence between input pieces and source pieces is known, all of the source has to be requested no matter what piece of the output is requested. When there is a spatial correspondence, the user/application can set this flag. This hint allows the breakup of the probe operation to be much more efficient. When piece m of n is requested for update by the user, then only n of m needs to be requested of the source.

◆ GetSpatialMatch()

virtual vtkTypeBool vtkProbeFilter::GetSpatialMatch ( )
virtual

◆ SpatialMatchOn()

virtual void vtkProbeFilter::SpatialMatchOn ( )
virtual

◆ SpatialMatchOff()

virtual void vtkProbeFilter::SpatialMatchOff ( )
virtual

◆ GetValidPoints()

vtkIdTypeArray* vtkProbeFilter::GetValidPoints ( )

Get the list of point ids in the output that contain attribute data interpolated from the source.

◆ SetValidPointMaskArrayName()

virtual void vtkProbeFilter::SetValidPointMaskArrayName ( const char *  )
virtual

Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.

Set to "vtkValidPointMask" by default.

◆ GetValidPointMaskArrayName()

virtual char* vtkProbeFilter::GetValidPointMaskArrayName ( )
virtual

◆ SetPassCellArrays()

virtual void vtkProbeFilter::SetPassCellArrays ( vtkTypeBool  )
virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ PassCellArraysOn()

virtual void vtkProbeFilter::PassCellArraysOn ( )
virtual

◆ PassCellArraysOff()

virtual void vtkProbeFilter::PassCellArraysOff ( )
virtual

◆ GetPassCellArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassCellArrays ( )
virtual

◆ SetPassPointArrays()

virtual void vtkProbeFilter::SetPassPointArrays ( vtkTypeBool  )
virtual

Shallow copy the input point data arrays to the output Off by default.

◆ PassPointArraysOn()

virtual void vtkProbeFilter::PassPointArraysOn ( )
virtual

◆ PassPointArraysOff()

virtual void vtkProbeFilter::PassPointArraysOff ( )
virtual

◆ GetPassPointArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassPointArrays ( )
virtual

◆ SetPassFieldArrays()

virtual void vtkProbeFilter::SetPassFieldArrays ( vtkTypeBool  )
virtual

Set whether to pass the field-data arrays from the Input i.e.

the input providing the geometry to the output. On by default.

◆ PassFieldArraysOn()

virtual void vtkProbeFilter::PassFieldArraysOn ( )
virtual

◆ PassFieldArraysOff()

virtual void vtkProbeFilter::PassFieldArraysOff ( )
virtual

◆ GetPassFieldArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassFieldArrays ( )
virtual

◆ SetTolerance()

virtual void vtkProbeFilter::SetTolerance ( double  )
virtual

Set the tolerance used to compute whether a point in the source is in a cell of the input.

This value is only used if ComputeTolerance is off.

◆ GetTolerance()

virtual double vtkProbeFilter::GetTolerance ( )
virtual

◆ SetComputeTolerance()

virtual void vtkProbeFilter::SetComputeTolerance ( bool  )
virtual

Set whether to use the Tolerance field or precompute the tolerance.

When on, the tolerance will be computed and the field value is ignored. On by default.

◆ ComputeToleranceOn()

virtual void vtkProbeFilter::ComputeToleranceOn ( )
virtual

◆ ComputeToleranceOff()

virtual void vtkProbeFilter::ComputeToleranceOff ( )
virtual

◆ GetComputeTolerance()

virtual bool vtkProbeFilter::GetComputeTolerance ( )
virtual

◆ SetFindCellStrategy()

virtual void vtkProbeFilter::SetFindCellStrategy ( vtkFindCellStrategy )
virtual

Set / get the strategy used to perform the FindCell() operation.

When specified, the strategy is used in preference to a cell locator prototype. When neither a strategy or cell locator prototype is defined, then the vtkDataSet::FindCell() method is used.

◆ GetFindCellStrategy()

virtual vtkFindCellStrategy* vtkProbeFilter::GetFindCellStrategy ( )
virtual

◆ SetCellLocatorPrototype()

virtual void vtkProbeFilter::SetCellLocatorPrototype ( vtkAbstractCellLocator )
virtual

Set/Get the prototype cell locator to perform the FindCell() operation.

(A prototype is used as an object factory to instantiate an instance of the prototype to perform the FindCell() operation). If a prototype, and a vtkFindCellStrategy are not defined, the vtkDataSet::FindCell() is used. If a vtkFindCellStrategy is not defined, then the prototype is used.

◆ GetCellLocatorPrototype()

virtual vtkAbstractCellLocator* vtkProbeFilter::GetCellLocatorPrototype ( )
virtual

◆ RequestData()

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

Reimplemented in vtkPProbeFilter.

◆ RequestInformation()

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

◆ RequestUpdateExtent()

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

Reimplemented in vtkPProbeFilter.

◆ PassAttributeData()

void vtkProbeFilter::PassAttributeData ( vtkDataSet input,
vtkDataObject source,
vtkDataSet output 
)
protected

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

◆ Probe()

void vtkProbeFilter::Probe ( vtkDataSet input,
vtkDataSet source,
vtkDataSet output 
)
protected

◆ BuildFieldList()

void vtkProbeFilter::BuildFieldList ( vtkDataSet source)
protected

Build the field lists.

This is required before calling InitializeForProbing().

◆ InitializeForProbing()

virtual void vtkProbeFilter::InitializeForProbing ( vtkDataSet input,
vtkDataSet output 
)
protectedvirtual

Initializes output and various arrays which keep track for probing status.

◆ InitializeOutputArrays()

virtual void vtkProbeFilter::InitializeOutputArrays ( vtkPointData outPD,
vtkIdType  numPts 
)
protectedvirtual

Reimplemented in vtkCompositeDataProbeFilter.

◆ DoProbing()

void vtkProbeFilter::DoProbing ( vtkDataSet input,
int  srcIdx,
vtkDataSet source,
vtkDataSet output 
)
protected

Probe appropriate points srcIdx is the index in the PointList for the given source.

Member Data Documentation

◆ CategoricalData

vtkTypeBool vtkProbeFilter::CategoricalData
protected

Definition at line 262 of file vtkProbeFilter.h.

◆ PassCellArrays

vtkTypeBool vtkProbeFilter::PassCellArrays
protected

Definition at line 264 of file vtkProbeFilter.h.

◆ PassPointArrays

vtkTypeBool vtkProbeFilter::PassPointArrays
protected

Definition at line 265 of file vtkProbeFilter.h.

◆ PassFieldArrays

vtkTypeBool vtkProbeFilter::PassFieldArrays
protected

Definition at line 266 of file vtkProbeFilter.h.

◆ SpatialMatch

vtkTypeBool vtkProbeFilter::SpatialMatch
protected

Definition at line 268 of file vtkProbeFilter.h.

◆ Tolerance

double vtkProbeFilter::Tolerance
protected

Definition at line 270 of file vtkProbeFilter.h.

◆ ComputeTolerance

bool vtkProbeFilter::ComputeTolerance
protected

Definition at line 271 of file vtkProbeFilter.h.

◆ ValidPointMaskArrayName

char* vtkProbeFilter::ValidPointMaskArrayName
protected

Definition at line 273 of file vtkProbeFilter.h.

◆ ValidPoints

vtkIdTypeArray* vtkProbeFilter::ValidPoints
protected

Definition at line 274 of file vtkProbeFilter.h.

◆ MaskPoints

vtkCharArray* vtkProbeFilter::MaskPoints
protected

Definition at line 275 of file vtkProbeFilter.h.

◆ CellLocatorPrototype

vtkAbstractCellLocator* vtkProbeFilter::CellLocatorPrototype
protected

Definition at line 278 of file vtkProbeFilter.h.

◆ FindCellStrategy

vtkFindCellStrategy* vtkProbeFilter::FindCellStrategy
protected

Definition at line 279 of file vtkProbeFilter.h.

◆ CellList

vtkDataSetAttributes::FieldList* vtkProbeFilter::CellList
protected

Definition at line 281 of file vtkProbeFilter.h.

◆ PointList

vtkDataSetAttributes::FieldList* vtkProbeFilter::PointList
protected

Definition at line 282 of file vtkProbeFilter.h.


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