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

Passes a subset of arrays to the output. More...

#include <vtkPassArrays.h>

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

Public Types

typedef vtkDataObjectAlgorithm Superclass
 
- Public Types inherited from vtkDataObjectAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
typedef vtkObject Superclass
 
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkPassArraysNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void AddArray (int fieldType, const char *name)
 
virtual void AddPointDataArray (const char *name)
 
virtual void AddCellDataArray (const char *name)
 
virtual void AddFieldDataArray (const char *name)
 
virtual void RemoveArray (int fieldType, const char *name)
 
virtual void RemovePointDataArray (const char *name)
 
virtual void RemoveCellDataArray (const char *name)
 
virtual void RemoveFieldDataArray (const char *name)
 
virtual void AddFieldType (int fieldType)
 
virtual void ClearFieldTypes ()
 
virtual void ClearArrays ()
 
virtual void ClearPointDataArrays ()
 
virtual void ClearCellDataArrays ()
 
virtual void ClearFieldDataArrays ()
 
virtual void SetRemoveArrays (bool)
 
virtual bool GetRemoveArrays ()
 
virtual void RemoveArraysOn ()
 
virtual void RemoveArraysOff ()
 
virtual void SetUseFieldTypes (bool)
 
virtual bool GetUseFieldTypes ()
 
virtual void UseFieldTypesOn ()
 
virtual void UseFieldTypesOff ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Public Member Functions inherited from vtkDataObjectAlgorithm
vtkDataObjectAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkDataObjectGetOutput ()
 
vtkDataObjectGetOutput (int)
 
virtual void SetOutput (vtkDataObject *d)
 
void SetInputData (vtkDataObject *)
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 
void AddInputData (int, vtkDataObject *)
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
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)
 
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)
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
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)
 

Static Public Member Functions

static vtkPassArraysNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPassArraysSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataObjectAlgorithm
static vtkDataObjectAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDataObjectAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
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 * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkPassArrays ()
 
 ~vtkPassArrays ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
- Protected Member Functions inherited from vtkDataObjectAlgorithm
 vtkDataObjectAlgorithm ()
 
 ~vtkDataObjectAlgorithm ()
 
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- 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 vtkExecutiveCreateDefaultExecutive ()
 
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 Attributes

bool RemoveArrays
 
bool UseFieldTypes
 
Internals * Implementation
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

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 vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Passes a subset of arrays to the output.

This filter preserves all the topology of the input, but only a subset of arrays are passed to the output. Add an array to be passed to the output data object with AddArray(). If RemoveArrays is on, the specified arrays will be the ones that are removed instead of the ones that are kept.

Arrays with special attributes (scalars, pedigree ids, etc.) will retain those attributes in the output.

By default, only those field types with at least one array specified through AddArray will be processed. If instead UseFieldTypes is turned on, you explicitly set which field types to process with AddFieldType.

Example 1:

passArray->AddArray(vtkDataObject::POINT, "velocity");

The output will have only that one array "velocity" in the point data, but cell and field data will be untouched.

Example 2:

passArray->AddArray(vtkDataObject::POINT, "velocity");
passArray->UseFieldTypesOn();
passArray->AddFieldType(vtkDataObject::POINT);
passArray->AddFieldType(vtkDataObject::CELL);

The point data would still contain the single array, but the cell data would be cleared since you did not specify any arrays to pass. Field data would still be untouched.

Tests:
vtkPassArrays (Tests)

Definition at line 68 of file vtkPassArrays.h.

Member Typedef Documentation

Definition at line 72 of file vtkPassArrays.h.

Constructor & Destructor Documentation

vtkPassArrays::vtkPassArrays ( )
protected
vtkPassArrays::~vtkPassArrays ( )
protected

Member Function Documentation

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

vtkPassArrays* vtkPassArrays::NewInstance ( ) const
void vtkPassArrays::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkPassArrays::AddArray ( int  fieldType,
const char *  name 
)
virtual

Adds an array to pass through. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration.

virtual void vtkPassArrays::AddPointDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::AddCellDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::AddFieldDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::RemoveArray ( int  fieldType,
const char *  name 
)
virtual
virtual void vtkPassArrays::RemovePointDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::RemoveCellDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::RemoveFieldDataArray ( const char *  name)
virtual
virtual void vtkPassArrays::ClearArrays ( )
virtual

Clear all arrays to pass through.

virtual void vtkPassArrays::ClearPointDataArrays ( )
virtual

Clear all arrays to pass through.

virtual void vtkPassArrays::ClearCellDataArrays ( )
virtual

Clear all arrays to pass through.

virtual void vtkPassArrays::ClearFieldDataArrays ( )
virtual

Clear all arrays to pass through.

virtual void vtkPassArrays::SetRemoveArrays ( bool  )
virtual

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual bool vtkPassArrays::GetRemoveArrays ( )
virtual

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual void vtkPassArrays::RemoveArraysOn ( )
virtual

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual void vtkPassArrays::RemoveArraysOff ( )
virtual

Instead of passing only the specified arrays, remove the specified arrays and keep all other arrays. Default is off.

virtual void vtkPassArrays::SetUseFieldTypes ( bool  )
virtual

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual bool vtkPassArrays::GetUseFieldTypes ( )
virtual

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual void vtkPassArrays::UseFieldTypesOn ( )
virtual

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual void vtkPassArrays::UseFieldTypesOff ( )
virtual

Process only those field types explicitly specified with AddFieldType. Otherwise, processes field types associated with at least one specified array. Default is off.

virtual void vtkPassArrays::AddFieldType ( int  fieldType)
virtual

Add a field type to process. fieldType where the array that should be passed (point data, cell data, etc.). It should be one of the constants defined in the vtkDataObject::AttributeTypes enumeration. NOTE: These are only used if UseFieldType is turned on.

virtual void vtkPassArrays::ClearFieldTypes ( )
virtual

Clear all field types to process.

virtual int vtkPassArrays::ProcessRequest ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
virtual

This is required to capture REQUEST_DATA_OBJECT requests.

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkPassArrays::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Creates the same output type as the input type.

Reimplemented from vtkDataObjectAlgorithm.

int vtkPassArrays::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkDataObjectAlgorithm.

Member Data Documentation

bool vtkPassArrays::RemoveArrays
protected

Definition at line 147 of file vtkPassArrays.h.

bool vtkPassArrays::UseFieldTypes
protected

Definition at line 148 of file vtkPassArrays.h.

Internals* vtkPassArrays::Implementation
protected

Definition at line 151 of file vtkPassArrays.h.


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