sample data values at specified point locations More...

#include <vtkProbeFilter.h>

Inheritance diagram for vtkProbeFilter:

Collaboration diagram for vtkProbeFilter:

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.

vtkProbeFilter *	NewInstance () const

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

void	SetSourceConnection (vtkAlgorithmOutput *algOutput)
	Specify the data set that will be probed at the input points.


void	SetSourceData (vtkDataObject *source)
	Specify the data set that will be probed at the input points.

vtkDataObject *	GetSource ()
	Specify the data set that will be probed at the input points.


virtual void	SetCategoricalData (vtkTypeBool)
	Control whether the source point data is to be treated as categorical.

virtual vtkTypeBool	GetCategoricalData ()
	Control whether the source point data is to be treated as categorical.

virtual void	CategoricalDataOn ()
	Control whether the source point data is to be treated as categorical.

virtual void	CategoricalDataOff ()
	Control whether the source point data is to be treated as categorical.


virtual void	SetSpatialMatch (vtkTypeBool)
	This flag is used only when a piece is requested to update.

virtual vtkTypeBool	GetSpatialMatch ()
	This flag is used only when a piece is requested to update.

virtual void	SpatialMatchOn ()
	This flag is used only when a piece is requested to update.

virtual void	SpatialMatchOff ()
	This flag is used only when a piece is requested to update.


vtkIdTypeArray *	GetValidPoints ()
	Get the list of point ids in the output that contain attribute data interpolated from the source.


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.

virtual char *	GetValidPointMaskArrayName ()
	Returns the name of the char array added to the output with values 1 for valid points and 0 for invalid points.


virtual void	SetPassCellArrays (vtkTypeBool)
	Shallow copy the input cell data arrays to the output.

virtual void	PassCellArraysOn ()
	Shallow copy the input cell data arrays to the output.

virtual void	PassCellArraysOff ()
	Shallow copy the input cell data arrays to the output.

virtual vtkTypeBool	GetPassCellArrays ()
	Shallow copy the input cell data arrays to the output.


virtual void	SetPassPointArrays (vtkTypeBool)
	Shallow copy the input point data arrays to the output.

virtual void	PassPointArraysOn ()
	Shallow copy the input point data arrays to the output.

virtual void	PassPointArraysOff ()
	Shallow copy the input point data arrays to the output.

virtual vtkTypeBool	GetPassPointArrays ()
	Shallow copy the input point data arrays to the output.


virtual void	SetPassFieldArrays (vtkTypeBool)
	Set whether to pass the field-data arrays from the Input i.e.

virtual void	PassFieldArraysOn ()
	Set whether to pass the field-data arrays from the Input i.e.

virtual void	PassFieldArraysOff ()
	Set whether to pass the field-data arrays from the Input i.e.

virtual vtkTypeBool	GetPassFieldArrays ()
	Set whether to pass the field-data arrays from the Input i.e.


virtual void	SetTolerance (double)
	Set the tolerance used to compute whether a point in the source is in a cell of the input.

virtual double	GetTolerance ()
	Set the tolerance used to compute whether a point in the source is in a cell of the input.


virtual void	SetSnapToCellWithClosestPoint (bool)
	Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

virtual void	SnapToCellWithClosestPointOn ()
	Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

virtual void	SnapToCellWithClosestPointOff ()
	Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

virtual bool	GetSnapToCellWithClosestPoint ()
	Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.


virtual void	SetComputeTolerance (bool)
	Set whether to use the Tolerance field or precompute the tolerance.

virtual void	ComputeToleranceOn ()
	Set whether to use the Tolerance field or precompute the tolerance.

virtual void	ComputeToleranceOff ()
	Set whether to use the Tolerance field or precompute the tolerance.

virtual bool	GetComputeTolerance ()
	Set whether to use the Tolerance field or precompute the tolerance.


virtual void	SetFindCellStrategy (vtkFindCellStrategy *)
	Set / get the strategy used to perform the FindCell() operation.

virtual vtkFindCellStrategy *	GetFindCellStrategy ()
	Set / get the strategy used to perform the FindCell() operation.


virtual void	SetCellLocatorPrototype (vtkAbstractCellLocator *)
	Set/Get the prototype cell locator to perform the FindCell() operation.

virtual vtkAbstractCellLocator *	GetCellLocatorPrototype ()
	Set/Get the prototype cell locator to perform the FindCell() operation.

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

vtkDataSetAlgorithm *	NewInstance () const

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

vtkDataObject *	GetInput ()
	Get the input data object.

