vtkProbeFilter Class Reference

#include <vtkProbeFilter.h>

Inheritance diagram for vtkProbeFilter:

[legend]

Collaboration diagram for vtkProbeFilter:

[legend]

List of all members.

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.

Examples:: vtkProbeFilter (Examples)

Tests:: vtkProbeFilter (Tests)

Definition at line 52 of file vtkProbeFilter.h.


Public Types
typedef vtkDataSetAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetSourceConnection (vtkAlgorithmOutput *algOutput)

void	SetSource (vtkDataObject *source)
vtkDataObject *	GetSource ()

virtual void	SetSpatialMatch (int)
virtual int	GetSpatialMatch ()
virtual void	SpatialMatchOn ()
virtual void	SpatialMatchOff ()

virtual vtkIdTypeArray *	GetValidPoints ()

virtual void	SetValidPointMaskArrayName (const char *)
virtual char *	GetValidPointMaskArrayName ()
Static Public Member Functions
static vtkProbeFilter *	New ()
static int	IsTypeOf (const char *type)
static vtkProbeFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkProbeFilter ()
	~vtkProbeFilter ()
virtual int	RequestData (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestInformation (vtkInformation , vtkInformationVector , vtkInformationVector )
virtual int	RequestUpdateExtent (vtkInformation , vtkInformationVector , vtkInformationVector )
void	Probe (vtkDataSet input, vtkDataSet source, vtkDataSet *output)

void	InitializeForProbing (vtkDataSet input, vtkDataSet source, vtkDataSet *output)

void	ProbeEmptyPoints (vtkDataSet input, vtkDataSet source, vtkDataSet *output)
Protected Attributes
int	SpatialMatch
char *	ValidPointMaskArrayName
vtkIdTypeArray *	ValidPoints
vtkCharArray *	MaskPoints
int	NumberOfValidPoints

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkProbeFilter::Superclass

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

Definition at line 56 of file vtkProbeFilter.h.

Constructor & Destructor Documentation

vtkProbeFilter::vtkProbeFilter ( ) [protected]

vtkProbeFilter::~vtkProbeFilter ( ) [protected]

Member Function Documentation

static vtkProbeFilter* vtkProbeFilter::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

virtual const char* vtkProbeFilter::GetClassName ( ) [virtual]

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

static int vtkProbeFilter::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

virtual int 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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

static vtkProbeFilter* vtkProbeFilter::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

void vtkProbeFilter::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

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 vtkCompositeDataProbeFilter, and vtkPProbeFilter.

void vtkProbeFilter::SetSource ( vtkDataObject * source )

Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.

vtkDataObject* vtkProbeFilter::GetSource ( )

Specify the point locations used to probe input. Any geometry can be used. Old style. Do not use unless for backwards compatibility.

void vtkProbeFilter::SetSourceConnection ( vtkAlgorithmOutput * algOutput )

Specify the point locations used to probe input. Any geometry can be used. New style. Equivalent to SetInputConnection(1, algOutput).

virtual void vtkProbeFilter::SetSpatialMatch ( int ) [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.

virtual int 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.

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.

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.

virtual vtkIdTypeArray* vtkProbeFilter::GetValidPoints ( ) [virtual]

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

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.

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.

virtual int vtkProbeFilter::RequestData	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

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 vtkCompositeDataProbeFilter, and vtkPProbeFilter.

virtual int vtkProbeFilter::RequestInformation	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

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.

Reimplemented in vtkPProbeFilter.

virtual int vtkProbeFilter::RequestUpdateExtent	(	vtkInformation *	,
		vtkInformationVector **	,
		vtkInformationVector *
	)			`[protected, virtual]`

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.