VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkProbeFilter Class Reference

sample data values at specified point locations More...

#include <vtkProbeFilter.h>

Inheritance diagram for vtkProbeFilter:
[legend]

Public Types

typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkProbeFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
 
void SetSourceData (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 ()
 
virtual void SetPassCellArrays (int)
 
virtual int GetPassCellArrays ()
 
virtual void SetPassPointArrays (int)
 
virtual int GetPassPointArrays ()
 

Static Public Member Functions

static vtkProbeFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkProbeFilterSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 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 BuildFieldList (vtkDataSet *source)
 
virtual void InitializeForProbing (vtkDataSet *input, vtkDataSet *output)
 
void ProbeEmptyPoints (vtkDataSet *input, int srcIdx, vtkDataSet *source, vtkDataSet *output)
 

Protected Attributes

int PassCellArrays
 
int PassPointArrays
 
int SpatialMatch
 
char * ValidPointMaskArrayName
 
vtkIdTypeArray * ValidPoints
 
vtkCharArray * MaskPoints
 
int NumberOfValidPoints
 
bool UseNullPoint
 
vtkDataSetAttributes::FieldList * CellList
 
vtkDataSetAttributes::FieldList * PointList
 

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

Member Typedef Documentation

typedef vtkDataSetAlgorithm vtkProbeFilter::Superclass

Definition at line 58 of file vtkProbeFilter.h.

Constructor & Destructor Documentation

vtkProbeFilter::vtkProbeFilter ( )
protected
vtkProbeFilter::~vtkProbeFilter ( )
protected

Member Function Documentation

static vtkProbeFilter* vtkProbeFilter::New ( )
static
static int vtkProbeFilter::IsTypeOf ( const char *  type)
static
virtual int vtkProbeFilter::IsA ( const char *  type)
virtual
static vtkProbeFilter* vtkProbeFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkProbeFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkProbeFilter* vtkProbeFilter::NewInstance ( ) const
void vtkProbeFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
void vtkProbeFilter::SetSourceData ( vtkDataObject *  source)

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

vtkDataObject* vtkProbeFilter::GetSource ( )

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

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 void vtkProbeFilter::SetPassCellArrays ( int  )
virtual

Shallow copy the input arrays to the output.

virtual int vtkProbeFilter::GetPassCellArrays ( )
virtual

Shallow copy the input arrays to the output.

virtual void vtkProbeFilter::SetPassPointArrays ( int  )
virtual

Shallow copy the input arrays to the output.

virtual int vtkProbeFilter::GetPassPointArrays ( )
virtual

Shallow copy the input arrays to the output.

virtual int vtkProbeFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual
virtual int vtkProbeFilter::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented in vtkPProbeFilter.

virtual int vtkProbeFilter::RequestUpdateExtent ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented in vtkPProbeFilter.

void vtkProbeFilter::Probe ( vtkDataSet *  input,
vtkDataSet *  source,
vtkDataSet *  output 
)
protected

Equivalent to calling InitializeForProbing(); ProbeEmptyPoints().

void vtkProbeFilter::BuildFieldList ( vtkDataSet *  source)
protected

Build the field lists. This is required before calling InitializeForProbing().

virtual void vtkProbeFilter::InitializeForProbing ( vtkDataSet *  input,
vtkDataSet *  output 
)
protectedvirtual

Initializes output and various arrays which keep track for probing status.

Reimplemented in vtkCompositeDataProbeFilter.

void vtkProbeFilter::ProbeEmptyPoints ( vtkDataSet *  input,
int  srcIdx,
vtkDataSet *  source,
vtkDataSet *  output 
)
protected

Probe only those points that are marked as not-probed by the MaskPoints array. srcIdx is the index in the PointList for the given source.

Member Data Documentation

int vtkProbeFilter::PassCellArrays
protected

Definition at line 114 of file vtkProbeFilter.h.

int vtkProbeFilter::PassPointArrays
protected

Definition at line 115 of file vtkProbeFilter.h.

int vtkProbeFilter::SpatialMatch
protected

Definition at line 117 of file vtkProbeFilter.h.

char* vtkProbeFilter::ValidPointMaskArrayName
protected

Definition at line 145 of file vtkProbeFilter.h.

vtkIdTypeArray* vtkProbeFilter::ValidPoints
protected

Definition at line 146 of file vtkProbeFilter.h.

vtkCharArray* vtkProbeFilter::MaskPoints
protected

Definition at line 147 of file vtkProbeFilter.h.

int vtkProbeFilter::NumberOfValidPoints
protected

Definition at line 148 of file vtkProbeFilter.h.

bool vtkProbeFilter::UseNullPoint
protected

Definition at line 154 of file vtkProbeFilter.h.

vtkDataSetAttributes::FieldList* vtkProbeFilter::CellList
protected

Definition at line 156 of file vtkProbeFilter.h.

vtkDataSetAttributes::FieldList* vtkProbeFilter::PointList
protected

Definition at line 157 of file vtkProbeFilter.h.


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