vtkPolyData *	GetPolyDataOutput ()
	Get the output as vtkPolyData.

vtkStructuredPoints *	GetStructuredPointsOutput ()
	Get the output as vtkStructuredPoints.

vtkImageData *	GetImageDataOutput ()
	Get the output as vtkStructuredPoints.

vtkStructuredGrid *	GetStructuredGridOutput ()
	Get the output as vtkStructuredGrid.

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()
	Get the output as vtkUnstructuredGrid.

vtkRectilinearGrid *	GetRectilinearGridOutput ()
	Get the output as vtkRectilinearGrid.

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

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

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

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

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

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

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

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

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

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

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

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

vtkAlgorithm *	NewInstance () const

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

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

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

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

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

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

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
	A special version of ProcessRequest meant specifically for the pipeline modified time request.

virtual int	ModifyRequest (vtkInformation *request, int when)
	This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded.

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

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

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

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

void	SetAbortExecuteAndUpdateTime ()
	Set AbortExecute Flag and update LastAbortTime.

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

bool	CheckAbort ()
	Checks to see if this filter should abort.

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

void	RemoveAllInputs ()
	Remove all the input data.

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

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

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

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

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

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

virtual void	SetInputDataObject (vtkDataObject *data)

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

virtual void	AddInputDataObject (vtkDataObject *data)

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

vtkAlgorithmOutput *	GetOutputPort ()

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

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

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

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

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

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

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

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

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

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

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

virtual vtkTypeBool	Update (int port, vtkInformationVector *requests)
	This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date).

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

virtual int	UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

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

virtual VTK_UNBLOCKTHREADS int	UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
	Convenience method to update an algorithm after passing requests to its first output port.

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

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

virtual void	PropagateUpdateExtent ()
	Propagate meta-data upstream.

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

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

