vtkCompositeDataProbeFilter Class Reference

#include <vtkCompositeDataProbeFilter.h>

Inheritance diagram for vtkCompositeDataProbeFilter:

Inheritance graph
[legend]
Collaboration diagram for vtkCompositeDataProbeFilter:

Collaboration graph
[legend]

List of all members.


Detailed Description

subclass of vtkProbeFilter which supports composite datasets in the input.

vtkCompositeDataProbeFilter supports probing into multi-group datasets. It sequentially probes through each concrete dataset within the composite probing at only those locations at which there were no hits when probing earlier datasets. For Hierarchical datasets, this traversal through leaf datasets is done in reverse order of levels i.e. highest level first.

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.

Definition at line 43 of file vtkCompositeDataProbeFilter.h.


Public Types

typedef vtkProbeFilter Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetPassPartialArrays (bool)
virtual bool GetPassPartialArrays ()
virtual void PassPartialArraysOn ()
virtual void PassPartialArraysOff ()

Static Public Member Functions

static
vtkCompositeDataProbeFilter
New ()
static int IsTypeOf (const char *type)
static
vtkCompositeDataProbeFilter
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkCompositeDataProbeFilter ()
 ~vtkCompositeDataProbeFilter ()
virtual int FillInputPortInformation (int port, vtkInformation *info)
int BuildFieldList (vtkCompositeDataSet *source)
virtual void InitializeForProbing (vtkDataSet *input, vtkDataSet *output)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

bool PassPartialArrays

Member Typedef Documentation

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

Definition at line 47 of file vtkCompositeDataProbeFilter.h.


Constructor & Destructor Documentation

vtkCompositeDataProbeFilter::vtkCompositeDataProbeFilter (  )  [protected]

vtkCompositeDataProbeFilter::~vtkCompositeDataProbeFilter (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

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

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

static int vtkCompositeDataProbeFilter::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 vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

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

Reimplemented in vtkPProbeFilter.

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

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

void vtkCompositeDataProbeFilter::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 vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

virtual void vtkCompositeDataProbeFilter::SetPassPartialArrays ( bool   )  [virtual]

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.

virtual bool vtkCompositeDataProbeFilter::GetPassPartialArrays (  )  [virtual]

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.

virtual void vtkCompositeDataProbeFilter::PassPartialArraysOn (  )  [virtual]

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.

virtual void vtkCompositeDataProbeFilter::PassPartialArraysOff (  )  [virtual]

When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial array are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, while 0 for all other types of arrays i.e int, char etc.

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

Change input information to accept composite datasets as the input which is probed into.

Reimplemented from vtkDataSetAlgorithm.

Reimplemented in vtkPProbeFilter.

int vtkCompositeDataProbeFilter::BuildFieldList ( vtkCompositeDataSet source  )  [protected]

Builds the field list using the composite dataset source.

virtual void vtkCompositeDataProbeFilter::InitializeForProbing ( vtkDataSet input,
vtkDataSet output 
) [protected, virtual]

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

Reimplemented from vtkProbeFilter.

virtual int vtkCompositeDataProbeFilter::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
) [protected, virtual]

Handle composite input.

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

virtual vtkExecutive* vtkCompositeDataProbeFilter::CreateDefaultExecutive (  )  [protected, virtual]

Create a default executive.

Reimplemented from vtkAlgorithm.


Member Data Documentation

Definition at line 92 of file vtkCompositeDataProbeFilter.h.


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

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