---

vtkProbeFilter Class Reference

sample data values at specified point locations. More...

#include <vtkProbeFilter.h>

Inheritance diagram for vtkProbeFilter:

[legend]Collaboration diagram for vtkProbeFilter:

[legend]List of all members.

Public Methods
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetSource (vtkDataSet *source)
vtkDataSet *	GetSource ()
void	SetSource (vtkImageData *cache)
virtual void	SetSource (vtkStructuredPoints *sp)
virtual void	SetSpatialMatch (int)
virtual int	GetSpatialMatch ()
virtual void	SpatialMatchOn ()
virtual void	SpatialMatchOff ()
Static Public Methods
vtkProbeFilter *	New ()
int	IsTypeOf (const char *type)
vtkProbeFilter *	SafeDownCast (vtkObject *o)
Protected Methods
	vtkProbeFilter ()
	~vtkProbeFilter ()
	vtkProbeFilter (const vtkProbeFilter &)
void	operator= (const vtkProbeFilter &)
void	Execute ()
void	ExecuteInformation ()
void	ComputeInputUpdateExtents (vtkDataObject *output)
Protected Attributes
int	SpatialMatch

---

Detailed Description

sample data values at specified point locations.

Date:

2000/12/10 20:08:47

Revision:

1.37

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

Examples:

vtkProbeFilter (examples)

Definition at line 62 of file vtkProbeFilter.h.

---

Constructor & Destructor Documentation

vtkProbeFilter::vtkProbeFilter (    )  [protected]

vtkProbeFilter::~vtkProbeFilter (    )  [protected]

vtkProbeFilter::vtkProbeFilter (  const vtkProbeFilter &    )  [inline, protected]

Definition at line 95 of file vtkProbeFilter.h.

---

Member Function Documentation

vtkProbeFilter* vtkProbeFilter::New (    )  [static]

Instantiate object with no start, end, or progress methods. Reimplemented from vtkDataSetSource.

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkDataSetToDataSetFilter.

int vtkProbeFilter::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkDataSetToDataSetFilter.

virtual int vtkProbeFilter::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 vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkDataSetToDataSetFilter.

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

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h. Reimplemented from vtkDataSetToDataSetFilter.

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

void vtkProbeFilter::SetSource (  vtkDataSet *    source )

Specify the point locations used to probe input. Any geometry can be used.

vtkDataSet* vtkProbeFilter::GetSource (    )

void vtkProbeFilter::SetSource (  vtkImageData *    cache )  [inline]

Definition at line 73 of file vtkProbeFilter.h.

virtual void vtkProbeFilter::SetSource (  vtkStructuredPoints *    sp )  [inline, virtual]

Definition at line 77 of file vtkProbeFilter.h.

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]

virtual void vtkProbeFilter::SpatialMatchOn (    )  [virtual]

virtual void vtkProbeFilter::SpatialMatchOff (    )  [virtual]

void vtkProbeFilter::operator= (  const vtkProbeFilter &    )  [inline, protected]

Definition at line 96 of file vtkProbeFilter.h.

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

Reimplemented from vtkSource.

void vtkProbeFilter::ExecuteInformation (    )  [protected, virtual]

Reimplemented from vtkDataSetToDataSetFilter.

void vtkProbeFilter::ComputeInputUpdateExtents (  vtkDataObject *    output )  [protected, virtual]

By default copy the output update extent to the input Reimplemented from vtkDataSetToDataSetFilter.

---

Member Data Documentation

int vtkProbeFilter::SpatialMatch [protected]

Definition at line 98 of file vtkProbeFilter.h.

---

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

• graphics/vtkProbeFilter.h

---