void	RemoveNoPriorTemporalAccessInformationKey ()
	Removes any information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()` to all output ports of this `vtkAlgorithm`.

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

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

bool	UsesGarbageCollector () const override
	Participate in garbage collection.

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

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

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

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

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

void	SetContainerAlgorithm (vtkAlgorithm *containerAlg)
	Set/get a Container algorithm for this algorithm.

vtkAlgorithm *	GetContainerAlgorithm ()
	Set/get a Container algorithm for this algorithm.

virtual void	SetAbortOutput (bool)
	Set/Get an internal variable used to communicate between the algorithm and executive.

virtual bool	GetAbortOutput ()
	Set/Get an internal variable used to communicate between the algorithm and executive.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
	This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0.

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

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

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
	These functions return the update extent for output ports that use 3D extents.

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

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

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

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

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

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

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

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

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

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

void	SetNoPriorTemporalAccessInformationKey (int key)
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

void	SetNoPriorTemporalAccessInformationKey ()
	Set to all output ports of this algorithm the information key `vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS()`.

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

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

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

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

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

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

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

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

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

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

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

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

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

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

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

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

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

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events.

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method.

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

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

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

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

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

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

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

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

virtual void	Delete ()
	Delete a VTK object.

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

void	InitializeObjectBase ()

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

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

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

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

void	SetReferenceCount (int)
	Sets the reference count.

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

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

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

Static Public Member Functions
static vtkProbeFilter *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkProbeFilter *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

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

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

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

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

static vtkInformationIntegerKey *	ABORTED ()

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

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

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

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

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

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

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

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class.

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

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

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

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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.

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

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

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

void	Probe (vtkDataSet input, vtkDataSet source, vtkDataSet *output)
	Equivalent to calling BuildFieldList(); InitializeForProbing(); DoProbing().

void	BuildFieldList (vtkDataSet *source)
	Build the field lists.

virtual void	InitializeForProbing (vtkDataSet input, vtkDataSet output)
	Initializes output and various arrays which keep track for probing status.

virtual void	InitializeSourceArrays (vtkDataSet *source)

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.

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

	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm () override=default

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

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

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

virtual int	RequestUpdateTime (vtkInformation , vtkInformationVector , vtkInformationVector )

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

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

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

vtkDataObject *	GetInput (int port)

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

	vtkAlgorithm ()

	~vtkAlgorithm () override

bool	CheckUpstreamAbort ()
	Checks to see if an upstream filter has been aborted.

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

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

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

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

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

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

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

virtual vtkExecutive *	CreateDefaultExecutive ()
	Create a default executive.

void	ReportReferences (vtkGarbageCollector *) override

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

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

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

void	AddInputDataInternal (int port, vtkDataObject *input)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

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

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

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkTypeBool	CategoricalData

vtkTypeBool	PassCellArrays

vtkTypeBool	PassPointArrays

vtkTypeBool	PassFieldArrays

vtkTypeBool	SpatialMatch

double	Tolerance

bool	ComputeTolerance

bool	SnapToCellWithClosestPoint

char *	ValidPointMaskArrayName

vtkIdTypeArray *	ValidPoints

vtkCharArray *	MaskPoints

vtkAbstractCellLocator *	CellLocatorPrototype

vtkFindCellStrategy *	FindCellStrategy

vtkDataSetAttributes::FieldList *	CellList

vtkDataSetAttributes::FieldList *	PointList

Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp	LastAbortCheckTime

vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

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

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

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

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBool >	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp	LastAbortTime

static vtkExecutive *	DefaultExecutivePrototype

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 (using a default vtkClosestPointStrategy) to perform an accelerated search. However, it may fail to identify an enclosing cell in some cases. A more robust but slower approach is to use a vtkCellLocator to perform 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

Examples:: vtkProbeFilter (Examples)

Online Examples:

XYPlot

TissueLens

InterpolateMeshOnGrid

Tests:: vtkProbeFilter (Tests)

Definition at line 186 of file vtkProbeFilter.h.

Member Typedef Documentation

◆ Superclass

typedef vtkDataSetAlgorithm vtkProbeFilter::Superclass

Definition at line 190 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.

◆ 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 ( )

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.

◆ 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

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.

◆ CategoricalDataOn()

virtual void vtkProbeFilter::CategoricalDataOn ( )

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.

◆ CategoricalDataOff()

virtual void vtkProbeFilter::CategoricalDataOff ( )

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.

◆ 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

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.

◆ SpatialMatchOn()

virtual void vtkProbeFilter::SpatialMatchOn ( )

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.

◆ SpatialMatchOff()

virtual void vtkProbeFilter::SpatialMatchOff ( )

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.

◆ 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

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.

◆ 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

Shallow copy the input cell data arrays to the output.

Off by default.

◆ PassCellArraysOff()

virtual void vtkProbeFilter::PassCellArraysOff ( )

virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ GetPassCellArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassCellArrays ( )

virtual

Shallow copy the input cell data arrays to the output.

Off by default.

◆ 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

Shallow copy the input point data arrays to the output.

Off by default.

◆ PassPointArraysOff()

virtual void vtkProbeFilter::PassPointArraysOff ( )

virtual

Shallow copy the input point data arrays to the output.

Off by default.

◆ GetPassPointArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassPointArrays ( )

virtual

Shallow copy the input point data arrays to the output.

Off by default.

◆ 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

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

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

◆ PassFieldArraysOff()

virtual void vtkProbeFilter::PassFieldArraysOff ( )

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.

◆ GetPassFieldArrays()

virtual vtkTypeBool vtkProbeFilter::GetPassFieldArrays ( )

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.

◆ 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

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.

◆ SetSnapToCellWithClosestPoint()

virtual void vtkProbeFilter::SetSnapToCellWithClosestPoint ( bool )

virtual

Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

Default is off.

Note: This is useful only when the source is a vtkPointSet.

◆ SnapToCellWithClosestPointOn()

virtual void vtkProbeFilter::SnapToCellWithClosestPointOn ( )

virtual

Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

Default is off.

Note: This is useful only when the source is a vtkPointSet.

◆ SnapToCellWithClosestPointOff()

virtual void vtkProbeFilter::SnapToCellWithClosestPointOff ( )

virtual

Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

Default is off.

Note: This is useful only when the source is a vtkPointSet.

◆ GetSnapToCellWithClosestPoint()

virtual bool vtkProbeFilter::GetSnapToCellWithClosestPoint ( )

virtual

Set/Get whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed.

Default is off.

Note: This is useful only when the source is a vtkPointSet.

◆ 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

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.

◆ ComputeToleranceOff()

virtual void vtkProbeFilter::ComputeToleranceOff ( )

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.

◆ GetComputeTolerance()

virtual bool vtkProbeFilter::GetComputeTolerance ( )

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.

◆ 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

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.

◆ 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

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.

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

Reimplemented from vtkDataSetAlgorithm.

◆ 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 after the RequestDataObject pass of the pipeline execution process.

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 after the RequestInformation pass of the pipeline execution process.

Reimplemented from vtkDataSetAlgorithm.

◆ 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

Equivalent to calling BuildFieldList(); InitializeForProbing(); DoProbing().

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

◆ InitializeSourceArrays()

virtual void vtkProbeFilter::InitializeSourceArrays ( vtkDataSet * source )

protectedvirtual

◆ 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 383 of file vtkProbeFilter.h.

◆ PassCellArrays

vtkTypeBool vtkProbeFilter::PassCellArrays

protected

Definition at line 385 of file vtkProbeFilter.h.

◆ PassPointArrays

vtkTypeBool vtkProbeFilter::PassPointArrays

protected

Definition at line 386 of file vtkProbeFilter.h.

◆ PassFieldArrays

vtkTypeBool vtkProbeFilter::PassFieldArrays

protected

Definition at line 387 of file vtkProbeFilter.h.

◆ SpatialMatch

vtkTypeBool vtkProbeFilter::SpatialMatch

protected

Definition at line 389 of file vtkProbeFilter.h.

◆ Tolerance

double vtkProbeFilter::Tolerance

protected

Definition at line 391 of file vtkProbeFilter.h.

◆ ComputeTolerance

bool vtkProbeFilter::ComputeTolerance

protected

Definition at line 392 of file vtkProbeFilter.h.

◆ SnapToCellWithClosestPoint

bool vtkProbeFilter::SnapToCellWithClosestPoint

protected

Definition at line 393 of file vtkProbeFilter.h.

◆ ValidPointMaskArrayName

char* vtkProbeFilter::ValidPointMaskArrayName

protected

Definition at line 395 of file vtkProbeFilter.h.

◆ ValidPoints

vtkIdTypeArray* vtkProbeFilter::ValidPoints

protected

Definition at line 396 of file vtkProbeFilter.h.

◆ MaskPoints

vtkCharArray* vtkProbeFilter::MaskPoints

protected

Definition at line 397 of file vtkProbeFilter.h.

◆ CellLocatorPrototype

vtkAbstractCellLocator* vtkProbeFilter::CellLocatorPrototype

protected

Definition at line 400 of file vtkProbeFilter.h.

◆ FindCellStrategy

vtkFindCellStrategy* vtkProbeFilter::FindCellStrategy

protected

Definition at line 401 of file vtkProbeFilter.h.

◆ CellList

vtkDataSetAttributes::FieldList* vtkProbeFilter::CellList

protected

Definition at line 403 of file vtkProbeFilter.h.

◆ PointList

vtkDataSetAttributes::FieldList* vtkProbeFilter::PointList

protected

Definition at line 404 of file vtkProbeFilter.h.

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

Filters/Core/vtkProbeFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkProbeFilter()

◆ ~vtkProbeFilter()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetSourceData()

◆ GetSource()

◆ SetSourceConnection()

◆ SetCategoricalData()

◆ GetCategoricalData()

◆ CategoricalDataOn()

◆ CategoricalDataOff()

◆ SetSpatialMatch()

◆ GetSpatialMatch()

◆ SpatialMatchOn()

◆ SpatialMatchOff()

◆ GetValidPoints()

◆ SetValidPointMaskArrayName()

◆ GetValidPointMaskArrayName()

◆ SetPassCellArrays()

◆ PassCellArraysOn()

◆ PassCellArraysOff()

◆ GetPassCellArrays()

◆ SetPassPointArrays()

◆ PassPointArraysOn()

◆ PassPointArraysOff()

◆ GetPassPointArrays()

◆ SetPassFieldArrays()

◆ PassFieldArraysOn()

◆ PassFieldArraysOff()

◆ GetPassFieldArrays()

◆ SetTolerance()

◆ GetTolerance()

◆ SetSnapToCellWithClosestPoint()

◆ SnapToCellWithClosestPointOn()

◆ SnapToCellWithClosestPointOff()

◆ GetSnapToCellWithClosestPoint()

◆ SetComputeTolerance()

◆ ComputeToleranceOn()

◆ ComputeToleranceOff()

◆ GetComputeTolerance()

◆ SetFindCellStrategy()

◆ GetFindCellStrategy()

◆ SetCellLocatorPrototype()

◆ GetCellLocatorPrototype()

◆ RequestData()

◆ RequestInformation()

◆ RequestUpdateExtent()

◆ PassAttributeData()

◆ Probe()

◆ BuildFieldList()

◆ InitializeForProbing()

◆ InitializeSourceArrays()

◆ InitializeOutputArrays()

◆ DoProbing()

Member Data Documentation

◆ CategoricalData

◆ PassCellArrays

◆ PassPointArrays

◆ PassFieldArrays

◆ SpatialMatch

◆ Tolerance

◆ ComputeTolerance

◆ SnapToCellWithClosestPoint

◆ ValidPointMaskArrayName