sample data values at specified point locations More...

#include <vtkProbeFilter.h>

Inheritance diagram for vtkProbeFilter:

Collaboration diagram for vtkProbeFilter:

Public Types
typedef vtkDataSetAlgorithm	Superclass

Public Types inherited from vtkDataSetAlgorithm
typedef vtkAlgorithm	Superclass

Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass

enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkProbeFilter *	NewInstance () 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 void	PassCellArraysOn ()

virtual void	PassCellArraysOff ()

virtual int	GetPassCellArrays ()


virtual void	SetPassPointArrays (int)

virtual void	PassPointArraysOn ()

virtual void	PassPointArraysOff ()

virtual int	GetPassPointArrays ()


virtual void	SetPassFieldArrays (int)

virtual void	PassFieldArraysOn ()

virtual void	PassFieldArraysOff ()

virtual int	GetPassFieldArrays ()


virtual void	SetTolerance (double)

virtual double	GetTolerance ()


virtual void	SetComputeTolerance (bool)

virtual void	ComputeToleranceOn ()

virtual void	ComputeToleranceOff ()

virtual bool	GetComputeTolerance ()

Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataSetAlgorithm *	NewInstance () const

vtkDataObject *	GetInput ()

vtkPolyData *	GetPolyDataOutput ()

vtkStructuredPoints *	GetStructuredPointsOutput ()

vtkImageData *	GetImageDataOutput ()

vtkStructuredGrid *	GetStructuredGridOutput ()

vtkUnstructuredGrid *	GetUnstructuredGridOutput ()

vtkRectilinearGrid *	GetRectilinearGridOutput ()

vtkDataSet *	GetOutput ()

vtkDataSet *	GetOutput (int)

void	SetInputData (vtkDataObject *)

void	SetInputData (int, vtkDataObject *)

void	SetInputData (vtkDataSet *)

void	SetInputData (int, vtkDataSet *)

void	AddInputData (vtkDataObject *)

void	AddInputData (vtkDataSet *)

void	AddInputData (int, vtkDataSet *)

void	AddInputData (int, vtkDataObject *)

virtual int	ProcessRequest (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const

int	HasExecutive ()

vtkExecutive *	GetExecutive ()

virtual void	SetExecutive (vtkExecutive *executive)

virtual int	ModifyRequest (vtkInformation *request, int when)

vtkInformation *	GetInputPortInformation (int port)

vtkInformation *	GetOutputPortInformation (int port)

int	GetNumberOfInputPorts ()

int	GetNumberOfOutputPorts ()

void	UpdateProgress (double amount)

vtkInformation *	GetInputArrayInformation (int idx)

void	RemoveAllInputs ()

vtkDataObject *	GetOutputDataObject (int port)

virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	RemoveInputConnection (int port, int idx)

virtual void	RemoveAllInputConnections (int port)

int	GetNumberOfInputConnections (int port)

int	GetTotalNumberOfInputConnections ()

vtkAlgorithmOutput *	GetInputConnection (int port, int index)

vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)

vtkAlgorithm *	GetInputAlgorithm (int port, int index)

vtkExecutive *	GetInputExecutive (int port, int index)

vtkInformation *	GetInputInformation (int port, int index)

vtkInformation *	GetOutputInformation (int port)

virtual void	UpdateInformation ()

virtual void	UpdateDataObject ()

virtual void	PropagateUpdateExtent ()

virtual void	UpdateWholeExtent ()

void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)

int	SetUpdateExtentToWholeExtent (int port)

int	SetUpdateExtentToWholeExtent ()

void	SetUpdateExtent (int port, int extent[6])

int	ProcessRequest (vtkInformation request, vtkCollection inInfo, vtkInformationVector *outInfo)

virtual int	ComputePipelineMTime (vtkInformation request, vtkInformationVector inInfoVec, vtkInformationVector outInfoVec, int requestFromOutputPort, unsigned long *mtime)

virtual vtkInformation *	GetInformation ()

virtual void	SetInformation (vtkInformation *)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

virtual void	SetAbortExecute (int)

virtual int	GetAbortExecute ()

virtual void	AbortExecuteOn ()

virtual void	AbortExecuteOff ()

virtual void	SetProgress (double)

virtual double	GetProgress ()

void	SetProgressText (const char *ptext)

virtual char *	GetProgressText ()

