vtkGenericProbeFilter Class Reference

#include <vtkGenericProbeFilter.h>

Inheritance diagram for vtkGenericProbeFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkGenericProbeFilter:

Collaboration graph
[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
Tests:
vtkGenericProbeFilter (Tests)

Definition at line 52 of file vtkGenericProbeFilter.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 SetSource (vtkGenericDataSet *source)
vtkGenericDataSetGetSource ()
virtual vtkIdTypeArrayGetValidPoints ()

Static Public Member Functions

static vtkGenericProbeFilterNew ()
static int IsTypeOf (const char *type)
static vtkGenericProbeFilterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGenericProbeFilter ()
 ~vtkGenericProbeFilter ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int FillInputPortInformation (int, vtkInformation *)

Protected Attributes

vtkIdTypeArrayValidPoints

Member Typedef Documentation

Reimplemented from vtkDataSetAlgorithm.

Definition at line 56 of file vtkGenericProbeFilter.h.


Constructor & Destructor Documentation

vtkGenericProbeFilter::vtkGenericProbeFilter (  )  [protected]

vtkGenericProbeFilter::~vtkGenericProbeFilter (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkDataSetAlgorithm.

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

Reimplemented from vtkDataSetAlgorithm.

static int vtkGenericProbeFilter::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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkDataSetAlgorithm.

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

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

Reimplemented from vtkDataSetAlgorithm.

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

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.

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

int vtkGenericProbeFilter::FillInputPortInformation ( int  port,
vtkInformation info 
) [protected, virtual]

Fill the input port information objects for this algorithm. This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkDataSetAlgorithm.


Member Data Documentation

Definition at line 80 of file vtkGenericProbeFilter.h.


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

Generated on Wed Aug 24 11:37:31 2011 for VTK by  doxygen 1.5.6