vtkGenericProbeFilter Class Reference

#include <vtkGenericProbeFilter.h>

Inheritance diagram for vtkGenericProbeFilter:

[legend]Collaboration diagram for vtkGenericProbeFilter:

[legend]List of all members.

Detailed Description

sample data values at specified point locations

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

This filter can be used to resample data, or convert one dataset form into another. For example, a generic dataset 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.

This filter has been implemented to operate on generic datasets, rather than the typical vtkDataSet (and subclasses). vtkGenericDataSet is a more complex cousin of vtkDataSet, typically consisting of nonlinear, higher-order cells. To process this type of data, generic cells are automatically tessellated into linear cells prior to isocontouring.

See also:: vtkGenericProbeFilter vtkProbeFilter vtkGenericDataSet

Created by:

Bertel, Francois

CVS contributions (if > 5%):

Bertel, Francois (80%)
Schroeder, Will (19%)

CVS logs (CVSweb):

.cxx (/GenericFiltering/vtkGenericProbeFilter.cxx)
.h (/GenericFiltering/vtkGenericProbeFilter.h)

Definition at line 60 of file vtkGenericProbeFilter.h.

Public Types

typedef vtkDataSetToDataSetFilter Superclass

Public Member Functions

virtual const char * GetClassName ()

virtual int IsA (const char *type)

void PrintSelf (ostream &os, vtkIndent indent)

void SetSource (vtkGenericDataSet *source)

vtkGenericDataSet * GetSource ()

virtual vtkIdTypeArray * GetValidPoints ()

Static Public Member Functions

vtkGenericProbeFilter * New ()

int IsTypeOf (const char *type)

vtkGenericProbeFilter * SafeDownCast (vtkObject *o)

Protected Member Functions

vtkGenericProbeFilter ()

~vtkGenericProbeFilter ()

virtual void Execute ()

Protected Attributes

vtkIdTypeArray * ValidPoints

Member Typedef Documentation

typedef vtkDataSetToDataSetFilter vtkGenericProbeFilter::Superclass

Reimplemented from vtkDataSetToDataSetFilter.
Definition at line 64 of file vtkGenericProbeFilter.h.

Constructor & Destructor Documentation

vtkGenericProbeFilter::vtkGenericProbeFilter ( ) [protected]

vtkGenericProbeFilter::~vtkGenericProbeFilter ( ) [protected]

Member Function Documentation

vtkGenericProbeFilter* vtkGenericProbeFilter::New ( ) [static]

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

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

Reimplemented from vtkDataSetToDataSetFilter.

int vtkGenericProbeFilter::IsTypeOf ( const char * type ) [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 vtkDataSetToDataSetFilter.

virtual int vtkGenericProbeFilter::IsA ( const char * type ) [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 vtkDataSetToDataSetFilter.

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

Reimplemented from vtkDataSetToDataSetFilter.

void vtkGenericProbeFilter::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 vtkDataSetToDataSetFilter.

void vtkGenericProbeFilter::SetSource ( vtkGenericDataSet * source )

Specify the point locations used to probe input. A generic dataset type is assumed.

vtkGenericDataSet* vtkGenericProbeFilter::GetSource ( )

Specify the point locations used to probe input. A generic dataset type is assumed.

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

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

virtual void vtkGenericProbeFilter::Execute ( ) [protected, virtual]

This method is the old style execute method
Reimplemented from vtkSource.

Member Data Documentation

vtkIdTypeArray* vtkGenericProbeFilter::ValidPoints [protected]

Definition at line 86 of file vtkGenericProbeFilter.h.

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

dox/GenericFiltering/vtkGenericProbeFilter.h


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

void	SetSource (vtkGenericDataSet *source)
vtkGenericDataSet *	GetSource ()

virtual vtkIdTypeArray *	GetValidPoints ()
Static Public Member Functions
vtkGenericProbeFilter *	New ()
int	IsTypeOf (const char *type)
vtkGenericProbeFilter *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkGenericProbeFilter ()
	~vtkGenericProbeFilter ()
virtual void	Execute ()
Protected Attributes
vtkIdTypeArray *	ValidPoints