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
vtkCompositeDataProbeFilter Class Reference

subclass of vtkProbeFilter which supports composite datasets in the input. More...

#include <vtkCompositeDataProbeFilter.h>

Inheritance diagram for vtkCompositeDataProbeFilter:
[legend]
Collaboration diagram for vtkCompositeDataProbeFilter:
[legend]

Public Types

typedef vtkProbeFilter Superclass
 
- Public Types inherited from vtkProbeFilter
typedef vtkDataSetAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkCompositeDataProbeFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetPassPartialArrays (bool)
 
virtual bool GetPassPartialArrays ()
 
virtual void PassPartialArraysOn ()
 
virtual void PassPartialArraysOff ()
 
- Public Member Functions inherited from vtkProbeFilter
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
vtkCompositeDataProbeFilter
New ()
 
static int IsTypeOf (const char *type)
 
static
vtkCompositeDataProbeFilter
SafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkProbeFilter
static vtkProbeFilterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkProbeFilterSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkCompositeDataProbeFilter ()
 
 ~vtkCompositeDataProbeFilter ()
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
int BuildFieldList (vtkCompositeDataSet *source)
 
virtual void InitializeForProbing (vtkDataSet *input, vtkDataSet *output)
 
virtual vtkExecutive * CreateDefaultExecutive ()
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkProbeFilter
 vtkProbeFilter ()
 
 ~vtkProbeFilter ()
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
void Probe (vtkDataSet *input, vtkDataSet *source, vtkDataSet *output)
 
void BuildFieldList (vtkDataSet *source)
 
void ProbeEmptyPoints (vtkDataSet *input, int srcIdx, vtkDataSet *source, vtkDataSet *output)
 

Protected Attributes

bool PassPartialArrays
 
- Protected Attributes inherited from vtkProbeFilter
int PassCellArrays
 
int PassPointArrays
 
int SpatialMatch
 
char * ValidPointMaskArrayName
 
vtkIdTypeArray * ValidPoints
 
vtkCharArray * MaskPoints
 
int NumberOfValidPoints
 
bool UseNullPoint
 
vtkDataSetAttributes::FieldList * CellList
 
vtkDataSetAttributes::FieldList * PointList
 

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 44 of file vtkCompositeDataProbeFilter.h.

Member Typedef Documentation

Definition at line 48 of file vtkCompositeDataProbeFilter.h.

Constructor & Destructor Documentation

vtkCompositeDataProbeFilter::vtkCompositeDataProbeFilter ( )
protected
vtkCompositeDataProbeFilter::~vtkCompositeDataProbeFilter ( )
protected

Member Function Documentation

static vtkCompositeDataProbeFilter* vtkCompositeDataProbeFilter::New ( )
static
static int vtkCompositeDataProbeFilter::IsTypeOf ( const char *  type)
static
virtual int vtkCompositeDataProbeFilter::IsA ( const char *  type)
virtual

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

static vtkCompositeDataProbeFilter* vtkCompositeDataProbeFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkCompositeDataProbeFilter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

vtkCompositeDataProbeFilter* vtkCompositeDataProbeFilter::NewInstance ( ) const
void vtkCompositeDataProbeFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 
)
protectedvirtual

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

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

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

Reimplemented from vtkProbeFilter.

virtual int vtkCompositeDataProbeFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Handle composite input.

Reimplemented from vtkProbeFilter.

Reimplemented in vtkPProbeFilter.

virtual vtkExecutive* vtkCompositeDataProbeFilter::CreateDefaultExecutive ( )
protectedvirtual

Create a default executive.

Member Data Documentation

bool vtkCompositeDataProbeFilter::PassPartialArrays
protected

Definition at line 93 of file vtkCompositeDataProbeFilter.h.


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