virtual unsigned long	GetErrorCode ()

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)

virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)

virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char fieldAssociation, const char attributeTypeorName)

vtkDataObject *	GetInputDataObject (int port, int connection)

virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	SetInputConnection (vtkAlgorithmOutput *input)

virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)

virtual void	AddInputConnection (vtkAlgorithmOutput *input)

virtual void	SetInputDataObject (int port, vtkDataObject *data)

virtual void	SetInputDataObject (vtkDataObject *data)

virtual void	AddInputDataObject (int port, vtkDataObject *data)

virtual void	AddInputDataObject (vtkDataObject *data)

vtkAlgorithmOutput *	GetOutputPort (int index)

vtkAlgorithmOutput *	GetOutputPort ()

vtkAlgorithm *	GetInputAlgorithm ()

vtkExecutive *	GetInputExecutive ()

vtkInformation *	GetInputInformation ()

virtual void	Update (int port)

virtual void	Update ()

virtual void	SetReleaseDataFlag (int)

virtual int	GetReleaseDataFlag ()

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

int	UpdateExtentIsEmpty (vtkInformation pinfo, vtkDataObject output)

int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)

void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)

void	SetUpdateExtent (int extent[6])

int *	GetUpdateExtent ()

int *	GetUpdateExtent (int port)

void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)

void	GetUpdateExtent (int extent[6])

void	GetUpdateExtent (int port, int extent[6])

int	GetUpdatePiece ()

int	GetUpdatePiece (int port)

int	GetUpdateNumberOfPieces ()

int	GetUpdateNumberOfPieces (int port)

int	GetUpdateGhostLevel ()

int	GetUpdateGhostLevel (int port)

void	SetProgressObserver (vtkProgressObserver *)

virtual vtkProgressObserver *	GetProgressObserver ()

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkProbeFilter *	New ()

static int	IsTypeOf (const char *type)

static vtkProbeFilter *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkDataSetAlgorithm
static vtkDataSetAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkDataSetAlgorithm *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()

static int	IsTypeOf (const char *type)

static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()

static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()

static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()

static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()

static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()

static vtkInformationIntegerKey *	INPUT_PORT ()

static vtkInformationIntegerKey *	INPUT_CONNECTION ()

static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()

static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()

static void	SetDefaultExecutivePrototype (vtkExecutive *proto)

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

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	PassAttributeData (vtkDataSet input, vtkDataObject source, vtkDataSet *output)


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

Protected Member Functions inherited from vtkDataSetAlgorithm
	vtkDataSetAlgorithm ()

	~vtkDataSetAlgorithm ()

virtual int	FillOutputPortInformation (int port, vtkInformation *info)

virtual int	FillInputPortInformation (int port, vtkInformation *info)

vtkDataObject *	GetInput (int port)

virtual int	RequestDataObject (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()

	~vtkAlgorithm ()

virtual void	SetNumberOfInputPorts (int n)

virtual void	SetNumberOfOutputPorts (int n)

int	InputPortIndexInRange (int index, const char *action)

int	OutputPortIndexInRange (int index, const char *action)

int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)

virtual vtkExecutive *	CreateDefaultExecutive ()

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	SetNumberOfInputConnections (int port, int n)

int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)

int	GetInputArrayAssociation (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)

vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)

vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)

vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)

virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)

void	SetInputDataInternal (int port, vtkDataObject *input)

void	AddInputDataInternal (int port, vtkDataObject *input)

virtual void	SetErrorCode (unsigned long)

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	PassCellArrays

int	PassPointArrays

int	PassFieldArrays

int	SpatialMatch

double	Tolerance

bool	ComputeTolerance

char *	ValidPointMaskArrayName

vtkIdTypeArray *	ValidPoints

vtkCharArray *	MaskPoints

int	NumberOfValidPoints

bool	UseNullPoint

vtkDataSetAttributes::FieldList *	CellList

vtkDataSetAttributes::FieldList *	PointList

Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information

double	Progress

char *	ProgressText

vtkProgressObserver *	ProgressObserver

unsigned long	ErrorCode

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Public Attributes inherited from vtkAlgorithm
int	AbortExecute

Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()

Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

static vtkProbeFilter* vtkProbeFilter::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkProbeFilter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkCompositeDataProbeFilter, and vtkPProbeFilter.

vtkProbeFilter* vtkProbeFilter::NewInstance ( ) const

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

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 cell data arrays to the output. Off by default.

