VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
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]

List of all members.

Public Types

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

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 ()
- Public Member Functions inherited from vtkProbeFilter
void SetSourceConnection (vtkAlgorithmOutput *algOutput)
void SetSource (vtkDataObject *source)
vtkDataObjectGetSource ()
virtual void SetSpatialMatch (int)
virtual int GetSpatialMatch ()
virtual void SpatialMatchOn ()
virtual void SpatialMatchOff ()
virtual vtkIdTypeArrayGetValidPoints ()
virtual void SetValidPointMaskArrayName (const char *)
virtual char * GetValidPointMaskArrayName ()
- Public Member Functions inherited from vtkDataSetAlgorithm
vtkDataObjectGetInput ()
vtkPolyDataGetPolyDataOutput ()
vtkStructuredPointsGetStructuredPointsOutput ()
vtkImageDataGetImageDataOutput ()
vtkStructuredGridGetStructuredGridOutput ()
vtkUnstructuredGridGetUnstructuredGridOutput ()
vtkRectilinearGridGetRectilinearGridOutput ()
vtkDataSetGetOutput ()
vtkDataSetGetOutput (int)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void SetInput (vtkDataSet *)
void SetInput (int, vtkDataSet *)
void AddInput (vtkDataObject *)
void AddInput (vtkDataSet *)
void AddInput (int, vtkDataSet *)
void AddInput (int, vtkDataObject *)
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkDataObjectGetInputDataObject (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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

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 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 Member Functions inherited from vtkDataSetAlgorithm
 vtkDataSetAlgorithm ()
 ~vtkDataSetAlgorithm ()
virtual int FillOutputPortInformation (int port, vtkInformation *info)
vtkDataObjectGetInput (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 void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

bool PassPartialArrays
- Protected Attributes inherited from vtkProbeFilter
int SpatialMatch
char * ValidPointMaskArrayName
vtkIdTypeArrayValidPoints
vtkCharArrayMaskPoints
int NumberOfValidPoints
bool UseNullPoint
vtkDataSetAttributes::FieldListCellList
vtkDataSetAttributes::FieldListPointList

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.


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

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

Reimplemented from vtkAlgorithm.


Member Data Documentation

bool vtkCompositeDataProbeFilter::PassPartialArrays
protected

Definition at line 92 of file vtkCompositeDataProbeFilter.h.


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