virtual void vtkProbeFilter::PassCellArraysOn ( )

virtual

Shallow copy the input cell data arrays to the output. Off by default.

virtual void vtkProbeFilter::PassCellArraysOff ( )

virtual

Shallow copy the input cell data arrays to the output. Off by default.

virtual int vtkProbeFilter::GetPassCellArrays ( )

virtual

Shallow copy the input cell data arrays to the output. Off by default.

virtual void vtkProbeFilter::SetPassPointArrays ( int )

virtual

Shallow copy the input point data arrays to the output Off by default.

virtual void vtkProbeFilter::PassPointArraysOn ( )

virtual

Shallow copy the input point data arrays to the output Off by default.

virtual void vtkProbeFilter::PassPointArraysOff ( )

virtual

Shallow copy the input point data arrays to the output Off by default.

virtual int vtkProbeFilter::GetPassPointArrays ( )

virtual

Shallow copy the input point data arrays to the output Off by default.

virtual void vtkProbeFilter::SetPassFieldArrays ( int )

virtual

Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default.

virtual void vtkProbeFilter::PassFieldArraysOn ( )

virtual

Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default.

virtual void vtkProbeFilter::PassFieldArraysOff ( )

virtual

Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default.

virtual int vtkProbeFilter::GetPassFieldArrays ( )

virtual

Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default.

virtual void vtkProbeFilter::SetTolerance ( double )

virtual

Set the tolerance used to compute whether a point in the source is in a cell of the input. This value is only used if ComputeTolerance is off.

virtual double vtkProbeFilter::GetTolerance ( )

virtual

Set the tolerance used to compute whether a point in the source is in a cell of the input. This value is only used if ComputeTolerance is off.

virtual void vtkProbeFilter::SetComputeTolerance ( bool )

virtual

Set whether to use the Tolerance field or precompute the tolerance. When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual void vtkProbeFilter::ComputeToleranceOn ( )

virtual

Set whether to use the Tolerance field or precompute the tolerance. When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual void vtkProbeFilter::ComputeToleranceOff ( )

virtual

Set whether to use the Tolerance field or precompute the tolerance. When on, the tolerance will be computed and the field value is ignored. Off by default.

virtual bool vtkProbeFilter::GetComputeTolerance ( )

virtual

Set whether to use the Tolerance field or precompute the tolerance. When on, the tolerance will be computed and the field value is ignored. Off by default.

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

protectedvirtual

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

protectedvirtual

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.

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

protectedvirtual

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.

void vtkProbeFilter::PassAttributeData	(	vtkDataSet *	input,
		vtkDataObject *	source,
		vtkDataSet *	output
	)

protected

Call at end of RequestData() to pass attribute data respecting the PassCellArrays, PassPointArrays, PassFieldArrays flags.

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

int vtkProbeFilter::PassPointArrays

protected

Definition at line 147 of file vtkProbeFilter.h.

int vtkProbeFilter::PassFieldArrays

protected

Definition at line 148 of file vtkProbeFilter.h.

int vtkProbeFilter::SpatialMatch

protected

Definition at line 150 of file vtkProbeFilter.h.

double vtkProbeFilter::Tolerance

protected

Definition at line 152 of file vtkProbeFilter.h.

bool vtkProbeFilter::ComputeTolerance

protected

Definition at line 153 of file vtkProbeFilter.h.

char* vtkProbeFilter::ValidPointMaskArrayName

protected

Definition at line 188 of file vtkProbeFilter.h.

vtkIdTypeArray* vtkProbeFilter::ValidPoints

protected

Definition at line 189 of file vtkProbeFilter.h.

vtkCharArray* vtkProbeFilter::MaskPoints

protected

Definition at line 190 of file vtkProbeFilter.h.

int vtkProbeFilter::NumberOfValidPoints

protected

Definition at line 191 of file vtkProbeFilter.h.

bool vtkProbeFilter::UseNullPoint

protected

Definition at line 197 of file vtkProbeFilter.h.

vtkDataSetAttributes::FieldList* vtkProbeFilter::CellList

protected

Definition at line 199 of file vtkProbeFilter.h.

vtkDataSetAttributes::FieldList* vtkProbeFilter::PointList

protected

Definition at line 200 of file vtkProbeFilter.h.

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Filters/Core/vtkProbeFilter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation